public class GPUdb extends GPUdbBase
GPUdb
instances are thread safe and may be used from any number of threads
simultaneously.GPUdbBase.Options, GPUdbBase.SubmitException
END_OF_SET
Constructor and Description |
---|
GPUdb(String url)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using default options. |
GPUdb(String url,
GPUdbBase.Options options)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using the specified options. |
GPUdb(URL url)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using default options. |
GPUdb(URL url,
GPUdbBase.Options options)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using the specified options. |
Modifier and Type | Method and Description |
---|---|
AdminDeleteNodeResponse |
adminDeleteNode(AdminDeleteNodeRequest request) |
AdminDeleteNodeResponse |
adminDeleteNode(int rank,
String authorization,
Map<String,String> options) |
AdminGetShardAssignmentsResponse |
adminGetShardAssignments(AdminGetShardAssignmentsRequest request) |
AdminGetShardAssignmentsResponse |
adminGetShardAssignments(Map<String,String> options) |
AdminOfflineResponse |
adminOffline(AdminOfflineRequest request)
Take the system offline.
|
AdminOfflineResponse |
adminOffline(boolean offline,
Map<String,String> options)
Take the system offline.
|
AdminRebalanceResponse |
adminRebalance(AdminRebalanceRequest request) |
AdminRebalanceResponse |
adminRebalance(List<String> tableNames,
Map<String,String> options) |
AdminSetShardAssignmentsResponse |
adminSetShardAssignments(AdminSetShardAssignmentsRequest request) |
AdminSetShardAssignmentsResponse |
adminSetShardAssignments(long version,
boolean partialReassignment,
List<Integer> shardAssignmentsRank,
List<Integer> shardAssignmentsTom,
List<Integer> assignmentIndex,
Map<String,String> options) |
AdminShutdownResponse |
adminShutdown(AdminShutdownRequest request)
Exits the GPUdb server application.
|
AdminShutdownResponse |
adminShutdown(String exitType,
String authorization,
Map<String,String> options)
Exits the GPUdb server application.
|
AdminVerifyDbResponse |
adminVerifyDb(AdminVerifyDbRequest request)
Verify database is in a consistent state.
|
AdminVerifyDbResponse |
adminVerifyDb(Map<String,String> options)
Verify database is in a consistent state.
|
AggregateConvexHullResponse |
aggregateConvexHull(AggregateConvexHullRequest request)
Calculates and returns the convex hull for the values in a table specified by
tableName . |
AggregateConvexHullResponse |
aggregateConvexHull(String tableName,
String xColumnName,
String yColumnName,
Map<String,String> options)
Calculates and returns the convex hull for the values in a table specified by
tableName . |
AggregateGroupByResponse |
aggregateGroupBy(AggregateGroupByRequest request)
Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes
aggregates on each unique combination.
|
AggregateGroupByResponse |
aggregateGroupBy(String tableName,
List<String> columnNames,
long offset,
long limit,
Map<String,String> options)
Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes
aggregates on each unique combination.
|
RawAggregateGroupByResponse |
aggregateGroupByRaw(AggregateGroupByRequest request)
Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes
aggregates on each unique combination.
|
AggregateHistogramResponse |
aggregateHistogram(AggregateHistogramRequest request)
Performs a histogram calculation given a table, a column, and an interval function.
|
AggregateHistogramResponse |
aggregateHistogram(String tableName,
String columnName,
double start,
double end,
double interval,
Map<String,String> options)
Performs a histogram calculation given a table, a column, and an interval function.
|
AggregateKMeansResponse |
aggregateKMeans(AggregateKMeansRequest request)
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
|
AggregateKMeansResponse |
aggregateKMeans(String tableName,
List<String> columnNames,
int k,
double tolerance,
Map<String,String> options)
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
|
AggregateMinMaxResponse |
aggregateMinMax(AggregateMinMaxRequest request)
Calculates and returns the minimum and maximum values of a particular column in a table.
|
AggregateMinMaxResponse |
aggregateMinMax(String tableName,
String columnName,
Map<String,String> options)
Calculates and returns the minimum and maximum values of a particular column in a table.
|
AggregateStatisticsResponse |
aggregateStatistics(AggregateStatisticsRequest request)
Calculates the requested statistics of a given column in a given table.
|
AggregateStatisticsResponse |
aggregateStatistics(String tableName,
String columnName,
String stats,
Map<String,String> options)
Calculates the requested statistics of a given column in a given table.
|
AggregateStatisticsByRangeResponse |
aggregateStatisticsByRange(AggregateStatisticsByRangeRequest request)
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
|
AggregateStatisticsByRangeResponse |
aggregateStatisticsByRange(String tableName,
String selectExpression,
String columnName,
String valueColumnName,
String stats,
double start,
double end,
double interval,
Map<String,String> options)
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
|
AggregateUniqueResponse |
aggregateUnique(AggregateUniqueRequest request)
Returns all the unique values from a particular column (specified by
columnName ) of a particular table (specified by
tableName ). |
AggregateUniqueResponse |
aggregateUnique(String tableName,
String columnName,
long offset,
long limit,
Map<String,String> options)
Returns all the unique values from a particular column (specified by
columnName ) of a particular table (specified by
tableName ). |
RawAggregateUniqueResponse |
aggregateUniqueRaw(AggregateUniqueRequest request)
Returns all the unique values from a particular column (specified by
columnName ) of a particular table (specified by
tableName ). |
AlterSystemPropertiesResponse |
alterSystemProperties(AlterSystemPropertiesRequest request)
The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during
normal execution.
|
AlterSystemPropertiesResponse |
alterSystemProperties(Map<String,String> propertyUpdatesMap,
Map<String,String> options)
The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during
normal execution.
|
AlterTableResponse |
alterTable(AlterTableRequest request)
Apply various modifications to a table or collection.
|
AlterTableResponse |
alterTable(String tableName,
String action,
String value,
Map<String,String> options)
Apply various modifications to a table or collection.
|
AlterTableMetadataResponse |
alterTableMetadata(AlterTableMetadataRequest request)
Updates (adds or changes) metadata for tables.
|
AlterTableMetadataResponse |
alterTableMetadata(List<String> tableNames,
Map<String,String> metadataMap,
Map<String,String> options)
Updates (adds or changes) metadata for tables.
|
AlterUserResponse |
alterUser(AlterUserRequest request)
Alters a user.
|
AlterUserResponse |
alterUser(String name,
String action,
String value,
Map<String,String> options)
Alters a user.
|
ClearTableResponse |
clearTable(ClearTableRequest request)
Clears (drops) one or all tables in the GPUdb cluster.
|
ClearTableResponse |
clearTable(String tableName,
String authorization,
Map<String,String> options)
Clears (drops) one or all tables in the GPUdb cluster.
|
ClearTableMonitorResponse |
clearTableMonitor(ClearTableMonitorRequest request)
Deactivates a table monitor previously created with
createTableMonitor(CreateTableMonitorRequest) . |
ClearTableMonitorResponse |
clearTableMonitor(String topicId,
Map<String,String> options)
Deactivates a table monitor previously created with
createTableMonitor(String, Map) . |
ClearTriggerResponse |
clearTrigger(ClearTriggerRequest request)
Clears or cancels the trigger identified by the specified handle.
|
ClearTriggerResponse |
clearTrigger(String triggerId,
Map<String,String> options)
Clears or cancels the trigger identified by the specified handle.
|
CreateJoinTableResponse |
createJoinTable(CreateJoinTableRequest request)
Creates a table that is the result of a SQL JOIN.
|
CreateJoinTableResponse |
createJoinTable(String joinTableName,
List<String> tableNames,
List<String> aliases,
String expression,
List<String> expressions,
Map<String,String> options)
Creates a table that is the result of a SQL JOIN.
|
CreateRoleResponse |
createRole(CreateRoleRequest request)
Creates a new role.
|
CreateRoleResponse |
createRole(String name,
Map<String,String> options)
Creates a new role.
|
CreateTableResponse |
createTable(CreateTableRequest request)
Creates a new table or collection in GPUdb.
|
CreateTableResponse |
createTable(String tableName,
String typeId,
Map<String,String> options)
Creates a new table or collection in GPUdb.
|
CreateTableMonitorResponse |
createTableMonitor(CreateTableMonitorRequest request)
Creates a monitor that watches for new records inserted into a particular table (identified by
tableName ) and
forwards copies to subscribers via ZMQ. |
CreateTableMonitorResponse |
createTableMonitor(String tableName,
Map<String,String> options)
Creates a monitor that watches for new records inserted into a particular table (identified by
tableName ) and
forwards copies to subscribers via ZMQ. |
CreateTriggerByAreaResponse |
createTriggerByArea(CreateTriggerByAreaRequest request)
Sets up an area trigger mechanism for two column_names for one or more tables.
|
CreateTriggerByAreaResponse |
createTriggerByArea(String requestId,
List<String> tableNames,
String xColumnName,
List<Double> xVector,
String yColumnName,
List<Double> yVector,
Map<String,String> options)
Sets up an area trigger mechanism for two column_names for one or more tables.
|
CreateTriggerByRangeResponse |
createTriggerByRange(CreateTriggerByRangeRequest request)
Sets up a simple range trigger for a column_name for one or more tables.
|
CreateTriggerByRangeResponse |
createTriggerByRange(String requestId,
List<String> tableNames,
String columnName,
double min,
double max,
Map<String,String> options)
Sets up a simple range trigger for a column_name for one or more tables.
|
CreateTypeResponse |
createType(CreateTypeRequest request)
Creates a new type in GPUdb describing the layout or schema of a table.
|
CreateTypeResponse |
createType(String typeDefinition,
String label,
Map<String,List<String>> properties,
Map<String,String> options)
Creates a new type in GPUdb describing the layout or schema of a table.
|
CreateUnionResponse |
createUnion(CreateUnionRequest request)
Creates a table that is the concatenation of one or more existing tables.
|
CreateUnionResponse |
createUnion(String tableName,
List<String> tableNames,
List<List<String>> inputColumnNames,
List<String> outputColumnNames,
Map<String,String> options)
Creates a table that is the concatenation of one or more existing tables.
|
CreateUserExternalResponse |
createUserExternal(CreateUserExternalRequest request)
Creates a new external user (a user whose credentials are managed by an external LDAP).
|
CreateUserExternalResponse |
createUserExternal(String name,
Map<String,String> options)
Creates a new external user (a user whose credentials are managed by an external LDAP).
|
CreateUserInternalResponse |
createUserInternal(CreateUserInternalRequest request)
Creates a new internal user (a user whose credentials are managed by GPUdb).
|
CreateUserInternalResponse |
createUserInternal(String name,
String password,
Map<String,String> options)
Creates a new internal user (a user whose credentials are managed by GPUdb).
|
DeleteRecordsResponse |
deleteRecords(DeleteRecordsRequest request)
Deletes record(s) matching the provided criteria from the given table.
|
DeleteRecordsResponse |
deleteRecords(String tableName,
List<String> expressions,
Map<String,String> options)
Deletes record(s) matching the provided criteria from the given table.
|
DeleteRoleResponse |
deleteRole(DeleteRoleRequest request)
Deletes an existing role.
|
DeleteRoleResponse |
deleteRole(String name,
Map<String,String> options)
Deletes an existing role.
|
DeleteUserResponse |
deleteUser(DeleteUserRequest request)
Deletes an existing user.
|
DeleteUserResponse |
deleteUser(String name,
Map<String,String> options)
Deletes an existing user.
|
ExecuteProcResponse |
executeProc(ExecuteProcRequest request)
Executes a proc in the GPUdb Node.js proc server.
|
ExecuteProcResponse |
executeProc(String name,
Map<String,String> params,
Map<String,ByteBuffer> binParams,
Map<String,String> options)
Executes a proc in the GPUdb Node.js proc server.
|
FilterResponse |
filter(FilterRequest request)
Filters data based on the specified expression.
|
FilterResponse |
filter(String tableName,
String viewName,
String expression,
Map<String,String> options)
Filters data based on the specified expression.
|
FilterByAreaResponse |
filterByArea(FilterByAreaRequest request)
Calculates which objects from a table are within a named area of interest (NAI/polygon).
|
FilterByAreaResponse |
filterByArea(String tableName,
String viewName,
String xColumnName,
List<Double> xVector,
String yColumnName,
List<Double> yVector,
Map<String,String> options)
Calculates which objects from a table are within a named area of interest (NAI/polygon).
|
FilterByBoxResponse |
filterByBox(FilterByBoxRequest request)
Calculates how many objects within the given table lie in a rectangular box.
|
FilterByBoxResponse |
filterByBox(String tableName,
String viewName,
String xColumnName,
double minX,
double maxX,
String yColumnName,
double minY,
double maxY,
Map<String,String> options)
Calculates how many objects within the given table lie in a rectangular box.
|
FilterByGeometryResponse |
filterByGeometry(FilterByGeometryRequest request)
Applies a geometry filter against a spatial column named WKT in a given table, collection or view.
|
FilterByGeometryResponse |
filterByGeometry(String tableName,
String viewName,
String columnName,
String inputWkt,
String operation,
Map<String,String> options)
Applies a geometry filter against a spatial column named WKT in a given table, collection or view.
|
FilterByListResponse |
filterByList(FilterByListRequest request)
Calculates which records from a table have values in the given list for the corresponding column.
|
FilterByListResponse |
filterByList(String tableName,
String viewName,
Map<String,List<String>> columnValuesMap,
Map<String,String> options)
Calculates which records from a table have values in the given list for the corresponding column.
|
FilterByRadiusResponse |
filterByRadius(FilterByRadiusRequest request)
Calculates which objects from a table lie within a circle with the given radius and center point (i.e.
|
FilterByRadiusResponse |
filterByRadius(String tableName,
String viewName,
String xColumnName,
double xCenter,
String yColumnName,
double yCenter,
double radius,
Map<String,String> options)
Calculates which objects from a table lie within a circle with the given radius and center point (i.e.
|
FilterByRangeResponse |
filterByRange(FilterByRangeRequest request)
Calculates which objects from a table have a column that is within the given bounds.
|
FilterByRangeResponse |
filterByRange(String tableName,
String viewName,
String columnName,
double lowerBound,
double upperBound,
Map<String,String> options)
Calculates which objects from a table have a column that is within the given bounds.
|
FilterBySeriesResponse |
filterBySeries(FilterBySeriesRequest request)
Filters objects matching all points of the given track (works only on track type data).
|
FilterBySeriesResponse |
filterBySeries(String tableName,
String viewName,
String trackId,
List<String> targetTrackIds,
Map<String,String> options)
Filters objects matching all points of the given track (works only on track type data).
|
FilterByStringResponse |
filterByString(FilterByStringRequest request)
Calculates which objects from a table, collection, or view match a string expression for the given string columns.
|
FilterByStringResponse |
filterByString(String tableName,
String viewName,
String expression,
String mode,
List<String> columnNames,
Map<String,String> options)
Calculates which objects from a table, collection, or view match a string expression for the given string columns.
|
FilterByTableResponse |
filterByTable(FilterByTableRequest request)
Filters objects in one table based on objects in another table.
|
FilterByTableResponse |
filterByTable(String tableName,
String viewName,
String columnName,
String sourceTableName,
String sourceTableColumnName,
Map<String,String> options)
Filters objects in one table based on objects in another table.
|
FilterByValueResponse |
filterByValue(FilterByValueRequest request)
Calculates which objects from a table has a particular value for a particular column.
|
FilterByValueResponse |
filterByValue(String tableName,
String viewName,
boolean isString,
double value,
String valueStr,
String columnName,
Map<String,String> options)
Calculates which objects from a table has a particular value for a particular column.
|
<TResponse> |
getRecords(GetRecordsRequest request)
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
|
<TResponse> |
getRecords(Object typeDescriptor,
GetRecordsRequest request)
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
|
<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> |
getRecords(String tableName,
long offset,
long limit,
Map<String,String> options)
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
|
GetRecordsByColumnResponse |
getRecordsByColumn(GetRecordsByColumnRequest request)
For a given table, retrieves the values of the given columns within a given range.
|
GetRecordsByColumnResponse |
getRecordsByColumn(String tableName,
List<String> columnNames,
long offset,
long limit,
Map<String,String> options)
For a given table, retrieves the values of the given columns within a given range.
|
RawGetRecordsByColumnResponse |
getRecordsByColumnRaw(GetRecordsByColumnRequest request)
For a given table, retrieves the values of the given columns within a given range.
|
<TResponse> |
getRecordsBySeries(GetRecordsBySeriesRequest request)
Retrieves the complete series/track records from the given
worldTableName based on the partial track information
contained in the tableName . |
<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> |
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> |
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> |
getRecordsFromCollection(GetRecordsFromCollectionRequest request)
Retrieves records from a collection.
|
<TResponse> |
getRecordsFromCollection(Object typeDescriptor,
GetRecordsFromCollectionRequest request)
Retrieves records from a collection.
|
<TResponse> |
getRecordsFromCollection(Object typeDescriptor,
String tableName,
long offset,
long limit,
Map<String,String> options)
Retrieves records from a collection.
|
<TResponse> |
getRecordsFromCollection(String tableName,
long offset,
long limit,
Map<String,String> options)
Retrieves records from a collection.
|
RawGetRecordsFromCollectionResponse |
getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest request)
Retrieves records from a collection.
|
RawGetRecordsResponse |
getRecordsRaw(GetRecordsRequest request)
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
|
GrantPermissionSystemResponse |
grantPermissionSystem(GrantPermissionSystemRequest request)
Grants a system-level permission to a user or role.
|
GrantPermissionSystemResponse |
grantPermissionSystem(String name,
String permission,
Map<String,String> options)
Grants a system-level permission to a user or role.
|
GrantPermissionTableResponse |
grantPermissionTable(GrantPermissionTableRequest request)
Grants a table-level permission to a user or role.
|
GrantPermissionTableResponse |
grantPermissionTable(String name,
String permission,
String tableName,
String filterExpression,
Map<String,String> options)
Grants a table-level permission to a user or role.
|
GrantRoleResponse |
grantRole(GrantRoleRequest request)
Grants membership in a role to a user or role.
|
GrantRoleResponse |
grantRole(String role,
String member,
Map<String,String> options)
Grants membership in a role to a user or role.
|
HasTableResponse |
hasTable(HasTableRequest request)
Checks the existence of a table with the given name in GPUdb.
|
HasTableResponse |
hasTable(String tableName,
Map<String,String> options)
Checks the existence of a table with the given name in GPUdb.
|
HasTypeResponse |
hasType(HasTypeRequest request)
Check the existence of a type in GPUdb.
|
HasTypeResponse |
hasType(String typeId,
Map<String,String> options)
Check the existence of a type in GPUdb.
|
<TRequest> InsertRecordsResponse |
insertRecords(InsertRecordsRequest<TRequest> request)
Adds multiple records to the specified table.
|
<TRequest> InsertRecordsResponse |
insertRecords(String tableName,
List<TRequest> data,
Map<String,String> options)
Adds multiple records to the specified table.
|
<TRequest> InsertRecordsResponse |
insertRecords(TypeObjectMap<TRequest> typeObjectMap,
InsertRecordsRequest<TRequest> request)
Adds multiple records to the specified table.
|
<TRequest> InsertRecordsResponse |
insertRecords(TypeObjectMap<TRequest> typeObjectMap,
String tableName,
List<TRequest> data,
Map<String,String> options)
Adds multiple records to the specified table.
|
InsertRecordsRandomResponse |
insertRecordsRandom(InsertRecordsRandomRequest request)
Generates a specified number of random records and adds them to the given table.
|
InsertRecordsRandomResponse |
insertRecordsRandom(String tableName,
long count,
Map<String,Map<String,Double>> options)
Generates a specified number of random records and adds them to the given table.
|
InsertRecordsResponse |
insertRecordsRaw(RawInsertRecordsRequest request)
Adds multiple records to the specified table.
|
InsertSymbolResponse |
insertSymbol(InsertSymbolRequest request)
Adds a symbol or icon (i.e.
|
InsertSymbolResponse |
insertSymbol(String symbolId,
String symbolFormat,
ByteBuffer symbolData,
Map<String,String> options)
Adds a symbol or icon (i.e.
|
LockTableResponse |
lockTable(LockTableRequest request)
Manages global access to a table's data.
|
LockTableResponse |
lockTable(String tableName,
String lockType,
Map<String,String> options)
Manages global access to a table's data.
|
RevokePermissionSystemResponse |
revokePermissionSystem(RevokePermissionSystemRequest request)
Revokes a system-level permission from a user or role.
|
RevokePermissionSystemResponse |
revokePermissionSystem(String name,
String permission,
Map<String,String> options)
Revokes a system-level permission from a user or role.
|
RevokePermissionTableResponse |
revokePermissionTable(RevokePermissionTableRequest request)
Revokes a table-level permission from a user or role.
|
RevokePermissionTableResponse |
revokePermissionTable(String name,
String permission,
String tableName,
Map<String,String> options)
Revokes a table-level permission from a user or role.
|
RevokeRoleResponse |
revokeRole(RevokeRoleRequest request)
Revokes membership in a role from a user or role.
|
RevokeRoleResponse |
revokeRole(String role,
String member,
Map<String,String> options)
Revokes membership in a role from a user or role.
|
ShowSecurityResponse |
showSecurity(List<String> names,
Map<String,String> options)
Shows security information relating to users and/or roles.
|
ShowSecurityResponse |
showSecurity(ShowSecurityRequest request)
Shows security information relating to users and/or roles.
|
ShowSystemPropertiesResponse |
showSystemProperties(Map<String,String> options)
Returns server configuration and version related information to the caller.
|
ShowSystemPropertiesResponse |
showSystemProperties(ShowSystemPropertiesRequest request)
Returns server configuration and version related information to the caller.
|
ShowSystemStatusResponse |
showSystemStatus(Map<String,String> options)
Provides server configuration and health related status to the caller.
|
ShowSystemStatusResponse |
showSystemStatus(ShowSystemStatusRequest request)
Provides server configuration and health related status to the caller.
|
ShowSystemTimingResponse |
showSystemTiming(Map<String,String> options)
Returns the last 100 requests made to GPUdb along with the request timing and internal job id.
|
ShowSystemTimingResponse |
showSystemTiming(ShowSystemTimingRequest request)
Returns the last 100 requests made to GPUdb along with the request timing and internal job id.
|
ShowTableResponse |
showTable(ShowTableRequest request)
Retrieves detailed information about a particular GPUdb table, specified in
tableName . |
ShowTableResponse |
showTable(String tableName,
Map<String,String> options)
Retrieves detailed information about a particular GPUdb table, specified in
tableName . |
ShowTableMetadataResponse |
showTableMetadata(List<String> tableNames,
Map<String,String> options)
Retrieves the user provided metadata for the specified tables.
|
ShowTableMetadataResponse |
showTableMetadata(ShowTableMetadataRequest request)
Retrieves the user provided metadata for the specified tables.
|
ShowTablesByTypeResponse |
showTablesByType(ShowTablesByTypeRequest request)
Gets names of the tables from GPUdb based on the type information.
|
ShowTablesByTypeResponse |
showTablesByType(String typeId,
String label,
Map<String,String> options)
Gets names of the tables from GPUdb based on the type information.
|
ShowTriggersResponse |
showTriggers(List<String> triggerIds,
Map<String,String> options)
Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.
|
ShowTriggersResponse |
showTriggers(ShowTriggersRequest request)
Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.
|
ShowTypesResponse |
showTypes(ShowTypesRequest request)
Retrieves information for the specified data type.
|
ShowTypesResponse |
showTypes(String typeId,
String label,
Map<String,String> options)
Retrieves information for the specified data type.
|
<TRequest> UpdateRecordsResponse |
updateRecords(String tableName,
List<String> expressions,
List<Map<String,String>> newValuesMaps,
List<TRequest> data,
Map<String,String> options)
Runs multiple predicate-based updates in a single call.
|
<TRequest> UpdateRecordsResponse |
updateRecords(TypeObjectMap<TRequest> typeObjectMap,
String tableName,
List<String> expressions,
List<Map<String,String>> newValuesMaps,
List<TRequest> data,
Map<String,String> options)
Runs multiple predicate-based updates in a single call.
|
<TRequest> UpdateRecordsResponse |
updateRecords(TypeObjectMap<TRequest> typeObjectMap,
UpdateRecordsRequest<TRequest> request)
Runs multiple predicate-based updates in a single call.
|
<TRequest> UpdateRecordsResponse |
updateRecords(UpdateRecordsRequest<TRequest> request)
Runs multiple predicate-based updates in a single call.
|
UpdateRecordsBySeriesResponse |
updateRecordsBySeries(String tableName,
String worldTableName,
String viewName,
List<String> reserved,
Map<String,String> options)
Updates the view specified by
tableName to include full series (track) information from the worldTableName
for the series (tracks) present in the viewName . |
UpdateRecordsBySeriesResponse |
updateRecordsBySeries(UpdateRecordsBySeriesRequest request)
Updates the view specified by
tableName to include full series (track) information from the worldTableName
for the series (tracks) present in the viewName . |
UpdateRecordsResponse |
updateRecordsRaw(RawUpdateRecordsRequest request)
Runs multiple predicate-based updates in a single call.
|
VisualizeImageResponse |
visualizeImage(List<String> tableNames,
List<String> worldTableNames,
String xColumnName,
String yColumnName,
List<List<String>> trackIds,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
long bgColor,
Map<String,List<String>> styleOptions,
Map<String,String> options) |
VisualizeImageResponse |
visualizeImage(VisualizeImageRequest request) |
VisualizeImageClassbreakResponse |
visualizeImageClassbreak(List<String> tableNames,
List<String> worldTableNames,
String xColumnName,
String yColumnName,
List<List<String>> trackIds,
String cbColumnName1,
List<String> cbVals1,
List<String> cbColumnName2,
List<List<String>> cbVals2,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
long bgColor,
Map<String,List<String>> styleOptions,
Map<String,String> options) |
VisualizeImageClassbreakResponse |
visualizeImageClassbreak(VisualizeImageClassbreakRequest request) |
VisualizeImageHeatmapResponse |
visualizeImageHeatmap(List<String> tableNames,
String xColumnName,
String yColumnName,
String valueColumnName,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
Map<String,String> styleOptions,
Map<String,String> options) |
VisualizeImageHeatmapResponse |
visualizeImageHeatmap(VisualizeImageHeatmapRequest request) |
VisualizeImageLabelsResponse |
visualizeImageLabels(String tableName,
String xColumnName,
String yColumnName,
String xOffset,
String yOffset,
String textString,
String font,
String textColor,
String textAngle,
String textScale,
String drawBox,
String drawLeader,
String lineWidth,
String lineColor,
String fillColor,
String leaderXColumnName,
String leaderYColumnName,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
Map<String,String> options) |
VisualizeImageLabelsResponse |
visualizeImageLabels(VisualizeImageLabelsRequest request) |
VisualizeVideoResponse |
visualizeVideo(List<String> tableNames,
List<String> worldTableNames,
List<List<String>> trackIds,
String xColumnName,
String yColumnName,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
long bgColor,
List<List<Double>> timeIntervals,
String videoStyle,
String sessionKey,
Map<String,List<String>> styleOptions,
Map<String,String> options)
Creates raster images of data in the given table based on provided input parameters.
|
VisualizeVideoResponse |
visualizeVideo(VisualizeVideoRequest request)
Creates raster images of data in the given table based on provided input parameters.
|
VisualizeVideoHeatmapResponse |
visualizeVideoHeatmap(List<String> tableNames,
String xColumnName,
String yColumnName,
double minX,
double maxX,
double minY,
double maxY,
List<List<Double>> timeIntervals,
int width,
int height,
String projection,
String videoStyle,
String sessionKey,
Map<String,String> styleOptions,
Map<String,String> options) |
VisualizeVideoHeatmapResponse |
visualizeVideoHeatmap(VisualizeVideoHeatmapRequest request) |
addKnownType, addKnownType, addKnownTypeFromTable, addKnownTypeFromTable, addKnownTypeObjectMap, decode, decode, decode, decodeMultiple, decodeMultiple, encode, encode, getApiVersion, getExecutor, getHttpHeaders, getPassword, getThreadCount, getTimeout, getTypeDescriptor, getTypeObjectMap, getURL, getUsername, getUseSnappy, list, options, ping, setTypeDescriptorIfMissing, submitRequest, submitRequest, submitRequest
public GPUdb(String url) throws GPUdbException
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.url
- The URL of the GPUdb server.GPUdbException
- if an error occurs during creation.public GPUdb(URL url) throws GPUdbException
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.url
- The URL of the GPUdb server.GPUdbException
- if an error occurs during creation.public GPUdb(String url, GPUdbBase.Options options) throws GPUdbException
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.url
- The URL of the GPUdb server.options
- The options to use.GPUdbException
- if an error occurs during creation.public GPUdb(URL url, GPUdbBase.Options options) throws GPUdbException
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.url
- The URL of the GPUdb server.options
- The options to use.GPUdbException
- if an error occurs during creation.public AdminDeleteNodeResponse adminDeleteNode(AdminDeleteNodeRequest request) throws GPUdbException
GPUdbException
public AdminDeleteNodeResponse adminDeleteNode(int rank, String authorization, Map<String,String> options) throws GPUdbException
GPUdbException
public AdminGetShardAssignmentsResponse adminGetShardAssignments(AdminGetShardAssignmentsRequest request) throws GPUdbException
GPUdbException
public AdminGetShardAssignmentsResponse adminGetShardAssignments(Map<String,String> options) throws GPUdbException
GPUdbException
public AdminOfflineResponse adminOffline(AdminOfflineRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AdminOfflineResponse
public AdminOfflineResponse adminOffline(boolean offline, Map<String,String> options) throws GPUdbException
offline
- Set to true if desired state is offline. Values: true, false.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AdminOfflineResponse
public AdminRebalanceResponse adminRebalance(AdminRebalanceRequest request) throws GPUdbException
GPUdbException
public AdminRebalanceResponse adminRebalance(List<String> tableNames, Map<String,String> options) throws GPUdbException
GPUdbException
public AdminSetShardAssignmentsResponse adminSetShardAssignments(AdminSetShardAssignmentsRequest request) throws GPUdbException
GPUdbException
public AdminSetShardAssignmentsResponse adminSetShardAssignments(long version, boolean partialReassignment, List<Integer> shardAssignmentsRank, List<Integer> shardAssignmentsTom, List<Integer> assignmentIndex, Map<String,String> options) throws GPUdbException
GPUdbException
public AdminShutdownResponse adminShutdown(AdminShutdownRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AdminShutdownResponse
public AdminShutdownResponse adminShutdown(String exitType, String authorization, Map<String,String> options) throws GPUdbException
exitType
- Reserved for future use. User can pass an empty string.authorization
- No longer used. User can pass an empty string.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AdminShutdownResponse
public AdminVerifyDbResponse adminVerifyDb(AdminVerifyDbRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AdminVerifyDbResponse
public AdminVerifyDbResponse adminVerifyDb(Map<String,String> options) throws GPUdbException
options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AdminVerifyDbResponse
public AggregateConvexHullResponse aggregateConvexHull(AggregateConvexHullRequest request) throws GPUdbException
tableName
.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateConvexHullResponse
public AggregateConvexHullResponse aggregateConvexHull(String tableName, String xColumnName, String yColumnName, Map<String,String> options) throws GPUdbException
tableName
.tableName
- Name of Table on which the operation will be performed. Must be a valid table in GPUdb. It can not be a
collection.xColumnName
- Name of the column containing the x coordinates of the points for the operation being performed.yColumnName
- Name of the column containing the y coordinates of the points for the operation being performed.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AggregateConvexHullResponse
public RawAggregateGroupByResponse aggregateGroupByRaw(AggregateGroupByRequest request) throws GPUdbException
offset
and limit
parameters. For example, to get 10 groups with the largest counts the inputs would be:
limit=10, options={"sort_order":"descending", "sort_by":"value"}. options
can be used to customize behavior of this
call e.g. filtering or sorting the results. To group by 'x' and 'y' and compute the number of objects within each group, use
column_names=['x','y','count(*)']. To also compute the sum of 'z' over each group, use
column_names=['x','y','count(*)','sum(z)']. Available aggregation functions are: 'count(*)', 'sum', 'min', 'max', 'avg',
'mean', 'stddev', 'stddev_pop', 'stddev_samp', 'var', 'var_pop', 'var_samp', 'arg_min', 'arg_max' and 'count_distinct'. The
response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a
table with the name given in the option and the results are not returned in the response.
The Raw version of this method can be used to specify the encoding scheme of the response.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RawAggregateGroupByResponse
public AggregateGroupByResponse aggregateGroupBy(AggregateGroupByRequest request) throws GPUdbException
offset
and limit
parameters. For example, to get 10 groups with the largest counts the inputs would be:
limit=10, options={"sort_order":"descending", "sort_by":"value"}. options
can be used to customize behavior of this
call e.g. filtering or sorting the results. To group by 'x' and 'y' and compute the number of objects within each group, use
column_names=['x','y','count(*)']. To also compute the sum of 'z' over each group, use
column_names=['x','y','count(*)','sum(z)']. Available aggregation functions are: 'count(*)', 'sum', 'min', 'max', 'avg',
'mean', 'stddev', 'stddev_pop', 'stddev_samp', 'var', 'var_pop', 'var_samp', 'arg_min', 'arg_max' and 'count_distinct'. The
response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a
table with the name given in the option and the results are not returned in the response.
The Raw version of this method can be used to specify the encoding scheme of the response.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateGroupByResponse
public AggregateGroupByResponse aggregateGroupBy(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options) throws GPUdbException
offset
and limit
parameters. For example, to get 10 groups with the largest counts the inputs would be:
limit=10, options={"sort_order":"descending", "sort_by":"value"}. options
can be used to customize behavior of this
call e.g. filtering or sorting the results. To group by 'x' and 'y' and compute the number of objects within each group, use
column_names=['x','y','count(*)']. To also compute the sum of 'z' over each group, use
column_names=['x','y','count(*)','sum(z)']. Available aggregation functions are: 'count(*)', 'sum', 'min', 'max', 'avg',
'mean', 'stddev', 'stddev_pop', 'stddev_samp', 'var', 'var_pop', 'var_samp', 'arg_min', 'arg_max' and 'count_distinct'. The
response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a
table with the name given in the option and the results are not returned in the response.
The Raw version of this method can be used to specify the encoding scheme of the response.tableName
- Name of the table on which the operation will be performed. Must be a valid table/view/collection in GPUdb.columnNames
- List of one or more column names, expressions, and aggregate expressions. Must include at least one
'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.AggregateGroupByResponse
public AggregateHistogramResponse aggregateHistogram(AggregateHistogramRequest request) throws GPUdbException
interval
is used to produce
bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start
value is inclusive, but the end value is exclusive--except for the very last bin for which the end value is also inclusive.
The value returned for each bin is the number of records in it, except when a column name is provided as a *value_column* in
options
. In this latter case the sum of the values corresponding to the *value_column* is used as the result
instead.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateHistogramResponse
public AggregateHistogramResponse aggregateHistogram(String tableName, String columnName, double start, double end, double interval, Map<String,String> options) throws GPUdbException
interval
is used to produce
bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start
value is inclusive, but the end value is exclusive--except for the very last bin for which the end value is also inclusive.
The value returned for each bin is the number of records in it, except when a column name is provided as a *value_column* in
options
. In this latter case the sum of the values corresponding to the *value_column* is used as the result
instead.tableName
- Name of the table on which the operation will be performed. Must be a valid table or collection in GPUdb.columnName
- Name of a column or an expression of one or more column names over which the histogram will be calculated.start
- Lower end value of the histogram interval, inclusive.end
- Upper end value of the histogram interval, inclusive.interval
- The size of each bin within the start and end parameters.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.AggregateHistogramResponse
public AggregateKMeansResponse aggregateKMeans(AggregateKMeansRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateKMeansResponse
public AggregateKMeansResponse aggregateKMeans(String tableName, List<String> columnNames, int k, double tolerance, Map<String,String> options) throws GPUdbException
tableName
- Name of the table on which the operation will be performed. Must be a valid table or collection in GPUdb.columnNames
- List of column names on which the operation would be performed. If n columns are provided then each of
the k result points will have n dimensions corresponding to the n columns.k
- The number of mean points to be determined by the algorithm.tolerance
- Stop iterating when the distances between successive points is less than the given tolerance.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.AggregateKMeansResponse
public AggregateMinMaxResponse aggregateMinMax(AggregateMinMaxRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateMinMaxResponse
public AggregateMinMaxResponse aggregateMinMax(String tableName, String columnName, Map<String,String> options) throws GPUdbException
tableName
- Name of the table on which the operation will be performed. Must be a valid table in GPUdb.columnName
- Name of a column or an expression of one or more column on which the min-max will be calculated.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AggregateMinMaxResponse
public AggregateStatisticsResponse aggregateStatistics(AggregateStatisticsRequest request) throws GPUdbException
options
. The weighted average is
then defined as the sum of the products of columnName
times the weight attribute divided by the sum of the weight
attribute.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateStatisticsResponse
public AggregateStatisticsResponse aggregateStatistics(String tableName, String columnName, String stats, Map<String,String> options) throws GPUdbException
options
. The weighted average is
then defined as the sum of the products of columnName
times the weight attribute divided by the sum of the weight
attribute.
tableName
- Name of the table on which the statistics operation will be performed.columnName
- Name of the column for which the statistics are to be calculated.stats
- Comma separated list of the statistics to calculate, e.g. "sum,mean". Values: count, mean, stdv, variance,
skew, kurtosis, sum, min, max, weighted_average, cardinality, estimated_cardinality, percentile,
percentile_rank.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.AggregateStatisticsResponse
public AggregateStatisticsByRangeResponse aggregateStatisticsByRange(AggregateStatisticsByRangeRequest request) throws GPUdbException
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.
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.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateStatisticsByRangeResponse
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
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.
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.tableName
- Name of the table on which the ranged-statistics operation will be performed.selectExpression
- For a non-empty expression statistics are calculated for those records for which the expression is
true.columnName
- Name of the binning-column used to divide the set samples into bins.valueColumnName
- Name of the value-column for which statistics are to be computed.stats
- A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean,
stdv (standard deviation), variance, skew, kurtosis, sum.start
- The lower bound of the binning-column.end
- The upper bound of the binning-column.interval
- The interval of a bin. Set members fall into bin i if the binning-column falls in the range
[start+interval``*``i, start+interval``*``(i+1)).options
- Map of optional parameters:
GPUdbException
- if an error occurs during the operation.AggregateStatisticsByRangeResponse
public RawAggregateUniqueResponse aggregateUniqueRaw(AggregateUniqueRequest request) throws GPUdbException
columnName
) of a particular table (specified by
tableName
). If columnName
is a numeric column the values will be in binaryEncodedResponse
. Otherwise
if columnName
is a string column the values will be in jsonEncodedResponse
. offset
and limit
are used to page through the results if there are large numbers of unique values. To get the first 10 unique values sorted in
descending order options
would be::
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RawAggregateUniqueResponse
public AggregateUniqueResponse aggregateUnique(AggregateUniqueRequest request) throws GPUdbException
columnName
) of a particular table (specified by
tableName
). If columnName
is a numeric column the values will be in binaryEncodedResponse
. Otherwise
if columnName
is a string column the values will be in jsonEncodedResponse
. offset
and limit
are used to page through the results if there are large numbers of unique values. To get the first 10 unique values sorted in
descending order options
would be::
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AggregateUniqueResponse
public AggregateUniqueResponse aggregateUnique(String tableName, String columnName, long offset, long limit, Map<String,String> options) throws GPUdbException
columnName
) of a particular table (specified by
tableName
). If columnName
is a numeric column the values will be in binaryEncodedResponse
. Otherwise
if columnName
is a string column the values will be in jsonEncodedResponse
. offset
and limit
are used to page through the results if there are large numbers of unique values. To get the first 10 unique values sorted in
descending order options
would be::
tableName
- Name of the table on which the operation will be performed. Must be a valid table in GPUdb.columnName
- Name of the column or an expression containing one or more column names on which the unique function would
be applied.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.AggregateUniqueResponse
public AlterSystemPropertiesResponse alterSystemProperties(AlterSystemPropertiesRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AlterSystemPropertiesResponse
public AlterSystemPropertiesResponse alterSystemProperties(Map<String,String> propertyUpdatesMap, Map<String,String> options) throws GPUdbException
propertyUpdatesMap
- Map containing the properties of the system to be updated. Error if empty.
options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AlterSystemPropertiesResponse
public AlterTableResponse alterTable(AlterTableRequest request) throws GPUdbException
getRecordsRaw(GetRecordsRequest)
, deleteRecords(DeleteRecordsRequest)
, updateRecordsRaw(RawUpdateRecordsRequest)
) when using expressions containing equality or relational operators on
indexed columns. This only applies to child tables.
clearTable(ClearTableRequest)
to delete the table. This can be applied to child tables or collections or
views.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AlterTableResponse
public AlterTableResponse alterTable(String tableName, String action, String value, Map<String,String> options) throws GPUdbException
getRecordsRaw(GetRecordsRequest)
, deleteRecords(String, List, Map)
, updateRecordsRaw(RawUpdateRecordsRequest)
) when using expressions containing equality or relational operators on
indexed columns. This only applies to child tables.
clearTable(String, String, Map)
to delete the table. This can be applied to child tables or collections or
views.
tableName
- Table on which the operation will be performed. Must be a valid table or collection in GPUdb.action
- Modification operation to be applied to the table or collection Values: create_index, delete_index,
allow_homogeneous_tables, protected, ttl.value
- The value of the modification. May be a column name, 'true' or 'false', or a time-to-live depending on action
.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AlterTableResponse
public AlterTableMetadataResponse alterTableMetadata(AlterTableMetadataRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AlterTableMetadataResponse
public AlterTableMetadataResponse alterTableMetadata(List<String> tableNames, Map<String,String> metadataMap, Map<String,String> options) throws GPUdbException
tableNames
- Names of the tables whose metadata will be updated. All specified tables must exist in GPUdb, or GPUdb
will return an error.metadataMap
- A map which contains the metadata of the tables that are to be updated. Note that only one map is
provided for all the tables; so the change will be applied to every table. If the provided map is empty,
then all existing metadata for the table(s) will be cleared.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AlterTableMetadataResponse
public AlterUserResponse alterUser(AlterUserRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.AlterUserResponse
public AlterUserResponse alterUser(String name, String action, String value, Map<String,String> options) throws GPUdbException
name
- Name of the user to be altered. Must be an existing user.action
- Modification operation to be applied to the user. Values: set_password.value
- The value of the modification, depending on action
.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AlterUserResponse
public ClearTableResponse clearTable(ClearTableRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ClearTableResponse
public ClearTableResponse clearTable(String tableName, String authorization, Map<String,String> options) throws GPUdbException
tableName
- Name of the table to be cleared. Must be an existing GPUdb table. Empty string clears all available tables
in GPUdb.authorization
- No longer used. User can pass an empty string.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.ClearTableResponse
public ClearTableMonitorResponse clearTableMonitor(ClearTableMonitorRequest request) throws GPUdbException
createTableMonitor(CreateTableMonitorRequest)
.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ClearTableMonitorResponse
public ClearTableMonitorResponse clearTableMonitor(String topicId, Map<String,String> options) throws GPUdbException
createTableMonitor(String, Map)
.topicId
- The topic ID returned by createTableMonitor(String, Map)
.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.ClearTableMonitorResponse
public ClearTriggerResponse clearTrigger(ClearTriggerRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ClearTriggerResponse
public ClearTriggerResponse clearTrigger(String triggerId, Map<String,String> options) throws GPUdbException
triggerId
- ID for the trigger to be deactivated.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.ClearTriggerResponse
public CreateJoinTableResponse createJoinTable(CreateJoinTableRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateJoinTableResponse
public CreateJoinTableResponse createJoinTable(String joinTableName, List<String> tableNames, List<String> aliases, String expression, List<String> expressions, Map<String,String> options) throws GPUdbException
joinTableName
- Name of the join table to be created. Must not be the name of a currently existing GPUdb table or join
table. Cannot be an empty string.tableNames
- The list of table names making up the joined set. Corresponds to a SQL statement FROM clausealiases
- The list of aliases for each of the corresponding tables.expression
- An optional expression GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement
WHERE clause. For details see: expressions.expressions
- An optional list of expressions GPUdb uses to combine and filter the joined set. Corresponds to a SQL
statement WHERE clause. For details see: expressions.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.CreateJoinTableResponse
public CreateRoleResponse createRole(CreateRoleRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateRoleResponse
public CreateRoleResponse createRole(String name, Map<String,String> options) throws GPUdbException
name
- Name of the role to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin
with a digit. Must not be the same name as an existing user or role in GPUdb.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateRoleResponse
public CreateTableResponse createTable(CreateTableRequest request) throws GPUdbException
typeId
which must the be the type id of a currently registered type (i.e. one created via createType(CreateTypeRequest)
). The table will be created inside a collection if the option *collection_name* is
specified. If that collection does not already exist then it will be created. To create a new, empty collection specify the
collection name in tableName
, leave typeId
blank, and set the *is_collection* option to 'true'.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateTableResponse
public CreateTableResponse createTable(String tableName, String typeId, Map<String,String> options) throws GPUdbException
typeId
which must the be the type id of a currently registered type (i.e. one created via createType(String, String,
Map, Map)
). The table will be created inside a collection if the option *collection_name* is specified. If that collection
does not already exist then it will be created. To create a new, empty collection specify the collection name in tableName
, leave typeId
blank, and set the *is_collection* option to 'true'.tableName
- Name of the table to be created. Must not be the name of a currently existing GPUdb table of a different
type. Error for requests with existing table of the same name and type id may be suppressed by using the
no_error_if_exists
option. Cannot be an empty string. Valid characters are 'A-Za-z0-9_-(){}[] .:'
(excluding the single quote), with the first character being one of 'A-Za-z0-9_'. The maximum length is
256 characters.typeId
- ID of a currently registered type in GPUdb. All objects added to the newly created table will be of this type.
Must be an empty string if the *is_collection* is 'true'.options
- Optional parameters.
true
, prevents an error from occurring if the table already
exists and is of the given type. If a table with the same ID but a different type exists, it is still an
error. Values: true, false.
GPUdbException
- if an error occurs during the operation.CreateTableResponse
public CreateTableMonitorResponse createTableMonitor(CreateTableMonitorRequest request) throws GPUdbException
tableName
) and
forwards copies to subscribers via ZMQ. After this call completes, subscribe to the returned topicId
on the GPUdb ZMQ
table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for
that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that
was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated
with clearTableMonitor(ClearTableMonitorRequest)
.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateTableMonitorResponse
public CreateTableMonitorResponse createTableMonitor(String tableName, Map<String,String> options) throws GPUdbException
tableName
) and
forwards copies to subscribers via ZMQ. After this call completes, subscribe to the returned topicId
on the GPUdb ZMQ
table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for
that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that
was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated
with clearTableMonitor(String, Map)
.tableName
- Name of the table to monitor. Must not refer to a collection.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateTableMonitorResponse
public CreateTriggerByAreaResponse createTriggerByArea(CreateTriggerByAreaRequest request) throws GPUdbException
createTriggerByRange(CreateTriggerByRangeRequest)
.) Once the trigger has been
activated, any record added to the listed tables(s) via insertRecordsRaw(RawInsertRecordsRequest)
with the
chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at GPUdb's
trigger port-by default '9001' but can also be obtained via showSystemStatus(ShowSystemStatusRequest)
-for any
listening client to collect. Active triggers can be cancelled by using the clearTrigger(ClearTriggerRequest)
endpoint or by clearing all relevant tables.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateTriggerByAreaResponse
public CreateTriggerByAreaResponse createTriggerByArea(String requestId, List<String> tableNames, String xColumnName, List<Double> xVector, String yColumnName, List<Double> yVector, Map<String,String> options) throws GPUdbException
createTriggerByRange(String, List, String, double, double, Map)
.) Once the trigger
has been activated, any record added to the listed tables(s) via insertRecordsRaw(RawInsertRecordsRequest)
with
the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at
GPUdb's trigger port-by default '9001' but can also be obtained via showSystemStatus(Map)
-for any listening
client to collect. Active triggers can be cancelled by using the clearTrigger(String, Map)
endpoint or by
clearing all relevant tables.
requestId
- ID for the trigger to be activated.tableNames
- Names of the tables on which the trigger will be activated and maintained.xColumnName
- Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.xVector
- The respective coordinate values for the region on which the trigger is activated. This usually translates to
the x-coordinates of a geospatial region.yColumnName
- Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data
points.yVector
- The respective coordinate values for the region on which the trigger is activated. This usually translates to
the y-coordinates of a geospatial region. Must be the same length as xvals.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateTriggerByAreaResponse
public CreateTriggerByRangeResponse createTriggerByRange(CreateTriggerByRangeRequest request) throws GPUdbException
insertRecordsRaw(RawInsertRecordsRequest)
with the chosen column_name's value
falling within the specified range will trip the trigger. All such records will be queued at GPUdb's trigger port-by default
'9001' but can also be obtained via showSystemStatus(ShowSystemStatusRequest)
-for any listening client to
collect. Active triggers can be cancelled by using the clearTrigger(ClearTriggerRequest)
endpoint or by
clearing all relevant tables.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateTriggerByRangeResponse
public CreateTriggerByRangeResponse createTriggerByRange(String requestId, List<String> tableNames, String columnName, double min, double max, Map<String,String> options) throws GPUdbException
insertRecordsRaw(RawInsertRecordsRequest)
with the chosen column_name's value
falling within the specified range will trip the trigger. All such records will be queued at GPUdb's trigger port-by default
'9001' but can also be obtained via showSystemStatus(Map)
-for any listening client to collect. Active triggers
can be cancelled by using the clearTrigger(String, Map)
endpoint or by clearing all relevant tables.
requestId
- ID for the trigger request.tableNames
- Tables on which the trigger will be active.columnName
- Name of a numeric column_name on which the trigger is activated.min
- The lower bound (inclusive) for the trigger range.max
- The upper bound (inclusive) for the trigger range.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateTriggerByRangeResponse
public CreateTypeResponse createType(CreateTypeRequest request) throws GPUdbException
data
and store_only
.
inserting
data into a table with a primary key,
depending on the parameters in the request, incoming objects with primary keys that match existing objects will either
overwrite (i.e. update) the existing object or will be skipped and not added into the set.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateTypeResponse
public CreateTypeResponse createType(String typeDefinition, String label, Map<String,List<String>> properties, Map<String,String> options) throws GPUdbException
data
and store_only
.
inserting
data into a table with a primary key,
depending on the parameters in the request, incoming objects with primary keys that match existing objects will either
overwrite (i.e. update) the existing object or will be skipped and not added into the set.
typeDefinition
- a JSON string describing the columns of the type to be registered.label
- A user-defined description string which can be used to differentiate between tables and types with otherwise
identical schemas.properties
- Each key-value pair specifies the properties to use for a given column where the key is the column name.
All keys used must be relevant column names for the given table. Specifying any property overrides the
default properties for that column (which is based on the column's data type).options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateTypeResponse
public CreateUnionResponse createUnion(CreateUnionRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateUnionResponse
public CreateUnionResponse createUnion(String tableName, List<String> tableNames, List<List<String>> inputColumnNames, List<String> outputColumnNames, Map<String,String> options) throws GPUdbException
tableName
- Name of the table to be created. Must not be the name of a currently existing GPUdb table. Cannot be an
empty string.tableNames
- The list of table names making up the union. Must contain the names of one or more existing tables.inputColumnNames
- The list of columns from each of the corresponding input tables.outputColumnNames
- The list of names of the columns to be stored in the union.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.CreateUnionResponse
public CreateUserExternalResponse createUserExternal(CreateUserExternalRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateUserExternalResponse
public CreateUserExternalResponse createUserExternal(String name, Map<String,String> options) throws GPUdbException
name
- Name of the user to be created. Must exactly match the user's name in the external LDAP, prefixed with a @. Must
not be the same name as an existing user in GPUdb.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateUserExternalResponse
public CreateUserInternalResponse createUserInternal(CreateUserInternalRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.CreateUserInternalResponse
public CreateUserInternalResponse createUserInternal(String name, String password, Map<String,String> options) throws GPUdbException
name
- Name of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin
with a digit. Must not be the same name as an existing user or role in GPUdb.password
- Initial password of the user to be created. May be an empty string for no password.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateUserInternalResponse
public DeleteRecordsResponse deleteRecords(DeleteRecordsRequest request) throws GPUdbException
expressions
(matching multiple records) or a single record identified by record_id
options. Note that
the two selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is
synchronous meaning that a response will not be available until the request is completely processed and all the matching
records are deleted.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.DeleteRecordsResponse
public DeleteRecordsResponse deleteRecords(String tableName, List<String> expressions, Map<String,String> options) throws GPUdbException
expressions
(matching multiple records) or a single record identified by record_id
options. Note that
the two selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is
synchronous meaning that a response will not be available until the request is completely processed and all the matching
records are deleted.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.
expressions
.
insertion of the record
or by calling getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)
with the *return_record_ids* option.
GPUdbException
- if an error occurs during the operation.DeleteRecordsResponse
public DeleteRoleResponse deleteRole(DeleteRoleRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.DeleteRoleResponse
public DeleteRoleResponse deleteRole(String name, Map<String,String> options) throws GPUdbException
name
- Name of the role to be deleted. Must be an existing role.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.DeleteRoleResponse
public DeleteUserResponse deleteUser(DeleteUserRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.DeleteUserResponse
public DeleteUserResponse deleteUser(String name, Map<String,String> options) throws GPUdbException
name
- Name of the user to be deleted. Must be an existing user.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.DeleteUserResponse
public ExecuteProcResponse executeProc(ExecuteProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ExecuteProcResponse
public ExecuteProcResponse executeProc(String name, Map<String,String> params, Map<String,ByteBuffer> binParams, Map<String,String> options) throws GPUdbException
name
- Name of the proc to execute.params
- A map containing string parameters to pass to the proc. Each key/value pair specifies the name of a parameter
and its value.binParams
- A map containing binary parameters to pass to the proc. Each key/value pair specifies the name of a
parameter and its value.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.ExecuteProcResponse
public FilterResponse filter(FilterRequest request) throws GPUdbException
viewName
.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterResponse
public FilterResponse filter(String tableName, String viewName, String expression, Map<String,String> options) throws GPUdbException
viewName
.
tableName
- Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining
queries). Collections may be filtered only if all tables within the collection have the same type ID.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view .expression
- The select expression GPUdb uses to filter the specified table. For details see concepts.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterResponse
public FilterByAreaResponse filterByArea(FilterByAreaRequest request) throws GPUdbException
viewName
passed in as part of the input.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByAreaResponse
public FilterByAreaResponse filterByArea(String tableName, String viewName, String xColumnName, List<Double> xVector, String yColumnName, List<Double> yVector, Map<String,String> options) throws GPUdbException
viewName
passed in as part of the input.tableName
- Name of the table to filter. This may be the name of a collection, a table or a view (when chaining
queries). Collections may be filtered only if all tables within the collection have the same type ID.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.xColumnName
- Name of the column containing the x values to be filtered.xVector
- List of x coordinates of the vertices of the polygon representing the area to be filtered.yColumnName
- Name of the column containing the y values to be filtered.yVector
- List of y coordinates of the vertices of the polygon representing the area to be filtered.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByAreaResponse
public FilterByBoxResponse filterByBox(FilterByBoxRequest request) throws GPUdbException
viewName
is passed in as part of the input payload.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByBoxResponse
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
viewName
is passed in as part of the input payload.tableName
- Name of the table on which the bounding box operation will be performed. Must be a valid table in GPUdb.viewName
- Optional name of the result view that will be created containing the results of the query. Must not be an
already existing collection, table or view in GPUdb.xColumnName
- Name of the column on which to perform the bounding box query. If the table's data type is not a shape
type, must be a valid numeric column.minX
- Lower bound for the column chosen by xColumnName
. Must be less than or equal to maxX
.maxX
- Upper bound for xColumnName
. Must be greater than or equal to minX
.yColumnName
- Name of a column on which to perform the bounding box query. If the table's data type is not a shape
type, must be a valid numeric column.minY
- Lower bound for yColumnName
. Must be less than or equal to maxY
.maxY
- Upper bound for yColumnName
. Must be greater than or equal to minY
.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByBoxResponse
public FilterByGeometryResponse filterByGeometry(FilterByGeometryRequest request) throws GPUdbException
inputWkt
.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByGeometryResponse
public FilterByGeometryResponse filterByGeometry(String tableName, String viewName, String columnName, String inputWkt, String operation, Map<String,String> options) throws GPUdbException
inputWkt
.tableName
- Name of the table on which the filter by geometry will be performed. Must be an existing table, collection
or view containing a column named WKT.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.columnName
- Name of the column to be used in the filter. Must be 'WKT'inputWkt
- A geometry in WKT format that will be used to filter the objects in tableName
.operation
- The geometric filtering operation to perform Values: contains, crosses, disjoint, equals, intersects,
overlaps, touches, within.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByGeometryResponse
public FilterByListResponse filterByList(FilterByListRequest request) throws GPUdbException
viewName
is passed in as part of the request.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByListResponse
public FilterByListResponse filterByList(String tableName, String viewName, Map<String,List<String>> columnValuesMap, Map<String,String> options) throws GPUdbException
viewName
is passed in as part of the request.
tableName
- Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining
queries). Collections may be filtered only if all tables within the collection have the same type ID.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.columnValuesMap
- List of values for the corresponding column in the tableoptions
- Optional parameters.
GPUdbException
- if an error occurs during the operation.FilterByListResponse
public FilterByRadiusResponse filterByRadius(FilterByRadiusRequest request) throws GPUdbException
viewName
is passed in as part of the request.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByRadiusResponse
public FilterByRadiusResponse filterByRadius(String tableName, String viewName, String xColumnName, double xCenter, String yColumnName, double yCenter, double radius, Map<String,String> options) throws GPUdbException
viewName
is passed in as part of the request.
tableName
- Name of the table on which the filter by radius operation will be performed. Must be an existing table in
GPUdb.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.xColumnName
- Name of the column to be used for the x-coordinate (the longitude) of the center.xCenter
- Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The
maximum allowed value is 180.yColumnName
- Name of the column to be used for the y-coordinate-the latitude-of the center.yCenter
- Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The
maximum allowed value is 90.radius
- The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is
in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum
allowed value is MAX_INT.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByRadiusResponse
public FilterByRangeResponse filterByRange(FilterByRangeRequest request) throws GPUdbException
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.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByRangeResponse
public FilterByRangeResponse filterByRange(String tableName, String viewName, String columnName, double lowerBound, double upperBound, Map<String,String> options) throws GPUdbException
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.
tableName
- Name of the table on which the filter by range operation will be performed. Must be a valid GPUdb table.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.columnName
- Name of a column or an expression of one or more columns on which the operation would be applied.lowerBound
- Value of the lower bound (inclusive).upperBound
- Value of the upper bound (inclusive).options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByRangeResponse
public FilterBySeriesResponse filterBySeries(FilterBySeriesRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterBySeriesResponse
public FilterBySeriesResponse filterBySeries(String tableName, String viewName, String trackId, List<String> targetTrackIds, Map<String,String> options) throws GPUdbException
tableName
- Name of the table on which the filter by track operation will be performed. Must be a currently existing
table with track semantic type.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.trackId
- The ID of the track which will act as the filtering points. Must be an existing track within the given table.targetTrackIds
- Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID
within the given set.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.FilterBySeriesResponse
public FilterByStringResponse filterByString(FilterByStringRequest request) throws GPUdbException
columnNames
; GPUdb will search through all string columns of the table
that have text search enabled. Also, the first character of a search term cannot be a wildcard (* or ?), and search terms
cannot be any of the following: "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is",
"it", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was",
"will", "with".
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByStringResponse
public FilterByStringResponse filterByString(String tableName, String viewName, String expression, String mode, List<String> columnNames, Map<String,String> options) throws GPUdbException
columnNames
; GPUdb will search through all string columns of the table
that have text search enabled. Also, the first character of a search term cannot be a wildcard (* or ?), and search terms
cannot be any of the following: "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is",
"it", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was",
"will", "with".
tableName
- Name of the table on which the filter operation will be performed. Must be a valid GPUdb table, collection
or view.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.expression
- The expression with which to filter the table.mode
- The string filtering mode to apply. See above for details. Values: search, equals, contains, starts_with, regex.columnNames
- List of columns on which to apply the filter. Ignored for 'search' mode.options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.FilterByStringResponse
public FilterByTableResponse filterByTable(FilterByTableRequest request) throws GPUdbException
viewName
is specified, then the filtered objects will then be
put in a newly created view. The operation is synchronous, meaning that GPUdb will not return until all objects are fully
available in the result view. The return value contains the count (i.e. the size) of the resulting view.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByTableResponse
public FilterByTableResponse filterByTable(String tableName, String viewName, String columnName, String sourceTableName, String sourceTableColumnName, Map<String,String> options) throws GPUdbException
viewName
is specified, then the filtered objects will then be
put in a newly created view. The operation is synchronous, meaning that GPUdb will not return until all objects are fully
available in the result view. The return value contains the count (i.e. the size) of the resulting view.tableName
- Name of the table whose data will be filtered. Must be an existing table in GPUdb.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.columnName
- Name of the column by whose value the data will be filtered from the table designated by tableName
.sourceTableName
- Name of the table whose data will be compared against in the table called tableName
. Must be
an existing table in GPUdb.sourceTableColumnName
- Name of the column in the sourceTableName
whose values will be used as the filter for
table tableName
. Must match the type of the columnName
.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByTableResponse
public FilterByValueResponse filterByValue(FilterByValueRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.FilterByValueResponse
public FilterByValueResponse filterByValue(String tableName, String viewName, boolean isString, double value, String valueStr, String columnName, Map<String,String> options) throws GPUdbException
tableName
- Name of an existing GPUdb table on which to perform the calculation.viewName
- If provided, then this will be the name of the view containing the results. Must not be an already existing
collection, table or view.isString
- Indicates whether the value being searched for is string or numeric.value
- The value to search for.valueStr
- The string value to search for.columnName
- Name of a column or an expression of one or more columns on which the filter by value would be applied.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByValueResponse
public RawGetRecordsResponse getRecordsRaw(GetRecordsRequest request) throws GPUdbException
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.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RawGetRecordsResponse
public <TResponse> GetRecordsResponse<TResponse> getRecords(Object typeDescriptor, GetRecordsRequest request) throws GPUdbException
offset
and limit
parameters. Note that when
paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or
modified) the records retrieved may differ between calls based on the updates applied.
TResponse
- The type of object being retrieved.typeDescriptor
- Type descriptor used for decoding returned objects.request
- Request object containing the parameters for the operation.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.GetRecordsResponse
public <TResponse> GetRecordsResponse<TResponse> getRecords(Object typeDescriptor, String tableName, long offset, long limit, Map<String,String> options) throws GPUdbException
offset
and limit
parameters. Note that when
paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or
modified) the records retrieved may differ between calls based on the updates applied.
TResponse
- The type of object being retrieved.typeDescriptor
- Type descriptor used for decoding returned objects.tableName
- Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- 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.GetRecordsResponse
public <TResponse> GetRecordsResponse<TResponse> getRecords(GetRecordsRequest request) throws GPUdbException
offset
and limit
parameters. Note that when
paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or
modified) the records retrieved may differ between calls based on the updates applied.
TResponse
- The type of object being retrieved.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.GetRecordsResponse
public <TResponse> GetRecordsResponse<TResponse> getRecords(String tableName, long offset, long limit, Map<String,String> options) throws GPUdbException
offset
and limit
parameters. Note that when
paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or
modified) the records retrieved may differ between calls based on the updates applied.
TResponse
- The type of object being retrieved.tableName
- Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- GPUdbException
- if an error occurs during the operation.GetRecordsResponse
public RawGetRecordsByColumnResponse getRecordsByColumnRaw(GetRecordsByColumnRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RawGetRecordsByColumnResponse
public GetRecordsByColumnResponse getRecordsByColumn(GetRecordsByColumnRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.GetRecordsByColumnResponse
public GetRecordsByColumnResponse getRecordsByColumn(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options) throws GPUdbException
tableName
- Name of the table on which this operation will be performed. The table cannot be a parent set.columnNames
- The list of column values to retrieve. Columns annotated as store only cannot be retrieved.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned (if not provided the default is
10000). Or END_OF_column (-9999) to indicate that the max number of results should be returned.options
- GPUdbException
- if an error occurs during the operation.GetRecordsByColumnResponse
public RawGetRecordsBySeriesResponse getRecordsBySeriesRaw(GetRecordsBySeriesRequest request) throws GPUdbException
worldTableName
based on the partial track information
contained in the tableName
.
offset
and limit
parameters.
getRecordsRaw(GetRecordsRequest)
this returns records grouped by series/track. So if
offset
is 0 and limit
is 5 this operation would return the first 5 series/tracks in tableName
. Each
series/track will be returned sorted by their TIMESTAMP column.
The Raw version of this method can be used to specify the encoding scheme of the response.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RawGetRecordsBySeriesResponse
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(Object typeDescriptor, GetRecordsBySeriesRequest request) throws GPUdbException
worldTableName
based on the partial track information
contained in the tableName
.
offset
and limit
parameters.
getRecords(Object, GetRecordsRequest)
this returns records grouped by series/track. So if
offset
is 0 and limit
is 5 this operation would return the first 5 series/tracks in tableName
. Each
series/track will be returned sorted by their TIMESTAMP column.
The Raw version of this method can be used to specify the encoding scheme of the response.TResponse
- The type of object being retrieved.typeDescriptor
- Type descriptor used for decoding returned objects.request
- Request object containing the parameters for the operation.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.GetRecordsBySeriesResponse
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(Object typeDescriptor, String tableName, String worldTableName, int offset, int limit, Map<String,String> options) throws GPUdbException
worldTableName
based on the partial track information
contained in the tableName
.
offset
and limit
parameters.
getRecords(Object, String, long, long, Map)
this returns records grouped by series/track.
So if offset
is 0 and limit
is 5 this operation would return the first 5 series/tracks in tableName
.
Each series/track will be returned sorted by their TIMESTAMP column.
The Raw version of this method can be used to specify the encoding scheme of the response.TResponse
- The type of object being retrieved.typeDescriptor
- Type descriptor used for decoding returned objects.tableName
- Name of the collection/table/view for which series/tracks will be fetched.worldTableName
- Name of the table containing the complete series/track information to be returned for the tracks
present in the tableName
. Typically this is used when retrieving series/tracks from a view
(which contains partial series/tracks) but the user wants to retrieve the entire original
series/tracks. Can be blank.offset
- A positive integer indicating the number of initial series/tracks to skip (useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to
indicate that the max number of results should be returned.options
- Optional parameters.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.GetRecordsBySeriesResponse
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(GetRecordsBySeriesRequest request) throws GPUdbException
worldTableName
based on the partial track information
contained in the tableName
.
offset
and limit
parameters.
getRecords(GetRecordsRequest)
this returns records grouped by series/track. So if offset
is 0 and limit
is 5 this operation would return the first 5 series/tracks in tableName
. Each
series/track will be returned sorted by their TIMESTAMP column.
The Raw version of this method can be used to specify the encoding scheme of the response.TResponse
- The type of object being retrieved.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.GetRecordsBySeriesResponse
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(String tableName, String worldTableName, int offset, int limit, Map<String,String> options) throws GPUdbException
worldTableName
based on the partial track information
contained in the tableName
.
offset
and limit
parameters.
getRecords(String, long, long, Map)
this returns records grouped by series/track. So if
offset
is 0 and limit
is 5 this operation would return the first 5 series/tracks in tableName
. Each
series/track will be returned sorted by their TIMESTAMP column.
The Raw version of this method can be used to specify the encoding scheme of the response.TResponse
- The type of object being retrieved.tableName
- Name of the collection/table/view for which series/tracks will be fetched.worldTableName
- Name of the table containing the complete series/track information to be returned for the tracks
present in the tableName
. Typically this is used when retrieving series/tracks from a view
(which contains partial series/tracks) but the user wants to retrieve the entire original
series/tracks. Can be blank.offset
- A positive integer indicating the number of initial series/tracks to skip (useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to
indicate that the max number of results should be returned.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.GetRecordsBySeriesResponse
public RawGetRecordsFromCollectionResponse getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest request) throws GPUdbException
deleteRecords(DeleteRecordsRequest)
.
offset
and limit
parameters.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RawGetRecordsFromCollectionResponse
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(Object typeDescriptor, GetRecordsFromCollectionRequest request) throws GPUdbException
deleteRecords(DeleteRecordsRequest)
.
offset
and limit
parameters.
TResponse
- The type of object being retrieved.typeDescriptor
- Type descriptor used for decoding returned objects.request
- Request object containing the parameters for the operation.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.GetRecordsFromCollectionResponse
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(Object typeDescriptor, String tableName, long offset, long limit, Map<String,String> options) throws GPUdbException
deleteRecords(String, List, Map)
.
offset
and limit
parameters.
TResponse
- The type of object being retrieved.typeDescriptor
- Type descriptor used for decoding returned objects.tableName
- Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb
collection or table.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- 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.GetRecordsFromCollectionResponse
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(GetRecordsFromCollectionRequest request) throws GPUdbException
deleteRecords(DeleteRecordsRequest)
.
offset
and limit
parameters.
TResponse
- The type of object being retrieved.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.GetRecordsFromCollectionResponse
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(String tableName, long offset, long limit, Map<String,String> options) throws GPUdbException
deleteRecords(String, List, Map)
.
offset
and limit
parameters.
TResponse
- The type of object being retrieved.tableName
- Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb
collection or table.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- GPUdbException
- if an error occurs during the operation.GetRecordsFromCollectionResponse
public GrantPermissionSystemResponse grantPermissionSystem(GrantPermissionSystemRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.GrantPermissionSystemResponse
public GrantPermissionSystemResponse grantPermissionSystem(String name, String permission, Map<String,String> options) throws GPUdbException
name
- Name of the user or role to which the permission will be granted. Must be an existing user or role.permission
- Permission to grant to the user or role. Values: system_admin, system_write, system_read.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.GrantPermissionSystemResponse
public GrantPermissionTableResponse grantPermissionTable(GrantPermissionTableRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.GrantPermissionTableResponse
public GrantPermissionTableResponse grantPermissionTable(String name, String permission, String tableName, String filterExpression, Map<String,String> options) throws GPUdbException
name
- Name of the user or role to which the permission will be granted. Must be an existing user or role.permission
- Permission to grant to the user or role. Values: table_admin, table_insert, table_update, table_delete,
table_read.tableName
- Name of the table to which the permission grants access. Must be an existing table, collection, or view. If
a collection, the permission also applies to tables and views in the collection.filterExpression
- Reserved for future use.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.GrantPermissionTableResponse
public GrantRoleResponse grantRole(GrantRoleRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.GrantRoleResponse
public GrantRoleResponse grantRole(String role, String member, Map<String,String> options) throws GPUdbException
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.GPUdbException
- if an error occurs during the operation.GrantRoleResponse
public HasTableResponse hasTable(HasTableRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.HasTableResponse
public HasTableResponse hasTable(String tableName, Map<String,String> options) throws GPUdbException
tableName
- Name of the table to check for existence.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.HasTableResponse
public HasTypeResponse hasType(HasTypeRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.HasTypeResponse
public HasTypeResponse hasType(String typeId, Map<String,String> options) throws GPUdbException
typeId
- Id of the type returned by GPUdb in response to createType(String, String, Map, Map)
request.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.HasTypeResponse
public InsertRecordsResponse insertRecordsRaw(RawInsertRecordsRequest request) throws GPUdbException
options
can be used to customize this function's behavior. The only parameter available is update_on_existing_pk
. The value can be either 'true' or 'false'. If the table has a primary key
and if update_on_existing_pk
is 'true' then if any of the records
being added have the same primary key as existing records, the existing records are replaced (i.e. *updated*) with the given
records. If update_on_existing_pk
is false and if the records being added have the same primary key as existing
records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite
possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be
ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk
option
is ignored.
The Raw version of this method can be used to specify the encoding scheme of the request.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.InsertRecordsResponse
public <TRequest> InsertRecordsResponse insertRecords(InsertRecordsRequest<TRequest> request) throws GPUdbException
options
can be used to customize this function's behavior. The only parameter available is update_on_existing_pk
. The value can be either 'true' or 'false'. If the table has a primary key
and if update_on_existing_pk
is 'true' then if any of the records
being added have the same primary key as existing records, the existing records are replaced (i.e. *updated*) with the given
records. If update_on_existing_pk
is false and if the records being added have the same primary key as existing
records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite
possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be
ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk
option
is ignored.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.InsertRecordsResponse
public <TRequest> InsertRecordsResponse insertRecords(TypeObjectMap<TRequest> typeObjectMap, InsertRecordsRequest<TRequest> request) throws GPUdbException
options
can be used to customize this function's behavior. The only parameter available is update_on_existing_pk
. The value can be either 'true' or 'false'. If the table has a primary key
and if update_on_existing_pk
is 'true' then if any of the records
being added have the same primary key as existing records, the existing records are replaced (i.e. *updated*) with the given
records. If update_on_existing_pk
is false and if the records being added have the same primary key as existing
records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite
possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be
ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk
option
is ignored.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.typeObjectMap
- Type object map used for encoding input objects.request
- Request object containing the parameters for the operation.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.InsertRecordsResponse
public <TRequest> InsertRecordsResponse insertRecords(String tableName, List<TRequest> data, Map<String,String> options) throws GPUdbException
options
can be used to customize this function's behavior. The only parameter available is update_on_existing_pk
. The value can be either 'true' or 'false'. If the table has a primary key
and if update_on_existing_pk
is 'true' then if any of the records being added have the same
primary key as existing records, the existing records are replaced (i.e. *updated*) with the given records. If update_on_existing_pk
is false and if the records being added have the same primary key as existing records, the given
records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this
case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated).
If the specified table does not have a primary key column then the update_on_existing_pk
option is ignored.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.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.
primary key
, then if the value is 'true' then if any of the records being added have the same primary key as
existing records, the existing records are replaced (i.e. *updated*) with the given records. If 'false' and
if the records being added have the same primary key as existing records, the given records with existing
primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case
some of the given records will be inserted and some (those having existing primary keys) will be ignored (or
updated). If the specified table does not have a primary key column then this optional parameter is ignored.
Values: true, false.
GPUdbException
- if an error occurs during the operation.InsertRecordsResponse
public <TRequest> InsertRecordsResponse insertRecords(TypeObjectMap<TRequest> typeObjectMap, String tableName, List<TRequest> data, Map<String,String> options) throws GPUdbException
options
can be used to customize this function's behavior. The only parameter available is update_on_existing_pk
. The value can be either 'true' or 'false'. If the table has a primary key
and if update_on_existing_pk
is 'true' then if any of the records being added have the same
primary key as existing records, the existing records are replaced (i.e. *updated*) with the given records. If update_on_existing_pk
is false and if the records being added have the same primary key as existing records, the given
records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this
case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated).
If the specified table does not have a primary key column then the update_on_existing_pk
option is ignored.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.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.
primary key
, then if the value is 'true' then if any of the records being added have the same primary key as
existing records, the existing records are replaced (i.e. *updated*) with the given records. If 'false' and
if the records being added have the same primary key as existing records, the given records with existing
primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case
some of the given records will be inserted and some (those having existing primary keys) will be ignored (or
updated). If the specified table does not have a primary key column then this optional parameter is ignored.
Values: true, false.
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.InsertRecordsResponse
public InsertRecordsRandomResponse insertRecordsRandom(InsertRecordsRandomRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.InsertRecordsRandomResponse
public InsertRecordsRandomResponse insertRecordsRandom(String tableName, long count, Map<String,Map<String,Double>> options) throws GPUdbException
tableName
- Table to which random records will be added. Must be an existing table. Also, must be an individual table,
not a collection of tables, nor a view of a table.count
- Number of records to generate.options
- Optional parameter to pass in specifications for the randomness of the values. This map is different from
the *options* parameter of most other endpoints in that it is a map of string to map of string to doubles,
while most others are maps of string to string. In this map, the top level keys represent which column's
parameters are being specified, while the internal keys represents which parameter is being specified. The
parameters that can be specified are: *min*, *max*, and *interval*. These parameters take on different
meanings depending on the type of the column. Below follows a more detailed description of the map:
all
parameter judiciously.
all
parameter judiciously.
all
.
all
parameter judiciously.
all
parameter judiciously.
GPUdbException
- if an error occurs during the operation.InsertRecordsRandomResponse
public InsertSymbolResponse insertSymbol(InsertSymbolRequest request) throws GPUdbException
visualizeImage(VisualizeImageRequest)
) if the 'dosymbology' parameter is 'true' then
GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.InsertSymbolResponse
public InsertSymbolResponse insertSymbol(String symbolId, String symbolFormat, ByteBuffer symbolData, Map<String,String> options) throws GPUdbException
visualizeImage(List, List, String, String, List, double, double, double, double, int,
int, String, long, Map, Map)
) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column
to pick the symbol displayed for each point.symbolId
- The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects
using this symbolsymbolFormat
- Specifies the symbol format. Must be either 'svg' or 'svg_path'. Values: svg, svg_path.symbolData
- The actual symbol data. If symbolFormat
is 'svg' then this should be the raw bytes representing an
svg file. If symbolFormat
is svg path then this should be an svg path string, for example:
'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'options
- Optional parameters.
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.
GPUdbException
- if an error occurs during the operation.InsertSymbolResponse
public LockTableResponse lockTable(LockTableRequest request) throws GPUdbException
lockType
of unlock
, indicating all
operations are permitted. A user may request a read-only
or a write-only
lock, after which only read or
write operations, respectively, are permitted on the table until the lock is removed. When lockType
is disable
then no operations are permitted on the table. The lock status can be queried by setting lockType
to status
.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.LockTableResponse
public LockTableResponse lockTable(String tableName, String lockType, Map<String,String> options) throws GPUdbException
lockType
of unlock
, indicating all
operations are permitted. A user may request a read-only
or a write-only
lock, after which only read or
write operations, respectively, are permitted on the table until the lock is removed. When lockType
is disable
then no operations are permitted on the table. The lock status can be queried by setting lockType
to status
.tableName
- Name of the table to be locked. It must be a currently existing table, collection, or view.lockType
- The type of lock being applied to the table. Setting it to status
will return the current lock
status of the table without changing it. Values: status, disable, read-only, write-only, unlock.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.LockTableResponse
public RevokePermissionSystemResponse revokePermissionSystem(RevokePermissionSystemRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RevokePermissionSystemResponse
public RevokePermissionSystemResponse revokePermissionSystem(String name, String permission, Map<String,String> options) throws GPUdbException
name
- Name of the user or role from which the permission will be revoked. Must be an existing user or role.permission
- Permission to revoke from the user or role. Values: system_admin, system_write, system_read.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.RevokePermissionSystemResponse
public RevokePermissionTableResponse revokePermissionTable(RevokePermissionTableRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RevokePermissionTableResponse
public RevokePermissionTableResponse revokePermissionTable(String name, String permission, String tableName, Map<String,String> options) throws GPUdbException
name
- Name of the user or role from which the permission will be revoked. Must be an existing user or role.permission
- Permission to revoke from the user or role. Values: table_admin, table_insert, table_update, table_delete,
table_read.tableName
- Name of the table to which the permission grants access. Must be an existing table, collection, or view.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.RevokePermissionTableResponse
public RevokeRoleResponse revokeRole(RevokeRoleRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.RevokeRoleResponse
public RevokeRoleResponse revokeRole(String role, String member, Map<String,String> options) throws GPUdbException
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.GPUdbException
- if an error occurs during the operation.RevokeRoleResponse
public ShowSecurityResponse showSecurity(ShowSecurityRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowSecurityResponse
public ShowSecurityResponse showSecurity(List<String> names, Map<String,String> options) throws GPUdbException
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.GPUdbException
- if an error occurs during the operation.ShowSecurityResponse
public ShowSystemPropertiesResponse showSystemProperties(ShowSystemPropertiesRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowSystemPropertiesResponse
public ShowSystemPropertiesResponse showSystemProperties(Map<String,String> options) throws GPUdbException
options
- Optional parameters.
GPUdbException
- if an error occurs during the operation.ShowSystemPropertiesResponse
public ShowSystemStatusResponse showSystemStatus(ShowSystemStatusRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowSystemStatusResponse
public ShowSystemStatusResponse showSystemStatus(Map<String,String> options) throws GPUdbException
options
- Optional parameters, currently unused.GPUdbException
- if an error occurs during the operation.ShowSystemStatusResponse
public ShowSystemTimingResponse showSystemTiming(ShowSystemTimingRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowSystemTimingResponse
public ShowSystemTimingResponse showSystemTiming(Map<String,String> options) throws GPUdbException
options
- Optional parameters, currently unused.GPUdbException
- if an error occurs during the operation.ShowSystemTimingResponse
public ShowTableResponse showTable(ShowTableRequest request) throws GPUdbException
tableName
. If the supplied tableName
is a collection, the call returns a list of tables contained in the collection, and for each table it returns the
description, type id, schema, type label, type properties, and additional information including TTL. If tableName
is
empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).
sizes
and fullSizes
), along with the total number of objects in the requested table
(in totalSize
and totalFullSize
).
tableName
empty will return an error.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowTableResponse
public ShowTableResponse showTable(String tableName, Map<String,String> options) throws GPUdbException
tableName
. If the supplied tableName
is a collection, the call returns a list of tables contained in the collection, and for each table it returns the
description, type id, schema, type label, type properties, and additional information including TTL. If tableName
is
empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).
sizes
and fullSizes
), along with the total number of objects in the requested table
(in totalSize
and totalFullSize
).
tableName
empty will return an error.
tableName
- Name of the table for which to retrieve the information. If blank then information about all collections
and top-level tables is returned.options
- Optional parameters.
tableName
is a collection, then 'true' will return information about
the children of the collection, and 'false' will return information about the collection itself. If tableName
is a child table, 'show_children' must be 'false'. If tableName
is empty then
'show_children' must be 'true'. Values: true, false.
GPUdbException
- if an error occurs during the operation.ShowTableResponse
public ShowTableMetadataResponse showTableMetadata(ShowTableMetadataRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowTableMetadataResponse
public ShowTableMetadataResponse showTableMetadata(List<String> tableNames, Map<String,String> options) throws GPUdbException
tableNames
- Tables whose metadata will be fetched. All provided tables must exist in GPUdb, or GPUdb returns an error.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.ShowTableMetadataResponse
public ShowTablesByTypeResponse showTablesByType(ShowTablesByTypeRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowTablesByTypeResponse
public ShowTablesByTypeResponse showTablesByType(String typeId, String label, Map<String,String> options) throws GPUdbException
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.GPUdbException
- if an error occurs during the operation.ShowTablesByTypeResponse
public ShowTriggersResponse showTriggers(ShowTriggersRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowTriggersResponse
public ShowTriggersResponse showTriggers(List<String> triggerIds, Map<String,String> options) throws GPUdbException
triggerIds
- List of IDs of the triggers whose information to be retrieved. Empty list means retrieve information on
all active triggers.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.ShowTriggersResponse
public ShowTypesResponse showTypes(ShowTypesRequest request) throws GPUdbException
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.ShowTypesResponse
public ShowTypesResponse showTypes(String typeId, String label, Map<String,String> options) throws GPUdbException
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.GPUdbException
- if an error occurs during the operation.ShowTypesResponse
public UpdateRecordsResponse updateRecordsRaw(RawUpdateRecordsRequest request) throws GPUdbException
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.
options
.
The Raw version of this method can be used to specify the encoding scheme of the request.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.UpdateRecordsResponse
public <TRequest> UpdateRecordsResponse updateRecords(UpdateRecordsRequest<TRequest> request) throws GPUdbException
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.
options
.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.UpdateRecordsResponse
public <TRequest> UpdateRecordsResponse updateRecords(TypeObjectMap<TRequest> typeObjectMap, UpdateRecordsRequest<TRequest> request) throws GPUdbException
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.
options
.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.typeObjectMap
- Type object map used for encoding input objects.request
- Request object containing the parameters for the operation.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.UpdateRecordsResponse
public <TRequest> UpdateRecordsResponse updateRecords(String tableName, List<String> expressions, List<Map<String,String>> newValuesMaps, List<TRequest> data, Map<String,String> options) throws GPUdbException
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.
options
.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.tableName
- Table to be updated. Must be a currently existing table and not a collection or view.expressions
- A list of the actual predicates, one for each update; format should follow the guidelines here
.newValuesMaps
- List of new values for the matching records. Each element is a map with (key, value) pairs where the
keys are the names of the columns whose values are to be updated; the values are the new values. The
number of elements in the list should match the length of expressions
.data
- An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions
does not yield a matching record to be updated, then the corresponding element from this list will
be added to the table.options
- Optional parameters.
expressions
.
insertRecords(String, List, Map)
. Values: true, false.
insertRecords(String, List, Map)
or getRecordsFromCollection(Object, String, long, long,
Map)
).
GPUdbException
- if an error occurs during the operation.UpdateRecordsResponse
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
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.
options
.
The Raw version of this method can be used to specify the encoding scheme of the request.TRequest
- The type of object being added.typeObjectMap
- Type object map used for encoding input objects.tableName
- Table to be updated. Must be a currently existing table and not a collection or view.expressions
- A list of the actual predicates, one for each update; format should follow the guidelines here
.newValuesMaps
- List of new values for the matching records. Each element is a map with (key, value) pairs where the
keys are the names of the columns whose values are to be updated; the values are the new values. The
number of elements in the list should match the length of expressions
.data
- An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions
does not yield a matching record to be updated, then the corresponding element from this list will
be added to the table.options
- Optional parameters.
expressions
.
insertRecords(TypeObjectMap, String, List, Map)
. Values: true,
false.
insertRecords(TypeObjectMap, String, List, Map)
or getRecordsFromCollection(Object,
String, long, long, Map)
).
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.UpdateRecordsResponse
public UpdateRecordsBySeriesResponse updateRecordsBySeries(UpdateRecordsBySeriesRequest request) throws GPUdbException
tableName
to include full series (track) information from the worldTableName
for the series (tracks) present in the viewName
.request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.UpdateRecordsBySeriesResponse
public UpdateRecordsBySeriesResponse updateRecordsBySeries(String tableName, String worldTableName, String viewName, List<String> reserved, Map<String,String> options) throws GPUdbException
tableName
to include full series (track) information from the worldTableName
for the series (tracks) present in the viewName
.tableName
- Name of the view on which the update operation will be performed. Must be a valid view in GPUdb.worldTableName
- Name of the table containing the complete series (track) information.viewName
- Optional name of the view containing the series (tracks) which have to be updated.reserved
- options
- Optional parameters.GPUdbException
- if an error occurs during the operation.UpdateRecordsBySeriesResponse
public VisualizeImageResponse visualizeImage(VisualizeImageRequest request) throws GPUdbException
GPUdbException
public VisualizeImageResponse visualizeImage(List<String> tableNames, List<String> worldTableNames, String xColumnName, String yColumnName, List<List<String>> trackIds, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, Map<String,List<String>> styleOptions, Map<String,String> options) throws GPUdbException
GPUdbException
public VisualizeImageClassbreakResponse visualizeImageClassbreak(VisualizeImageClassbreakRequest request) throws GPUdbException
GPUdbException
public VisualizeImageClassbreakResponse visualizeImageClassbreak(List<String> tableNames, List<String> worldTableNames, String xColumnName, String yColumnName, List<List<String>> trackIds, String cbColumnName1, List<String> cbVals1, List<String> cbColumnName2, List<List<String>> cbVals2, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, Map<String,List<String>> styleOptions, Map<String,String> options) throws GPUdbException
GPUdbException
public VisualizeImageHeatmapResponse visualizeImageHeatmap(VisualizeImageHeatmapRequest request) throws GPUdbException
GPUdbException
public VisualizeImageHeatmapResponse visualizeImageHeatmap(List<String> tableNames, String xColumnName, String yColumnName, String valueColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, Map<String,String> styleOptions, Map<String,String> options) throws GPUdbException
GPUdbException
public VisualizeImageLabelsResponse visualizeImageLabels(VisualizeImageLabelsRequest request) throws GPUdbException
GPUdbException
public VisualizeImageLabelsResponse visualizeImageLabels(String tableName, String xColumnName, String yColumnName, String xOffset, String yOffset, String textString, String font, String textColor, String textAngle, String textScale, String drawBox, String drawLeader, String lineWidth, String lineColor, String fillColor, String leaderXColumnName, String leaderYColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, Map<String,String> options) throws GPUdbException
GPUdbException
public VisualizeVideoResponse visualizeVideo(VisualizeVideoRequest request) throws GPUdbException
bgColor
, width
,
height
), the collection of GPUdb table names on which this function is to be applied, for which shapes (point,
polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the
generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the
images for all the frames of the video are fully available.
sessionKey
of
the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other
WMS parameters are ignored for this mode.
request
- Request object containing the parameters for the operation.GPUdbException
- if an error occurs during the operation.VisualizeVideoResponse
public VisualizeVideoResponse visualizeVideo(List<String> tableNames, List<String> worldTableNames, List<List<String>> trackIds, String xColumnName, String yColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, List<List<Double>> timeIntervals, String videoStyle, String sessionKey, Map<String,List<String>> styleOptions, Map<String,String> options) throws GPUdbException
bgColor
, width
,
height
), the collection of GPUdb table names on which this function is to be applied, for which shapes (point,
polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the
generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the
images for all the frames of the video are fully available.
sessionKey
of
the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other
WMS parameters are ignored for this mode.
tableNames
- Names of the tables containing the data for various layers of the resulting video.worldTableNames
- Optional name of the tables containing the data for the entire track when the tableNames
contains only part of the track data, but the entire track has to be rendered. The number of tables
should match the number of tables in the tableNames
trackIds
- Tracks from the tableNames
to be rendered.xColumnName
- Name of the column containing the x coordinates.yColumnName
- Name of the column containing the y coordinates.minX
- Lower bound for the x values.maxX
- Upper bound for the x values.minY
- Lower bound for the y values.maxY
- Upper bound for the y values.width
- Width of the generated image.height
- Height of the generated image.projection
- Spatial Reference System (i.e. EPSG Code). Values: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100,
EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.bgColor
- Background color of the generated image.timeIntervals
- videoStyle
- sessionKey
- User Provided session key that is later used to retrieve the generated video from the WMS.styleOptions
- Styling options for the image.
options
- Optional parameters.GPUdbException
- if an error occurs during the operation.VisualizeVideoResponse
public VisualizeVideoHeatmapResponse visualizeVideoHeatmap(VisualizeVideoHeatmapRequest request) throws GPUdbException
GPUdbException
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
GPUdbException
Copyright © 2016. All rights reserved.