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(List<URL> urls)
Creates a
GPUdb instance for the GPUdb server with the
specified URLs using default options. |
GPUdb(List<URL> urls,
GPUdbBase.Options options)
Creates a
GPUdb instance for the GPUdb server with the
specified URLs using the specified options. |
GPUdb(String url)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using default options. |
GPUdb(String url,
GPUdbBase.Options options)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using the specified options. |
GPUdb(URL url)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using default options. |
GPUdb(URL url,
GPUdbBase.Options options)
Creates a
GPUdb instance for the GPUdb server at the
specified URL using the specified options. |
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 database server application.
|
AdminShutdownResponse |
adminShutdown(String exitType,
String authorization,
Map<String,String> options)
Exits the database server application.
|
AdminVerifyDbResponse |
adminVerifyDb(AdminVerifyDbRequest request)
Verify database is in a consistent state.
|
AdminVerifyDbResponse |
adminVerifyDb(Map<String,String> options)
Verify database is in a consistent state.
|
AggregateConvexHullResponse |
aggregateConvexHull(AggregateConvexHullRequest request)
Calculates and returns the convex hull for the values in a table
specified by
tableName . |
AggregateConvexHullResponse |
aggregateConvexHull(String tableName,
String xColumnName,
String yColumnName,
Map<String,String> options)
Calculates and returns the convex hull for the values in a table
specified by
tableName . |
AggregateGroupByResponse |
aggregateGroupBy(AggregateGroupByRequest request)
Calculates unique combinations (groups) of values for the given columns
in a given table/view/collection and computes aggregates on each unique
combination.
|
AggregateGroupByResponse |
aggregateGroupBy(String tableName,
List<String> columnNames,
long offset,
long limit,
Map<String,String> options)
Calculates unique combinations (groups) of values for the given columns
in a given table/view/collection and computes aggregates on each unique
combination.
|
RawAggregateGroupByResponse |
aggregateGroupByRaw(AggregateGroupByRequest request)
Calculates unique combinations (groups) of values for the given columns
in a given table/view/collection and computes aggregates on each unique
combination.
|
AggregateHistogramResponse |
aggregateHistogram(AggregateHistogramRequest request)
Performs a histogram calculation given a table, a column, and an
interval function.
|
AggregateHistogramResponse |
aggregateHistogram(String tableName,
String columnName,
double start,
double end,
double interval,
Map<String,String> options)
Performs a histogram calculation given a table, a column, and an
interval function.
|
AggregateKMeansResponse |
aggregateKMeans(AggregateKMeansRequest request)
This endpoint runs the k-means algorithm - a heuristic algorithm that
attempts to do k-means clustering.
|
AggregateKMeansResponse |
aggregateKMeans(String tableName,
List<String> columnNames,
int k,
double tolerance,
Map<String,String> options)
This endpoint runs the k-means algorithm - a heuristic algorithm that
attempts to do k-means clustering.
|
AggregateMinMaxResponse |
aggregateMinMax(AggregateMinMaxRequest request)
Calculates and returns the minimum and maximum values of a particular
column in a table.
|
AggregateMinMaxResponse |
aggregateMinMax(String tableName,
String columnName,
Map<String,String> options)
Calculates and returns the minimum and maximum values of a particular
column in a table.
|
AggregateStatisticsResponse |
aggregateStatistics(AggregateStatisticsRequest request)
Calculates the requested statistics of the given column(s) in a given
table.
|
AggregateStatisticsResponse |
aggregateStatistics(String tableName,
String columnName,
String stats,
Map<String,String> options)
Calculates the requested statistics of the given column(s) in a given
table.
|
AggregateStatisticsByRangeResponse |
aggregateStatisticsByRange(AggregateStatisticsByRangeRequest request)
Divides the given set into bins and calculates statistics of the values
of a value-column in each bin.
|
AggregateStatisticsByRangeResponse |
aggregateStatisticsByRange(String tableName,
String selectExpression,
String columnName,
String valueColumnName,
String stats,
double start,
double end,
double interval,
Map<String,String> options)
Divides the given set into bins and calculates statistics of the values
of a value-column in each bin.
|
AggregateUniqueResponse |
aggregateUnique(AggregateUniqueRequest request)
Returns all the unique values from a particular column (specified by
columnName ) of a particular table (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
alterSystemProperties(AlterSystemPropertiesRequest)
endpoint is primarily used to simplify the testing of the system and is
not expected to be used during normal execution. |
AlterSystemPropertiesResponse |
alterSystemProperties(Map<String,String> propertyUpdatesMap,
Map<String,String> options)
The
alterSystemProperties(Map, Map) endpoint is primarily
used to simplify the testing of the system and is not expected to be
used during normal execution. |
AlterTableResponse |
alterTable(AlterTableRequest request)
Apply various modifications to a table 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 database cluster.
|
ClearTableResponse |
clearTable(String tableName,
String authorization,
Map<String,String> options)
Clears (drops) one or all tables in the database cluster.
|
ClearTableMonitorResponse |
clearTableMonitor(ClearTableMonitorRequest request)
Deactivates a table monitor previously created with
createTableMonitor(CreateTableMonitorRequest) . |
ClearTableMonitorResponse |
clearTableMonitor(String topicId,
Map<String,String> options)
Deactivates a table monitor previously created with
createTableMonitor(String, Map) . |
ClearTriggerResponse |
clearTrigger(ClearTriggerRequest request)
Clears or cancels the trigger identified by the specified handle.
|
ClearTriggerResponse |
clearTrigger(String triggerId,
Map<String,String> options)
Clears or cancels the trigger identified by the specified handle.
|
CreateJoinTableResponse |
createJoinTable(CreateJoinTableRequest request)
Creates a table that is the result of a SQL JOIN.
|
CreateJoinTableResponse |
createJoinTable(String joinTableName,
List<String> tableNames,
List<String> columnNames,
List<String> expressions,
Map<String,String> options)
Creates a table that is the result of a SQL JOIN.
|
CreateProcResponse |
createProc(CreateProcRequest request)
Creates an instance (proc) of the user-defined function (UDF) specified
by the given command, options, and files, and makes it available for
execution.
|
CreateProcResponse |
createProc(String procName,
String executionMode,
Map<String,ByteBuffer> files,
String command,
List<String> args,
Map<String,String> options)
Creates an instance (proc) of the user-defined function (UDF) specified
by the given command, options, and files, and makes it available for
execution.
|
CreateProjectionResponse |
createProjection(CreateProjectionRequest request)
Creates a new projection of an existing table.
|
CreateProjectionResponse |
createProjection(String tableName,
String projectionName,
List<String> columnNames,
Map<String,String> options)
Creates a new projection of an existing table.
|
CreateRoleResponse |
createRole(CreateRoleRequest request)
Creates a new role.
|
CreateRoleResponse |
createRole(String name,
Map<String,String> options)
Creates a new role.
|
CreateTableResponse |
createTable(CreateTableRequest request)
Creates a new table or collection.
|
CreateTableResponse |
createTable(String tableName,
String typeId,
Map<String,String> options)
Creates a new table or collection.
|
CreateTableMonitorResponse |
createTableMonitor(CreateTableMonitorRequest request)
Creates a monitor that watches for new records inserted into a
particular table (identified by
tableName ) and forwards copies
to subscribers via ZMQ. |
CreateTableMonitorResponse |
createTableMonitor(String tableName,
Map<String,String> options)
Creates a monitor that watches for new records inserted into a
particular table (identified by
tableName ) and forwards copies
to subscribers via ZMQ. |
CreateTriggerByAreaResponse |
createTriggerByArea(CreateTriggerByAreaRequest request)
Sets up an area trigger mechanism for two column_names for one or more
tables.
|
CreateTriggerByAreaResponse |
createTriggerByArea(String requestId,
List<String> tableNames,
String xColumnName,
List<Double> xVector,
String yColumnName,
List<Double> yVector,
Map<String,String> options)
Sets up an area trigger mechanism for two column_names for one or more
tables.
|
CreateTriggerByRangeResponse |
createTriggerByRange(CreateTriggerByRangeRequest request)
Sets up a simple range trigger for a column_name for one or more tables.
|
CreateTriggerByRangeResponse |
createTriggerByRange(String requestId,
List<String> tableNames,
String columnName,
double min,
double max,
Map<String,String> options)
Sets up a simple range trigger for a column_name for one or more tables.
|
CreateTypeResponse |
createType(CreateTypeRequest request)
Creates a new type describing the layout or schema of a table.
|
CreateTypeResponse |
createType(String typeDefinition,
String label,
Map<String,List<String>> properties,
Map<String,String> options)
Creates a new type describing the layout or schema of a table.
|
CreateUnionResponse |
createUnion(CreateUnionRequest request)
Performs a union (concatenation) of one or more existing tables
or views, the results of which are stored in a new view.
|
CreateUnionResponse |
createUnion(String tableName,
List<String> tableNames,
List<List<String>> inputColumnNames,
List<String> outputColumnNames,
Map<String,String> options)
Performs a union (concatenation) of one or more existing tables
or views, the results of which are stored in a new view.
|
CreateUserExternalResponse |
createUserExternal(CreateUserExternalRequest request)
Creates a new external user (a user whose credentials are managed by an
external LDAP).
|
CreateUserExternalResponse |
createUserExternal(String name,
Map<String,String> options)
Creates a new external user (a user whose credentials are managed by an
external LDAP).
|
CreateUserInternalResponse |
createUserInternal(CreateUserInternalRequest request)
Creates a new internal user (a user whose credentials are managed by the
database system).
|
CreateUserInternalResponse |
createUserInternal(String name,
String password,
Map<String,String> options)
Creates a new internal user (a user whose credentials are managed by the
database system).
|
DeleteProcResponse |
deleteProc(DeleteProcRequest request)
Deletes a proc.
|
DeleteProcResponse |
deleteProc(String procName,
Map<String,String> options)
Deletes a proc.
|
DeleteRecordsResponse |
deleteRecords(DeleteRecordsRequest request)
Deletes record(s) matching the provided criteria from the given table.
|
DeleteRecordsResponse |
deleteRecords(String tableName,
List<String> expressions,
Map<String,String> options)
Deletes record(s) matching the provided criteria from the given table.
|
DeleteRoleResponse |
deleteRole(DeleteRoleRequest request)
Deletes an existing role.
|
DeleteRoleResponse |
deleteRole(String name,
Map<String,String> options)
Deletes an existing role.
|
DeleteUserResponse |
deleteUser(DeleteUserRequest request)
Deletes an existing user.
|
DeleteUserResponse |
deleteUser(String name,
Map<String,String> options)
Deletes an existing user.
|
ExecuteProcResponse |
executeProc(ExecuteProcRequest request)
Executes a proc.
|
ExecuteProcResponse |
executeProc(String procName,
Map<String,String> params,
Map<String,ByteBuffer> binParams,
List<String> inputTableNames,
Map<String,List<String>> inputColumnNames,
List<String> outputTableNames,
Map<String,String> options)
Executes a proc.
|
FilterResponse |
filter(FilterRequest request)
Filters data based on the specified expression.
|
FilterResponse |
filter(String tableName,
String viewName,
String expression,
Map<String,String> options)
Filters data based on the specified expression.
|
FilterByAreaResponse |
filterByArea(FilterByAreaRequest request)
Calculates which objects from a table are within a named area of
interest (NAI/polygon).
|
FilterByAreaResponse |
filterByArea(String tableName,
String viewName,
String xColumnName,
List<Double> xVector,
String yColumnName,
List<Double> yVector,
Map<String,String> options)
Calculates which objects from a table are within a named area of
interest (NAI/polygon).
|
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.
|
HasProcResponse |
hasProc(HasProcRequest request)
Checks the existence of a proc with the given name.
|
HasProcResponse |
hasProc(String procName,
Map<String,String> options)
Checks the existence of a proc with the given name.
|
HasTableResponse |
hasTable(HasTableRequest request)
Checks for the existence of a table with the given name.
|
HasTableResponse |
hasTable(String tableName,
Map<String,String> options)
Checks for the existence of a table with the given name.
|
HasTypeResponse |
hasType(HasTypeRequest request)
Check for the existence of a type.
|
HasTypeResponse |
hasType(String typeId,
Map<String,String> options)
Check for the existence of a type.
|
<TRequest> InsertRecordsResponse |
insertRecords(InsertRecordsRequest<TRequest> request)
Adds multiple records to the specified table.
|
<TRequest> InsertRecordsResponse |
insertRecords(String tableName,
List<TRequest> data,
Map<String,String> options)
Adds multiple records to the specified table.
|
<TRequest> InsertRecordsResponse |
insertRecords(TypeObjectMap<TRequest> typeObjectMap,
InsertRecordsRequest<TRequest> request)
Adds multiple records to the specified table.
|
<TRequest> InsertRecordsResponse |
insertRecords(TypeObjectMap<TRequest> typeObjectMap,
String tableName,
List<TRequest> data,
Map<String,String> options)
Adds multiple records to the specified table.
|
InsertRecordsRandomResponse |
insertRecordsRandom(InsertRecordsRandomRequest request)
Generates a specified number of random records and adds them to the
given table.
|
InsertRecordsRandomResponse |
insertRecordsRandom(String tableName,
long count,
Map<String,Map<String,Double>> options)
Generates a specified number of random records and adds them to the
given table.
|
InsertRecordsResponse |
insertRecordsRaw(RawInsertRecordsRequest request)
Adds multiple records to the specified table.
|
InsertSymbolResponse |
insertSymbol(InsertSymbolRequest request)
Adds a symbol or icon (i.e.
|
InsertSymbolResponse |
insertSymbol(String symbolId,
String symbolFormat,
ByteBuffer symbolData,
Map<String,String> options)
Adds a symbol or icon (i.e.
|
KillProcResponse |
killProc(KillProcRequest request)
Kills a running proc instance.
|
KillProcResponse |
killProc(String runId,
Map<String,String> options)
Kills a running proc instance.
|
LockTableResponse |
lockTable(LockTableRequest request)
Manages global access to a table's data.
|
LockTableResponse |
lockTable(String tableName,
String lockType,
Map<String,String> options)
Manages global access to a table's data.
|
RevokePermissionSystemResponse |
revokePermissionSystem(RevokePermissionSystemRequest request)
Revokes a system-level permission from a user or role.
|
RevokePermissionSystemResponse |
revokePermissionSystem(String name,
String permission,
Map<String,String> options)
Revokes a system-level permission from a user or role.
|
RevokePermissionTableResponse |
revokePermissionTable(RevokePermissionTableRequest request)
Revokes a table-level permission from a user or role.
|
RevokePermissionTableResponse |
revokePermissionTable(String name,
String permission,
String tableName,
Map<String,String> options)
Revokes a table-level permission from a user or role.
|
RevokeRoleResponse |
revokeRole(RevokeRoleRequest request)
Revokes membership in a role from a user or role.
|
RevokeRoleResponse |
revokeRole(String role,
String member,
Map<String,String> options)
Revokes membership in a role from a user or role.
|
ShowProcResponse |
showProc(ShowProcRequest request)
Shows information about a proc.
|
ShowProcResponse |
showProc(String procName,
Map<String,String> options)
Shows information about a proc.
|
ShowProcStatusResponse |
showProcStatus(ShowProcStatusRequest request)
Shows the statuses of running or completed proc instances.
|
ShowProcStatusResponse |
showProcStatus(String runId,
Map<String,String> options)
Shows the statuses of running or completed proc instances.
|
ShowSecurityResponse |
showSecurity(List<String> names,
Map<String,String> options)
Shows security information relating to users and/or roles.
|
ShowSecurityResponse |
showSecurity(ShowSecurityRequest request)
Shows security information relating to users and/or roles.
|
ShowSystemPropertiesResponse |
showSystemProperties(Map<String,String> options)
Returns server configuration and version related information to the
caller.
|
ShowSystemPropertiesResponse |
showSystemProperties(ShowSystemPropertiesRequest request)
Returns server configuration and version related information to the
caller.
|
ShowSystemStatusResponse |
showSystemStatus(Map<String,String> options)
Provides server configuration and health related status to the caller.
|
ShowSystemStatusResponse |
showSystemStatus(ShowSystemStatusRequest request)
Provides server configuration and health related status to the caller.
|
ShowSystemTimingResponse |
showSystemTiming(Map<String,String> options)
Returns the last 100 database requests along with the request timing and
internal job id.
|
ShowSystemTimingResponse |
showSystemTiming(ShowSystemTimingRequest request)
Returns the last 100 database requests along with the request timing and
internal job id.
|
ShowTableResponse |
showTable(ShowTableRequest request)
Retrieves detailed information about a table, view, or collection,
specified in
tableName . |
ShowTableResponse |
showTable(String tableName,
Map<String,String> options)
Retrieves detailed information about a table, view, or collection,
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 whose type matches the given criteria.
|
ShowTablesByTypeResponse |
showTablesByType(String typeId,
String label,
Map<String,String> options)
Gets names of the tables whose type matches the given criteria.
|
ShowTriggersResponse |
showTriggers(List<String> triggerIds,
Map<String,String> options)
Retrieves information regarding the specified triggers or all existing
triggers currently active.
|
ShowTriggersResponse |
showTriggers(ShowTriggersRequest request)
Retrieves information regarding the specified triggers or all existing
triggers currently active.
|
ShowTypesResponse |
showTypes(ShowTypesRequest request)
Retrieves information for the specified data type.
|
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, getURLs, 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(List<URL> urls) throws GPUdbException
GPUdb
instance for the GPUdb server with the
specified URLs using default options. At any given time, one
URL (initially selected at random from the list) will be active
and used for all GPUdb calls, but in the event of failure, the
other URLs will be tried in order, and if a working one is found
it will become the new active URL. Note that the default options
cannot be changed subsequently; to use different options, a new
GPUdb
instance must be created.urls
- The URLs 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 GPUdb(List<URL> urls, GPUdbBase.Options options) throws GPUdbException
GPUdb
instance for the GPUdb server with the
specified URLs using the specified options. At any given time,
one URL (initially selected at random from the list) will be active
and used for all GPUdb calls, but in the event of failure, the
other URLs will be tried in order, and if a working one is found
it will become the new active URL. Note that the specified options
cannot be changed subsequently; to use different options, a new
GPUdb
instance must be created.urls
- The URLs 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.
Supported values:
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 an existing table. 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
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset
and limit
parameters. For example, to get 10 groups with the largest counts the
inputs would be: limit=10, options={"sort_order":"descending",
"sort_by":"value"}.
options
can be used to customize behavior of this call e.g.
filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column
names must adhere to standard naming conventions; column/aggregation
expressions will need to be aliased. If the source table's shard
key is used as the grouping column(s), the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available when any of the values of columnNames
is an
unrestricted-length string.
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
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset
and limit
parameters. For example, to get 10 groups with the largest counts the
inputs would be: limit=10, options={"sort_order":"descending",
"sort_by":"value"}.
options
can be used to customize behavior of this call e.g.
filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column
names must adhere to standard naming conventions; column/aggregation
expressions will need to be aliased. If the source table's shard
key is used as the grouping column(s), the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available when any of the values of columnNames
is an
unrestricted-length string.
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
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset
and limit
parameters. For example, to get 10 groups with the largest counts the
inputs would be: limit=10, options={"sort_order":"descending",
"sort_by":"value"}.
options
can be used to customize behavior of this call e.g.
filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column
names must adhere to standard naming conventions; column/aggregation
expressions will need to be aliased. If the source table's shard
key is used as the grouping column(s), the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available when any of the values of columnNames
is an
unrestricted-length string.
tableName
- Name of the table on which the operation will be
performed. Must be an existing table/view/collection.columnNames
- List of one or more column names, expressions, and
aggregate expressions. 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.
COLLECTION_NAME
: Name of a collection which is to
contain the table specified in result_table
,
otherwise the table will be a top-level table. If the
collection does not allow duplicate types and it
contains a table of the same type as the given one, then
this table creation request will fail. Additionally this
option is invalid if tableName
is a collection.
EXPRESSION
: Filter expression to apply to the table
prior to computing the aggregate group by.
HAVING
: Filter expression to apply to the aggregated
results.
SORT_ORDER
: String indicating how the returned values
should be sorted - ascending or descending.
Supported values:
ASCENDING
: Indicates that the returned values should be
sorted in ascending order.
DESCENDING
: Indicates that the returned values should
be sorted in descending order.
ASCENDING
.
SORT_BY
: String determining how the results are sorted.
Supported values:
KEY
: Indicates that the returned values should be
sorted by key, which corresponds to the grouping
columns. If you have multiple grouping columns (and are
sorting by key), it will first sort the first grouping
column, then the second grouping column, etc.
VALUE
: Indicates that the returned values should be
sorted by value, which corresponds to the aggregates. If
you have multiple aggregates (and are sorting by value),
it will first sort by the first aggregate, then the
second aggregate, etc.
KEY
.
RESULT_TABLE
: The name of the table used to store the
results. Has the same naming restrictions as tables. Column names (group-by and
aggregate fields) need to be given aliases e.g.
["FChar256 as fchar256", "sum(FDouble) as sfd"]. If
present, no results are returned in the response. This
option is not available if one of the grouping
attributes is an unrestricted string (i.e.; not charN)
type.
RESULT_TABLE_PERSIST
: If true
then the result
table specified in result_table
will be
persisted as a regular table (it will not be
automatically cleared unless a ttl
is provided,
and the table data can be modified in subsequent
operations). If false
then the result table will
be a read-only, memory-only temporary table.
Supported values:
The default value is FALSE
.
TTL
: Sets the TTL of the table specified in result_table
. The value must be the desired TTL in
minutes.
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 an existing table or collection.columnName
- Name of a column or an expression of one or more
column names over which the histogram will be
calculated.start
- Lower end value of the histogram interval, inclusive.end
- Upper end value of the histogram interval, inclusive.interval
- The size of each bin within the start and end
parameters.options
- Optional parameters.
VALUE_COLUMN
: The name of the column to use when
calculating the bin values (values are summed). The
column must be a numerical type (int, double, long,
float).
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 an existing table or collection.columnNames
- List of column names on which the operation would be
performed. If n columns are provided then each of
the k result points will have n dimensions
corresponding to the n columns.k
- The number of mean points to be determined by the algorithm.tolerance
- Stop iterating when the distances between successive
points is less than the given tolerance.options
- Optional parameters.
WHITEN
: When set to 1 each of the columns is first
normalized by its stdv - default is not to whiten.
MAX_ITERS
: Number of times to try to hit the tolerance
limit before giving up - default is 10.
NUM_TRIES
: Number of times to run the k-means algorithm
with a different randomly selected starting points -
helps avoid local minimum. Default is 1.
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 an existing table.columnName
- Name of a column or an expression of one or more
column on which the min-max will be calculated.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AggregateMinMaxResponse
public AggregateStatisticsResponse aggregateStatistics(AggregateStatisticsRequest request) throws GPUdbException
The available statistics are count
(number of total objects),
mean
, stdv
(standard deviation), variance
,
skew
, kurtosis
, sum
, min
, max
,
weighted_average
, cardinality
(unique count), estimated_cardinality
, percentile
and percentile_rank
.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated
using the t-digest algorithm. They must include the desired percentile
/percentile_rank
. To compute multiple percentiles
each value must be specified separately (i.e.
'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
The weighted average statistic requires a weight_column_name
to
be specified in options
. The weighted average is then defined as
the sum of the products of columnName
times the weight_column_name
values divided by the sum of the weight_column_name
values.
Additional columns can be used in the calculation of statistics via the
additional_column_names
option. Values in these columns will be
included in the overall aggregate calculation--individual aggregates
will not be calculated per additional column. For instance, requesting
the count
& mean
of columnName
x and additional_column_names
y & z, where x holds the numbers 1-10, y holds
11-20, and z holds 21-30, would return the total number of x, y, & z
values (30), and the single average value across all x, y, & z values
(15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
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
The available statistics are count
(number of total objects),
mean
, stdv
(standard deviation), variance
,
skew
, kurtosis
, sum
, min
, max
,
weighted_average
, cardinality
(unique count), estimated_cardinality
, percentile
and percentile_rank
.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated
using the t-digest algorithm. They must include the desired percentile
/percentile_rank
. To compute multiple percentiles
each value must be specified separately (i.e.
'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
The weighted average statistic requires a weight_column_name
to
be specified in options
. The weighted average is then defined as
the sum of the products of columnName
times the weight_column_name
values divided by the sum of the weight_column_name
values.
Additional columns can be used in the calculation of statistics via the
additional_column_names
option. Values in these columns will be
included in the overall aggregate calculation--individual aggregates
will not be calculated per additional column. For instance, requesting
the count
& mean
of columnName
x and additional_column_names
y & z, where x holds the numbers 1-10, y holds
11-20, and z holds 21-30, would return the total number of x, y, & z
values (30), and the single average value across all x, y, & z values
(15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
tableName
- Name of the table on which the statistics operation
will be performed.columnName
- Name of the primary column for which the statistics
are to be calculated.stats
- Comma separated list of the statistics to calculate, e.g.
"sum,mean".
Supported values:
COUNT
: Number of objects (independent of the given
column(s)).
MEAN
: Arithmetic mean (average), equivalent to sum/count.
STDV
: Sample standard deviation (denominator is count-1).
VARIANCE
: Unbiased sample variance (denominator is
count-1).
SKEW
: Skewness (third standardized moment).
KURTOSIS
: Kurtosis (fourth standardized moment).
SUM
: Sum of all values in the column(s).
MIN
: Minimum value of the column(s).
MAX
: Maximum value of the column(s).
WEIGHTED_AVERAGE
: Weighted arithmetic mean (using the
option weight_column_name
as the weighting
column).
CARDINALITY
: Number of unique values in the column(s).
ESTIMATED_CARDINALITY
: Estimate (via hyperloglog
technique) of the number of unique values in the
column(s).
PERCENTILE
: Estimate (via t-digest) of the given
percentile of the column(s) (percentile(50.0) will be an
approximation of the median).
PERCENTILE_RANK
: Estimate (via t-digest) of the
percentile rank of the given value in the column(s) (if
the given value is the median of the column(s),
percentile_rank(options
- Optional parameters.
ADDITIONAL_COLUMN_NAMES
: A list of comma separated
column names over which statistics can be accumulated
along with the primary column. All columns listed and
columnName
must be of the same type. Must not
include the column specified in columnName
and
no column can be listed twice.
WEIGHT_COLUMN_NAME
: Name of column used as weighting
attribute for the weighted average statistic.
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.
There are two methods for binning the set members. In the first, which
can be used for numeric valued binning-columns, a min, max and interval
are specified. The number of bins, nbins, is the integer upper bound of
(max-min)/interval. Values that fall in the range
[min+n\*interval,min+(n+1)\*interval) are placed in the nth bin where n
ranges from 0..nbin-2. The final bin is [min+(nbin-1)\*interval,max]. In
the second method, options
bin_values specifies a list of
binning column values. Binning-columns whose value matches the nth
member of the bin_values list are placed in the nth bin. When a list is
provided the binning-column must be of type string or int.
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.
There are two methods for binning the set members. In the first, which
can be used for numeric valued binning-columns, a min, max and interval
are specified. The number of bins, nbins, is the integer upper bound of
(max-min)/interval. Values that fall in the range
[min+n\*interval,min+(n+1)\*interval) are placed in the nth bin where n
ranges from 0..nbin-2. The final bin is [min+(nbin-1)\*interval,max]. In
the second method, options
bin_values specifies a list of
binning column values. Binning-columns whose value matches the nth
member of the bin_values list are placed in the nth bin. When a list is
provided the binning-column must be of type string or int.
tableName
- Name of the table on which the ranged-statistics
operation will be performed.selectExpression
- For a non-empty expression statistics are
calculated for those records for which the
expression is true.columnName
- Name of the binning-column used to divide the set
samples into bins.valueColumnName
- Name of the value-column for which statistics
are to be computed.stats
- A string of comma separated list of the statistics to
calculate, e.g. 'sum,mean'. Available statistics: mean,
stdv (standard deviation), variance, skew, kurtosis, sum.start
- The lower bound of the binning-column.end
- The upper bound of the binning-column.interval
- The interval of a bin. Set members fall into bin i if
the binning-column falls in the range
[start+interval``*``i, start+interval``*``(i+1)).options
- Map of optional parameters:
ADDITIONAL_COLUMN_NAMES
: A list of comma separated
value-column names over which statistics can be
accumulated along with the primary value_column.
BIN_VALUES
: A list of comma separated binning-column
values. Values that match the nth bin_values value are
placed in the nth bin.
WEIGHT_COLUMN_NAME
: Name of the column used as
weighting column for the weighted_average statistic.
ORDER_COLUMN_NAME
: Name of the column used for
candlestick charting techniques.
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
. The
results can be paged via the offset
and limit
parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options
would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column name
must adhere to standard naming conventions; any column expression
will need to be aliased. If the source table's shard
key is used as the columnName
, the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available when the value of columnName
is an
unrestricted-length string.
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
. The
results can be paged via the offset
and limit
parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options
would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column name
must adhere to standard naming conventions; any column expression
will need to be aliased. If the source table's shard
key is used as the columnName
, the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available when the value of columnName
is an
unrestricted-length string.
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
. The
results can be paged via the offset
and limit
parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options
would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column name
must adhere to standard naming conventions; any column expression
will need to be aliased. If the source table's shard
key is used as the columnName
, the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available when the value of columnName
is an
unrestricted-length string.
tableName
- Name of the table on which the operation will be
performed. Must be an existing table.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.
COLLECTION_NAME
: Name of a collection which is to
contain the table specified in 'result_table', otherwise
the table will be a top-level table. If the collection
does not allow duplicate types and it contains a table
of the same type as the given one, then this table
creation request will fail.
EXPRESSION
: Optional filter expression to apply to the
table.
SORT_ORDER
: String indicating how the returned values
should be sorted.
Supported values:
The default value is ASCENDING
.
RESULT_TABLE
: The name of the table used to store the
results. If present, no results are returned in the
response. Has the same naming restrictions as tables.
RESULT_TABLE_PERSIST
: If true
then the result
table specified in result_table
will be
persisted as a regular table (it will not be
automatically cleared unless a ttl
is provided,
and the table data can be modified in subsequent
operations). If false
(the default) then the
result table will be a read-only, memory-only temporary
table.
Supported values:
The default value is FALSE
.
TTL
: Sets the TTL of the table specified in
'result_table'. The value must be the desired TTL in
minutes.
GPUdbException
- if an error occurs during the operation.AggregateUniqueResponse
public AlterSystemPropertiesResponse alterSystemProperties(AlterSystemPropertiesRequest request) throws GPUdbException
alterSystemProperties(AlterSystemPropertiesRequest)
endpoint is primarily used to simplify the testing of the system and is
not expected to be used during normal execution. Commands are given
through the propertyUpdatesMap
whose keys are commands and
values are strings representing integer values (for example '8000') or
boolean values ('true' or 'false').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
alterSystemProperties(Map, Map)
endpoint is primarily
used to simplify the testing of the system and is not expected to be
used during normal execution. Commands are given through the propertyUpdatesMap
whose keys are commands and values are strings
representing integer values (for example '8000') or boolean values
('true' or 'false').propertyUpdatesMap
- Map containing the properties of the system
to be updated. Error if empty.
SM_OMP_THREADS
: Set the number of OpenMP
threads that will be used to service filter &
aggregation requests against collections to
the specified integer value.
KERNEL_OMP_THREADS
: Set the number of kernel
OpenMP threads to the specified integer
value.
CONCURRENT_KERNEL_EXECUTION
: Enables
concurrent kernel execution if the value is
true
and disables it if the value is
false
.
Supported values:
CHUNK_SIZE
: Sets the chunk size of all new
sets to the specified integer value.
FLUSH_TO_DISK
: Flushes any changes to any
tables to the persistent store. These
changes include updates to the vector store,
object store, and text search store, Value
string is ignored
CLEAR_CACHE
: Clears cached results. Useful
to allow repeated timing of endpoints. Value
string is ignored
COMMUNICATOR_TEST
: Invoke the communicator
test and report timing results. Value string
is is a comma separated list of SET_MESSAGE_TIMERS_ENABLED
: Enables the
communicator test to collect additional
timing statistics when the value string is
true
. Disables the collection when
the value string is false
Supported values:
BULK_ADD_TEST
: Invoke the bulk add test and
report timing results. Value string is
ignored.
NETWORK_SPEED
: Invoke the network speed test
and report timing results. Value string is a
semicolon-separated list of options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AlterSystemPropertiesResponse
public AlterTableResponse alterTable(AlterTableRequest request) throws GPUdbException
Creating or deleting an index on a particular column. This can
speed up certain search queries (such as getRecordsRaw(GetRecordsRequest)
, deleteRecords(DeleteRecordsRequest)
, updateRecordsRaw(RawUpdateRecordsRequest)
) when using expressions
containing equality or relational operators on indexed columns. This
only applies to tables.
Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.
Making a table protected or not. Protected tables have their TTLs set to not automatically expire. This can be applied to tables, views, and collections.
Allowing homogeneous tables within a collection. Managing a table's columns--a column can be added or removed, or have its type modified.
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
Creating or deleting an index on a particular column. This can
speed up certain search queries (such as getRecordsRaw(GetRecordsRequest)
, deleteRecords(String, List, Map)
, updateRecordsRaw(RawUpdateRecordsRequest)
) when using expressions
containing equality or relational operators on indexed columns. This
only applies to tables.
Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.
Making a table protected or not. Protected tables have their TTLs set to not automatically expire. This can be applied to tables, views, and collections.
Allowing homogeneous tables within a collection. Managing a table's columns--a column can be added or removed, or have its type modified.
tableName
- Table on which the operation will be performed. Must
be an existing table, view, or collection.action
- Modification operation to be applied
Supported values:
CREATE_INDEX
: Creates an index on the column name
specified in value
. If this column is already
indexed, an error will be returned.
DELETE_INDEX
: Deletes an existing index on the column
name specified in value
. If this column does not
have indexing turned on, an error will be returned.
ALLOW_HOMOGENEOUS_TABLES
: Sets whether homogeneous
tables are allowed in the given collection. This action
is only valid if tableName
is a collection. The
value
must be either 'true' or 'false'.
PROTECTED
: Sets whether the given tableName
should be protected or not. The value
must be
either 'true' or 'false'.
TTL
:
Sets the TTL of the table, view, or collection specified
in tableName
. The value
must be the
desired TTL in minutes.
ADD_COLUMN
: Add a column value
to the table. set
the column properties in options
DELETE_COLUMN
: Delete a column value
from the
table
CHANGE_COLUMN
: Change properties of a column value
in the table. set the column properties in options
RENAME_TABLE
: Rename a table, view or collection to
value
. Has the same naming restrictions as tables.
value
- The value of the modification. May be a column name,
'true' or 'false', or a TTL depending on action
.options
- Optional parameters.
COLUMN_DEFAULT_VALUE
: when adding a column: set a
default value, for existing data.
COLUMN_PROPERTIES
: when adding or changing a column:
set the column properties (strings, separated by a
comma: data, store_only, text_search, char8, int8 etc).
COLUMN_TYPE
: when adding or changing a column: set the
column type (strings, separated by a comma: int, double,
string, null etc).
VALIDATE_CHANGE_COLUMN
: Validate the type change before
applying column_change request. Default is true
(if option is missing). If true
, then validate
all values. A value too large (or too long) for the new
type will prevent any change. If false
, then
when a value is too large or long, it will be truncated.
Supported values:
The default value is TRUE
.
COPY_VALUES_FROM_COLUMN
: when adding or changing a
column: enter column name - from where to copy values.
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, or an error will be
returned.metadataMap
- A map which contains the metadata of the tables that
are to be updated. Note that only one map is
provided for all the tables; so the change will be
applied to every table. If the provided map is
empty, then all existing metadata for the table(s)
will be cleared.options
- Optional parameters.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.
Supported values:
SET_PASSWORD
: Sets the password of the user. The user
must be an internal user.
value
- The value of the modification, depending on action
.options
- Optional parameters.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
table. Empty string clears all available tables.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> columnNames, List<String> expressions, Map<String,String> options) throws GPUdbException
joinTableName
- Name of the join table to be created. Has the
same naming restrictions as tables.tableNames
- The list of table names composing the join.
Corresponds to a SQL statement FROM clausecolumnNames
- List of member table columns or column expressions
to be included in the join. Columns can be prefixed
with 'table_id.column_name', where 'table_id' is the
table name or alias. Columns can be aliased via the
syntax 'column_name as alias'. Wild cards '*' can be
used to include all columns across member tables or
'table_id.*' for all of a single table's columns.
Columns and column expressions comprising the join
must be uniquely named or aliased--therefore, the
'*' wild card cannot be used if column names aren't
unique across all tables.expressions
- An optional list of expressions to combine and
filter the joined tables. Corresponds to a SQL
statement WHERE clause. For details see: expressions.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the join. If the collection provided is
non-existent, the collection will be automatically
created. If empty, then the join will be at the top
level.
MAX_QUERY_DIMENSIONS
: The maximum number of tables in a
join that can be accessed by a query and are not equated
by a foreign-key to primary-key equality predicate
OPTIMIZE_LOOKUPS
: Use more memory to speed up the
joining of tables.
Supported values:
The default value is FALSE
.
REFRESH_METHOD
: Method by which the join can be
refreshed when the data in underlying member tables have
changed.
Supported values:
MANUAL
: refresh only occurs when manually requested by
calling this endpoint with refresh option set to refresh
or full_refresh
ON_QUERY
: incrementally refresh (refresh just those
records added) whenever a new query is issued and new
data is inserted into the base table. A full refresh of
all the records occurs when a new query is issued and
there have been inserts to any non-base-tables since the
last query
ON_INSERT
: incrementally refresh (refresh just those
records added) whenever new data is inserted into a base
table. A full refresh of all the records occurs when a
new query is issued and there have been inserts to any
non-base-tables since the last query
MANUAL
.
REFRESH
: Do a manual refresh of the join if it exists -
throws an error otherwise
Supported values:
NO_REFRESH
: don't refresh
REFRESH
: incrementally refresh (refresh just those
records added) if new data has been inserted into the
base table. A full refresh of all the records occurs if
there have been inserts to any non-base-tables since the
last refresh
FULL_REFRESH
: always refresh even if no new records
have been added. Only refresh method guaranteed to do a
full refresh (refresh all the records) if a delete or
update has occurred since the last refresh.
NO_REFRESH
.
TTL
: Sets the TTL of the table specified in joinTableName
. The value must be the desired TTL in
minutes.
GPUdbException
- if an error occurs during the operation.CreateJoinTableResponse
public CreateProcResponse createProc(CreateProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.CreateProcResponse
public CreateProcResponse createProc(String procName, String executionMode, Map<String,ByteBuffer> files, String command, List<String> args, Map<String,String> options) throws GPUdbException
procName
- Name of the proc to be created. Must not be the name of
a currently existing proc.executionMode
- The execution mode of the proc.
Supported values:
DISTRIBUTED
: Input table data will be divided
into data segments that are distributed across all
nodes in the cluster, and the proc command will be
invoked once per data segment in parallel. Output
table data from each invocation will be saved to
the same node as the corresponding input data.
NONDISTRIBUTED
: The proc command will be invoked
only once per execution, and will not have access
to any input or output table data.
DISTRIBUTED
.files
- A map of the files that make up the proc. The keys of the
map are file names, and the values are the binary contents
of the files. The file names may include subdirectory
names (e.g. 'subdir/file') but must not resolve to a
directory above the root for the proc.command
- The command (excluding arguments) that will be invoked
when the proc is executed. It will be invoked from the
directory containing the proc files
and may be
any command that can be resolved from that directory. It
need not refer to a file actually in that directory; for
example, it could be 'java' if the proc is a Java
application; however, any necessary external programs
must be preinstalled on every database node. If the
command refers to a file in that directory, it must be
preceded with './' as per Linux convention. If not
specified, and exactly one file is provided in files
, that file will be invoked.args
- An array of command-line arguments that will be passed to
command
when the proc is executed.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateProcResponse
public CreateProjectionResponse createProjection(CreateProjectionRequest request) throws GPUdbException
Notes:
A moving average can be calculated on a given column using the following
syntax in the columnNames
parameter:
'moving_average(column_name,num_points_before,num_points_after) as new_column_name'
For each record in the moving_average function's 'column_name' parameter, it computes the average over the previous 'num_points_before' records and the subsequent 'num_points_after' records.
Note that moving average relies on order_by
, and order_by
requires that all the data being ordered resides on the same
processing node, so it won't make sense to use order_by
without
moving average.
Also, a projection can be created with a different shard
key than the source table. By specifying shard_key
, the
projection will be sharded according to the specified columns,
regardless of how the source table is sharded. The source table can
even be unsharded or replicated.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.CreateProjectionResponse
public CreateProjectionResponse createProjection(String tableName, String projectionName, List<String> columnNames, Map<String,String> options) throws GPUdbException
Notes:
A moving average can be calculated on a given column using the following
syntax in the columnNames
parameter:
'moving_average(column_name,num_points_before,num_points_after) as new_column_name'
For each record in the moving_average function's 'column_name' parameter, it computes the average over the previous 'num_points_before' records and the subsequent 'num_points_after' records.
Note that moving average relies on order_by
, and order_by
requires that all the data being ordered resides on the same
processing node, so it won't make sense to use order_by
without
moving average.
Also, a projection can be created with a different shard
key than the source table. By specifying shard_key
, the
projection will be sharded according to the specified columns,
regardless of how the source table is sharded. The source table can
even be unsharded or replicated.
tableName
- Name of the existing table on which the projection is
to be applied.projectionName
- Name of the projection to be created. Has the
same naming restrictions as tables.columnNames
- List of columns from tableName
to be
included in the projection. Can include derived
columns. Can be specified as aliased via the syntax
'column_name as alias'.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection to which the projection is
to be assigned as a child. If the collection provided is
non-existent, the collection will be automatically
created.
EXPRESSION
: An optional filter expression to be applied to the source
table prior to the projection.
LIMIT
: The number of records to keep.
ORDER_BY
: Comma-separated list of the columns to be
sorted by; e.g. 'timestamp asc, x desc'. The columns
specified must be present in columnNames
. If
any alias is given for any column name, the alias must
be used, rather than the original column name.
MATERIALIZE_ON_GPU
: If true
then the columns of
the projection will be cached on the GPU.
Supported values:
The default value is FALSE
.
TTL
: Sets the TTL of the table, view, or collection
specified in projectionName
. The value must be
the desired TTL in minutes.
SHARD_KEY
: Comma-separated list of the columns to be
sharded on; e.g. 'column1, column2'. The columns
specified must be present in columnNames
. If
any alias is given for any column name, the alias must
be used, rather than the original column name.
PERSIST
: If true
then the projection will be
persisted as a regular table (it will not be
automatically cleared unless a ttl
is provided,
and the table data can be modified in subsequent
operations). If false
then the projection will
be a read-only, memory-only temporary table.
Supported values:
The default value is FALSE
.
GPUdbException
- if an error occurs during the operation.CreateProjectionResponse
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.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 ID
of a currently registered type (i.e. one created via createType(CreateTypeRequest)
). The table will be created inside
a collection if the option collection_name
is specified. If that
collection does not already exist, it will be created.
To create a new collection, specify the name of the collection in tableName
and set the is_collection
option to true
;
typeId
will be ignored.
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 ID
of a currently registered type (i.e. one created via createType(String, String, Map, Map)
). The table will be created
inside a collection if the option collection_name
is specified.
If that collection does not already exist, it will be created.
To create a new collection, specify the name of the collection in tableName
and set the is_collection
option to true
;
typeId
will be ignored.
tableName
- Name of the table to be created. Error for requests
with existing table of the same name and type id may
be suppressed by using the no_error_if_exists
option. See Tables for naming restrictions.typeId
- ID of a currently registered type. All objects added to
the newly created table will be of this type. Ignored if
is_collection
is true
.options
- Optional parameters.
NO_ERROR_IF_EXISTS
: If true
, prevents an error
from occurring if the table already exists and is of the
given type. If a table with the same ID but a different
type exists, it is still an error.
Supported values:
The default value is FALSE
.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created table. If empty, then the
newly created table will be a top-level table. If the
collection does not allow duplicate types and it
contains a table of the same type as the given one, then
this table creation request will fail.
IS_COLLECTION
: Indicates whether the new table to be
created will be a collection.
Supported values:
The default value is FALSE
.
DISALLOW_HOMOGENEOUS_TABLES
: For a collection,
indicates whether the collection prohibits containment
of multiple tables of exactly the same data type.
Supported values:
The default value is FALSE
.
IS_REPLICATED
: For a table, indicates whether the table
is to be replicated to all the database ranks. This may
be necessary when the table is to be joined with other
tables in a query.
Supported values:
The default value is FALSE
.
FOREIGN_KEYS
: Semicolon-separated list of foreign keys,
of the format 'source_column references
target_table(primary_key_column)'.
FOREIGN_SHARD_KEY
: Foreign shard key of the format
'source_column references shard_by_column from
target_table(primary_key_column)'
TTL
:
Sets the TTL of the table or collection specified in
tableName
. The value must be the desired TTL in
minutes.
IS_RESULT_TABLE
: For a table, indicates whether the
table is a non-persistent, memory-only table that will
store the output of a proc executed with executeProc(String, Map, Map, List, Map, List,
Map)
. A result table cannot contain store_only,
text_search, or string columns (char columns are
acceptable), records cannot be inserted into it
directly, and it will not be retained if the server is
restarted.
Supported values:
The default value is 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 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 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 the trigger port (by default
'9001', but able to be retrieved via showSystemStatus(ShowSystemStatusRequest)
) for any listening
client to collect. Active triggers can be cancelled by using the clearTrigger(ClearTriggerRequest)
endpoint or by clearing all
relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
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 the trigger port (by default
'9001', but able to be retrieved via showSystemStatus(Map)
) for any listening client to collect.
Active triggers can be cancelled by using the clearTrigger(String, Map)
endpoint or by clearing all relevant
tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
requestId
- User-created ID for the trigger. The ID can be
alphanumeric, contain symbols, and must contain at
least one character.tableNames
- Names of the tables on which the trigger will be
activated and maintained.xColumnName
- Name of a numeric column on which the trigger is
activated. Usually 'x' for geospatial data points.xVector
- The respective coordinate values for the region on which
the trigger is activated. This usually translates to the
x-coordinates of a geospatial region.yColumnName
- Name of a second numeric column on which the trigger
is activated. Usually 'y' for geospatial data
points.yVector
- The respective coordinate values for the region on which
the trigger is activated. This usually translates to the
y-coordinates of a geospatial region. Must be the same
length as xvals.options
- Optional parameters.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 the trigger
port (by default '9001', but able to be retrieved via showSystemStatus(ShowSystemStatusRequest)
) for any listening
client to collect. Active triggers can be cancelled by using the clearTrigger(ClearTriggerRequest)
endpoint or by clearing all
relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
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 the trigger
port (by default '9001', but able to be retrieved via showSystemStatus(Map)
) for any listening client to collect.
Active triggers can be cancelled by using the clearTrigger(String, Map)
endpoint or by clearing all relevant
tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
requestId
- User-created ID for the trigger. The ID can be
alphanumeric, contain symbols, and must contain at
least one character.tableNames
- Tables on which the trigger will be active.columnName
- Name of a numeric column_name on which the trigger is
activated.min
- The lower bound (inclusive) for the trigger range.max
- The upper bound (inclusive) for the trigger range.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.CreateTriggerByRangeResponse
public CreateTypeResponse createType(CreateTypeRequest request) throws GPUdbException
data
and store_only
.
To set a *primary key* on one or more columns include the property
'primary_key' on the desired column_names. If a primary key is
specified, then a uniqueness constraint is enforced, in that only a
single object can exist with a given primary key. When inserting
data into a
table with a primary key, depending on the parameters in the request,
incoming objects with primary keys that match existing objects will
either overwrite (i.e. update) the existing object or will be skipped
and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
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
.
To set a *primary key* on one or more columns include the property
'primary_key' on the desired column_names. If a primary key is
specified, then a uniqueness constraint is enforced, in that only a
single object can exist with a given primary key. When inserting
data into a
table with a primary key, depending on the parameters in the request,
incoming objects with primary keys that match existing objects will
either overwrite (i.e. update) the existing object or will be skipped
and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
typeDefinition
- a JSON string describing the columns of the type
to be registered.label
- A user-defined description string which can be used to
differentiate between tables and types with otherwise
identical schemas.properties
- Each key-value pair specifies the properties to use
for a given column where the key is the column name.
All keys used must be relevant column names for the
given table. Specifying any property overrides the
default properties for that column (which is based on
the column's data type).
Valid values are:
DATA
: Default property for all numeric and string
type columns; makes the column available for GPU
queries.
TEXT_SEARCH
: Valid only for 'string' columns.
Enables full text search for string columns. Can be
set independently of *data* and *store_only*.
STORE_ONLY
: Persist the column value but do not make
it available to queries (e.g. filterByBox(String, String, String, double,
double, String, double, double, Map)
)-i.e. it is
mutually exclusive to the 'data' property. Any
'bytes' type column must have a 'store_only'
property. This property reduces system memory usage.
DISK_OPTIMIZED
: Works in conjunction with the 'data'
property for string columns. This property reduces
system disk usage by disabling reverse string
lookups. Queries like filter(String,
String, String, Map)
, filterByList(String, String, Map, Map)
, and
filterByValue(String, String, boolean,
double, String, String, Map)
work as usual but
aggregateUniqueRaw(AggregateUniqueRequest)
,
aggregateGroupByRaw(AggregateGroupByRequest)
and getRecordsByColumnRaw(GetRecordsByColumnRequest)
are not allowed on columns with this property.
TIMESTAMP
: Valid only for 'long' columns. Indicates
that this field represents a timestamp and will be
provided in milliseconds since the Unix epoch:
00:00:00 Jan 1 1970. Dates represented by a
timestamp must fall between the year 1000 and the
year 2900.
DECIMAL
: Valid only for 'string' columns. It
represents a SQL type NUMERIC(19, 4) data type.
There can be up to 15 digits before the decimal point
and up to four digits in the fractional part. The
value can be positive or negative (indicated by a
minus sign at the beginning). This property is
mutually exclusive with the 'text_search' property.
DATE
: Valid only for 'string' columns. Indicates
that this field represents a date and will be
provided in the format 'YYYY-MM-DD'. The allowable
range is 1000-01-01 through 2900-01-01.
TIME
: Valid only for 'string' columns. Indicates
that this field represents a time-of-day and will be
provided in the format 'HH:MM:SS.mmm'. The allowable
range is 00:00:00.000 through 23:59:59.999.
CHAR1
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 1
character. This property cannot be combined with
*text_search*
CHAR2
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 2
characters. This property cannot be combined with
*text_search*
CHAR4
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 4
characters. This property cannot be combined with
*text_search*
CHAR8
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 8
characters. This property cannot be combined with
*text_search*
CHAR16
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 16
characters. This property cannot be combined with
*text_search*
CHAR32
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 32
characters. This property cannot be combined with
*text_search*
CHAR64
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 64
characters. This property cannot be combined with
*text_search*
CHAR128
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 128
characters. This property cannot be combined with
*text_search*
CHAR256
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 256
characters. This property cannot be combined with
*text_search*
INT8
: This property provides optimized memory and
query performance for int columns. Ints with this
property must be between -128 and +127 (inclusive)
INT16
: This property provides optimized memory and
query performance for int columns. Ints with this
property must be between -32768 and +32767
(inclusive)
IPV4
: This property provides optimized memory, disk
and query performance for string columns representing
IPv4 addresses (i.e. 192.168.1.1). Strings with this
property must be of the form: A.B.C.D where A, B, C
and D are in the range of 0-255.
PRIMARY_KEY
: This property indicates that this
column will be part of (or the entire) primary key.
SHARD_KEY
: This property indicates that this column
will be part of (or the entire) shard key.
NULLABLE
: This property indicates that this column
is nullable. However, setting this property is
insufficient for making the column nullable. The
user must declare the type of the column as a union
between its regular type and 'null' in the avro
schema for the record type in typeDefinition
.
For example, if a column is of type integer and is
nullable, then the entry for the column in the avro
schema must be: ['int', 'null'].
The Java and C++ APIs have built-in convenience for
bypassing setting the avro schema by hand. For those
two languages, one can use this property as usual and
not have to worry about the avro schema for the
record.
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. Has the same naming
restrictions as tables.tableNames
- The list of table names making up the union. Must
contain the names of one or more existing tables.inputColumnNames
- The list of columns from each of the
corresponding input tables.outputColumnNames
- The list of names of the columns to be stored
in the union.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the union. If the collection provided is
non-existent, the collection will be automatically
created. If empty, then the union will be a top-level
table.
MATERIALIZE_ON_GPU
: If 'true' then the columns of the
union will be cached on the GPU.
Supported values:
The default value is FALSE
.
MODE
: If 'merge_views' then this operation will merge
(i.e. union) the provided views. All 'table_names' must
be views from the same underlying base table.
Supported values:
UNION_ALL
: Retains all rows from the specified tables.
UNION
: Retains all unique rows from the specified
tables (synonym for 'union_distinct').
UNION_DISTINCT
: Retains all unique rows from the
specified tables.
EXCEPT
: Retains all unique rows from the first table
that do not appear in the second table (only works on 2
tables).
INTERSECT
: Retains all unique rows that appear in both
of the specified tables (only works on 2 tables).
MERGE_VIEWS
: Merge two or more views (or views of
views) of the same base data set into a new view. The
resulting view would match the results of a SQL OR
operation, e.g., if filter 1 creates a view using the
expression 'x = 10' and filter 2 creates a view using
the expression 'x <= 10', then the merge views operation
creates a new view using the expression 'x = 10 OR x <=
10'.
UNION_ALL
.
TTL
:
Sets the TTL of the table specified in tableName
. The value must be the desired TTL in
minutes.
PERSIST
: If true
then the union will be
persisted as a regular table (it will not be
automatically cleared unless a ttl
is provided,
and the table data can be modified in subsequent
operations). If false
then the union will be a
read-only, memory-only temporary table.
Supported values:
The default value is FALSE
.
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.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.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 DeleteProcResponse deleteProc(DeleteProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.DeleteProcResponse
public DeleteProcResponse deleteProc(String procName, Map<String,String> options) throws GPUdbException
procName
- Name of the proc to be deleted. Must be the name of a
currently existing proc.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.DeleteProcResponse
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.
GLOBAL_EXPRESSION
: An optional global expression to
reduce the search space of the expressions
.
RECORD_ID
: A record id identifying a single record,
obtained at the time of insertion of the record
or by calling getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)
with the *return_record_ids* option.
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 procName, Map<String,String> params, Map<String,ByteBuffer> binParams, List<String> inputTableNames, Map<String,List<String>> inputColumnNames, List<String> outputTableNames, Map<String,String> options) throws GPUdbException
procName
- Name of the proc to execute. Must be the name of a
currently existing proc.params
- A map containing named parameters to pass to the proc.
Each key/value pair specifies the name of a parameter and
its value.binParams
- A map containing named binary parameters to pass to
the proc. Each key/value pair specifies the name of a
parameter and its value.inputTableNames
- Names of the tables containing data to be passed
to the proc. Each name specified must be the
name of a currently existing table. If no table
names are specified, no data will be passed to
the proc.inputColumnNames
- Map of table names from inputTableNames
to lists of names of columns from those tables
that will be passed to the proc. Each column
name specified must be the name of an existing
column in the corresponding table. If a table
name from inputTableNames
is not
included, all columns from that table will be
passed to the proc.outputTableNames
- Names of the tables to which output data from
the proc will be written. If a specified table
does not exist, it will automatically be
created with the same schema as the
corresponding table (by order) from inputTableNames
, excluding any primary and
shard keys. If a specified table is a
non-persistent result table, it must not have
primary or shard keys. If no table names are
specified, no output data can be returned from
the proc.options
- Optional parameters.
CACHE_INPUT
: A comma-delimited list of table names from
inputTableNames
from which input data will be
cached for use in subsequent calls to executeProc(String, Map, Map, List, Map, List,
Map)
with the use_cached_input
option. Cached
input data will be retained until the proc status is
cleared with the clear_complete
option of showProcStatus(String, Map)
and all proc
instances using the cached data have completed.
USE_CACHED_INPUT
: A comma-delimited list of run IDs (as
returned from prior calls to executeProc(String, Map, Map, List, Map, List,
Map)
) of running or completed proc instances from which
input data cached using the cache_input
option
will be used. Cached input data will not be used for any
tables specified in inputTableNames
, but data
from all other tables cached for the specified run IDs
will be passed to the proc. If the same table was cached
for multiple specified run IDs, the cached data from the
first run ID specified in the list that includes that
table will be used.
GPUdbException
- if an error occurs during the operation.ExecuteProcResponse
public FilterResponse filter(FilterRequest request) throws GPUdbException
viewName
.
For details see concepts.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
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
.
For details see concepts.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
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. Has the same naming
restrictions as tables.expression
- The select expression to filter the specified table.
For details see concepts.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view, otherwise the view will
be a top-level table. If the collection does not allow
duplicate types and it contains a table of the same type
as the given one, then this table creation request will
fail.
TTL
: Sets
the TTL of the view specified in viewName
. The
value must be the desired TTL in minutes.
GPUdbException
- if an error occurs during the operation.FilterResponse
public FilterByAreaResponse filterByArea(FilterByAreaRequest request) throws GPUdbException
viewName
passed in as
part of the input.
Note that if you call this endpoint using a table that has WKT data, the x_column_name and y_column_name settings are no longer required because the geospatial filter works automatically.
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.
Note that if you call this endpoint using a table that has WKT data, the x_column_name and y_column_name settings are no longer required because the geospatial filter works automatically.
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. Has the same naming
restrictions as tables.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 an existing table.viewName
- Optional name of the result view that will be created
containing the results of the query. Has the same
naming restrictions as tables.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. Has the same naming
restrictions as tables.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
Supported values:
CONTAINS
: Matches records that contain the given WKT
in inputWkt
, i.e. the given WKT is within the
bounds of a record's geometry.
CROSSES
: Matches records that cross the given WKT.
DISJOINT
: Matches records that are disjoint from the
given WKT.
EQUALS
: Matches records that are the same as the
given WKT.
INTERSECTS
: Matches records that intersect the given
WKT.
OVERLAPS
: Matches records that overlap the given WKT.
TOUCHES
: Matches records that touch the given WKT.
WITHIN
: Matches records that are within the given
WKT.
options
- Optional parameters.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.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
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.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
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. Has the same naming
restrictions as tables.columnValuesMap
- List of values for the corresponding column in
the tableoptions
- Optional parameters.
FILTER_MODE
: String indicating the filter mode, either
'in_list' or 'not_in_list'.
Supported values:
IN_LIST
: The filter will match all items that are in
the provided list(s).
NOT_IN_LIST
: The filter will match all items that are
not in the provided list(s).
IN_LIST
.
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.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).
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.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).
tableName
- Name of the table on which the filter by radius
operation will be performed. Must be an existing
table.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables.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. Although this functionality can also be
accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
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. Although this functionality can also be
accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
tableName
- Name of the table on which the filter by range
operation will be performed. Must be an existing
table.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables.columnName
- Name of a column on which the operation would be
applied.lowerBound
- Value of the lower bound (inclusive).upperBound
- Value of the upper bound (inclusive).options
- Optional parameters.GPUdbException
- if an error occurs during the operation.FilterByRangeResponse
public FilterBySeriesResponse filterBySeries(FilterBySeriesRequest request) throws GPUdbException
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
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
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
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. Has the same naming
restrictions as tables.trackId
- The ID of the track which will act as the filtering
points. Must be an existing track within the given
table.targetTrackIds
- Up to one track ID to intersect with the "filter"
track. If any provided, it must be an valid track
ID within the given set.options
- Optional parameters.
SPATIAL_RADIUS
: A positive number passed as a string
representing the radius of the search area centered
around each track point's geospatial coordinates. The
value is interpreted in meters. Required parameter.
TIME_RADIUS
: A positive number passed as a string
representing the maximum allowable time difference
between the timestamps of a filtered object and the
given track's points. The value is interpreted in
seconds. Required parameter.
SPATIAL_DISTANCE_METRIC
: A string representing the
coordinate system to use for the spatial search
criteria. Acceptable values are 'euclidean' and
'great_circle'. Optional parameter; default is
'euclidean'.
Supported values:
GPUdbException
- if an error occurs during the operation.FilterBySeriesResponse
public FilterByStringResponse filterByString(FilterByStringRequest request) throws GPUdbException
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
tableName
- Name of the table on which the filter operation will
be performed. Must be an existing table, collection
or view.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables.expression
- The expression with which to filter the table.mode
- The string filtering mode to apply. See below for details.
Supported values:
SEARCH
: Full text search query with wildcards and boolean
operators. Note that for this mode, no column can be
specified in columnNames
; all string columns of the
table that have text search enabled will be searched.
EQUALS
: Exact whole-string match (accelerated).
CONTAINS
: Partial substring match (not accelerated). If
the column is a string type (non-charN) and the number of
records is too large, it will return 0.
STARTS_WITH
: Strings that start with the given expression
(not accelerated). If the column is a string type
(non-charN) and the number of records is too large, it will
return 0.
REGEX
:
Full regular expression search (not accelerated). If the
column is a string type (non-charN) and the number of
records is too large, it will return 0.
columnNames
- List of columns on which to apply the filter.
Ignored for 'search' mode.options
- Optional parameters.
CASE_SENSITIVE
: If 'false' then string filtering will
ignore case. Does not apply to 'search' mode.
Supported values:
The default value is TRUE
.
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 a response will not be returned until all objects are fully
available in the result view. The return value contains the count (i.e.
the size) of the resulting view.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 a response will not be returned until all objects are fully
available in the result view. The return value contains the count (i.e.
the size) of the resulting view.tableName
- Name of the table whose data will be filtered. Must be
an existing table.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables.columnName
- Name of the column by whose value the data will be
filtered from the table designated by tableName
.sourceTableName
- Name of the table whose data will be compared
against in the table called tableName
.
Must be an existing table.sourceTableColumnName
- Name of the column in the sourceTableName
whose values will be used
as the filter for table tableName
.
Must match the type of the columnName
.options
- Optional parameters.
FILTER_MODE
: String indicating the filter mode, either
in_table
or not_in_table
.
Supported values:
The default value is IN_TABLE
.
MODE
: Mode - should be either spatial
or normal
.
Supported values:
The default value is NORMAL
.
BUFFER
: Buffer size, in meters. Only relevant for
spatial
mode.
BUFFER_METHOD
: Method used to buffer polygons. Only
relevant for spatial
mode.
Supported values:
The default value is NORMAL
.
MAX_PARTITION_SIZE
: Maximum number of points in a
partition. Only relevant for spatial
mode.
MAX_PARTITION_SCORE
: Maximum number of points * edges
in a partition. Only relevant for spatial
mode.
X_COLUMN_NAME
: Name of column containing x value of
point being filtered in spatial
mode.
Y_COLUMN_NAME
: Name of column containing y value of
point being filtered in spatial
mode.
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 table on which to perform the
calculation.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables.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 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
This operation supports paging through the data via the offset
and limit
parameters. Note that when paging through a table, if
the table (or the underlying table in case of a view) is updated
(records are inserted, deleted or modified) the records retrieved may
differ between calls based on the updates applied.
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
This operation supports paging through the data via the offset
and limit
parameters. Note that when paging through a table, if
the table (or the underlying table in case of a view) is updated
(records are inserted, deleted or modified) the records retrieved may
differ between calls based on the updates applied.
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
This operation supports paging through the data via the offset
and limit
parameters. Note that when paging through a table, if
the table (or the underlying table in case of a view) is updated
(records are inserted, deleted or modified) the records retrieved may
differ between calls based on the updates applied.
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
- EXPRESSION
: Optional filter expression to apply to the
table.
FAST_INDEX_LOOKUP
: Indicates if indexes should be used
to perform the lookup for a given expression if
possible. Only applicable if there is no sorting, the
expression contains only equivalence comparisons based
on existing tables indexes and the range of requested
values is from [0 to END_OF_SET]. The default value is
true.
SORT_BY
: Optional column that the data should be sorted
by. Empty by default (i.e. no sorting is applied).
SORT_ORDER
: String indicating how the returned values
should be sorted - ascending or descending. If
sort_order is provided, sort_by has to be provided.
Supported values:
The default value is ASCENDING
.
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
This operation supports paging through the data via the offset
and limit
parameters. Note that when paging through a table, if
the table (or the underlying table in case of a view) is updated
(records are inserted, deleted or modified) the records retrieved may
differ between calls based on the updates applied.
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
This operation supports paging through the data via the offset
and limit
parameters. Note that when paging through a table, if
the table (or the underlying table in case of a view) is updated
(records are inserted, deleted or modified) the records retrieved may
differ between calls based on the updates applied.
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
- EXPRESSION
: Optional filter expression to apply to the
table.
FAST_INDEX_LOOKUP
: Indicates if indexes should be used
to perform the lookup for a given expression if
possible. Only applicable if there is no sorting, the
expression contains only equivalence comparisons based
on existing tables indexes and the range of requested
values is from [0 to END_OF_SET]. The default value is
true.
SORT_BY
: Optional column that the data should be sorted
by. Empty by default (i.e. no sorting is applied).
SORT_ORDER
: String indicating how the returned values
should be sorted - ascending or descending. If
sort_order is provided, sort_by has to be provided.
Supported values:
The default value is ASCENDING
.
GPUdbException
- if an error occurs during the operation.GetRecordsResponse
public RawGetRecordsByColumnResponse getRecordsByColumnRaw(GetRecordsByColumnRequest request) throws GPUdbException
Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
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
Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
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
Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
tableName
- Name of the table on which this operation will be
performed. The table cannot be a parent set.columnNames
- The list of column values to retrieve.offset
- A positive integer indicating the number of initial
results to skip (this can be useful for paging through
the results). The minimum allowed value is 0. The
maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned (if not provided the default is
10000), or END_OF_SET (-9999) to indicate that the maximum
number of results allowed by the server should be
returned.options
- EXPRESSION
: Optional filter expression to apply to the
table.
SORT_BY
: Optional column that the data should be sorted
by. Empty by default (i.e. no sorting is applied).
SORT_ORDER
: String indicating how the returned values
should be sorted - ascending or descending. Default is
'ascending'. If sort_order is provided, sort_by has to
be provided.
Supported values:
The default value is ASCENDING
.
ORDER_BY
: Comma-separated list of the columns to be
sorted by; e.g. 'timestamp asc, x desc'. The columns
specified must be present in columnNames
. If
any alias is given for any column name, the alias must
be used, rather than the original column name.
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
.
This operation supports paging through the data via the offset
and limit
parameters.
In contrast to getRecordsRaw(GetRecordsRequest)
this
returns records grouped by series/track. So if offset
is 0 and
limit
is 5 this operation would return the first 5 series/tracks
in tableName
. Each series/track will be returned sorted by their
TIMESTAMP column.
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
.
This operation supports paging through the data via the offset
and limit
parameters.
In contrast to getRecords(Object, GetRecordsRequest)
this
returns records grouped by series/track. So if offset
is 0 and
limit
is 5 this operation would return the first 5 series/tracks
in tableName
. Each series/track will be returned sorted by their
TIMESTAMP column.
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
.
This operation supports paging through the data via the offset
and limit
parameters.
In contrast to getRecords(Object, String, long, long, Map)
this returns records grouped by series/track. So if offset
is 0
and limit
is 5 this operation would return the first 5
series/tracks in tableName
. Each series/track will be returned
sorted by their TIMESTAMP column.
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
.
This operation supports paging through the data via the offset
and limit
parameters.
In contrast to getRecords(GetRecordsRequest)
this returns
records grouped by series/track. So if offset
is 0 and limit
is 5 this operation would return the first 5 series/tracks in
tableName
. Each series/track will be returned sorted by their
TIMESTAMP column.
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
.
This operation supports paging through the data via the offset
and limit
parameters.
In contrast to getRecords(String, long, long, Map)
this
returns records grouped by series/track. So if offset
is 0 and
limit
is 5 this operation would return the first 5 series/tracks
in tableName
. Each series/track will be returned sorted by their
TIMESTAMP column.
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)
.
This operation supports paging through the data via the offset
and limit
parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
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)
.
This operation supports paging through the data via the offset
and limit
parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
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)
.
This operation supports paging through the data via the offset
and limit
parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
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 collection or
table.offset
- A positive integer indicating the number of initial
results to skip (this can be useful for paging through
the results). The minimum allowed value is 0. The
maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- RETURN_RECORD_IDS
: If 'true' then return the internal
record ID along with each returned record. Default is
'false'.
Supported values:
The default value is FALSE
.
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)
.
This operation supports paging through the data via the offset
and limit
parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
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)
.
This operation supports paging through the data via the offset
and limit
parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
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 collection or
table.offset
- A positive integer indicating the number of initial
results to skip (this can be useful for paging through
the results). The minimum allowed value is 0. The
maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- RETURN_RECORD_IDS
: If 'true' then return the internal
record ID along with each returned record. Default is
'false'.
Supported values:
The default value is FALSE
.
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.
Supported values:
SYSTEM_ADMIN
: Full access to all data and system
functions.
SYSTEM_WRITE
: Read and write access to all tables.
SYSTEM_READ
: Read-only access to all tables.
options
- Optional parameters.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.
Supported values:
TABLE_ADMIN
: Full read/write and administrative
access to the table.
TABLE_INSERT
: Insert access to the table.
TABLE_UPDATE
: Update access to the table.
TABLE_DELETE
: Delete access to the table.
TABLE_READ
: Read access to the table.
tableName
- Name of the table to which the permission grants
access. Must be an existing table, collection, or
view. If a collection, the permission also applies to
tables and views in the collection.filterExpression
- Reserved for future use.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 HasProcResponse hasProc(HasProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.HasProcResponse
public HasProcResponse hasProc(String procName, Map<String,String> options) throws GPUdbException
procName
- Name of the proc to check for existence.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.HasProcResponse
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 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
The options
parameter can be used to customize this function's
behavior.
The update_on_existing_pk
option specifies the record collision
policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids
option indicates that the database should
return the unique identifiers of inserted records.
The route_to_address
option directs that inserted records should
be targeted for a particular database node.
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
The options
parameter can be used to customize this function's
behavior.
The update_on_existing_pk
option specifies the record collision
policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids
option indicates that the database should
return the unique identifiers of inserted records.
The route_to_address
option directs that inserted records should
be targeted for a particular database node.
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
The options
parameter can be used to customize this function's
behavior.
The update_on_existing_pk
option specifies the record collision
policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids
option indicates that the database should
return the unique identifiers of inserted records.
The route_to_address
option directs that inserted records should
be targeted for a particular database node.
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
The options
parameter can be used to customize this function's
behavior.
The update_on_existing_pk
option specifies the record collision
policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids
option indicates that the database should
return the unique identifiers of inserted records.
The route_to_address
option directs that inserted records should
be targeted for a particular database node.
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.
UPDATE_ON_EXISTING_PK
: Specifies the record collision
policy for inserting into a table with a primary key. If set to true
,
any existing table record with primary key values that
match those of a record being inserted will be replaced
by that new record. If set to false
, any
existing table record with primary key values that match
those of a record being inserted will remain unchanged
and the new record discarded. If the specified table
does not have a primary key, then this option is
ignored.
Supported values:
The default value is FALSE
.
RETURN_RECORD_IDS
: If true
then return the
internal record id along for each inserted record.
Supported values:
The default value is FALSE
.
ROUTE_TO_ADDRESS
: Route to a specific rank/tom. Option
not suitable for tables using primary/shard keys
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
The options
parameter can be used to customize this function's
behavior.
The update_on_existing_pk
option specifies the record collision
policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids
option indicates that the database should
return the unique identifiers of inserted records.
The route_to_address
option directs that inserted records should
be targeted for a particular database node.
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.
UPDATE_ON_EXISTING_PK
: Specifies the record collision
policy for inserting into a table with a primary key. If set to true
,
any existing table record with primary key values that
match those of a record being inserted will be replaced
by that new record. If set to false
, any
existing table record with primary key values that match
those of a record being inserted will remain unchanged
and the new record discarded. If the specified table
does not have a primary key, then this option is
ignored.
Supported values:
The default value is FALSE
.
RETURN_RECORD_IDS
: If true
then return the
internal record id along for each inserted record.
Supported values:
The default value is FALSE
.
ROUTE_TO_ADDRESS
: Route to a specific rank/tom. Option
not suitable for tables using primary/shard keys
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
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
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
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
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:
SEED
: If provided, the internal random number generator
will be initialized with the given value. The minimum
is 0. This allows for the same set of random numbers to
be generated across invocation of this endpoint in case
the user wants to repeat the test. Since options
, is a map of maps, we need an internal map to
provide the seed value. For example, to pass 100 as the
seed value through this parameter, you need something
equivalent to: 'options' = {'seed': { 'value': 100 } }
VALUE
: Pass the seed value here.
ALL
: This key indicates that the specifications relayed
in the internal map are to be applied to all columns of
the records.
MIN
: For numerical columns, the minimum of the
generated values is set to this value. Default is
-99999. For point, shape, and track semantic types, min
for numeric 'x' and 'y' columns needs to be within
[-180, 180] and [-90, 90], respectively. The default
minimum possible values for these columns in such cases
are -180.0 and -90.0. For the 'TIMESTAMP' column, the
default minimum corresponds to Jan 1, 2010.
For string columns, the minimum length of the randomly
generated strings is set to this value (default is 1).
If both minimum and maximum are provided, minimum must
be less than or equal to max. Value needs to be within
[1, 200].
If the min is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track
types, then those parameters will not be set; however,
an error will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
MAX
: For numerical columns, the maximum of the
generated values is set to this value. Default is 99999.
For point, shape, and track semantic types, max for
numeric 'x' and 'y' columns needs to be within [-180,
180] and [-90, 90], respectively. The default minimum
possible values for these columns in such cases are
180.0 and 90.0.
For string columns, the maximum length of the randomly
generated strings is set to this value (default is 200).
If both minimum and maximum are provided, *max* must be
greater than or equal to *min*. Value needs to be within
[1, 200].
If the *max* is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track
types, then those parameters will not be set; however,
an error will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
INTERVAL
: If specified, then generate values for all
columns linearly and evenly spaced with the given
interval value starting at the minimum value (instead of
generating random data). *Any provided max value is
disregarded.* For string-type columns, the interval
value is ignored but the string values would be
generated following the pattern:
'attrname_creationIndex#', i.e. the column name suffixed
with an underscore and a running counter (starting at
0). No nulls would be generated for nullable columns.
NULL_PERCENTAGE
: If specified, then generate the given
percentage of the count as nulls for all nullable
columns. This option will be ignored for non-nullable
columns. The value must be within the range [0, 1.0].
The default value is 5% (0.05).
ATTR_NAME
: Set the following parameters for the column
specified by the key. This overrides any parameter set
by all
.
MIN
: For numerical columns, the minimum of the
generated values is set to this value. Default is
-99999. For point, shape, and track semantic types, min
for numeric 'x' and 'y' columns needs to be within
[-180, 180] and [-90, 90], respectively. The default
minimum possible values for these columns in such cases
are -180.0 and -90.0. For the 'TIMESTAMP' column, the
default minimum corresponds to Jan 1, 2010.
For string columns, the minimum length of the randomly
generated strings is set to this value (default is 1).
If both minimum and maximum are provided, minimum must
be less than or equal to max. Value needs to be within
[1, 200].
If the min is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track
types, then those parameters will not be set; however,
an error will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
MAX
: For numerical columns, the maximum of the
generated values is set to this value. Default is 99999.
For point, shape, and track semantic types, max for
numeric 'x' and 'y' columns needs to be within [-180,
180] and [-90, 90], respectively. The default minimum
possible values for these columns in such cases are
180.0 and 90.0.
For string columns, the maximum length of the randomly
generated strings is set to this value (default is 200).
If both minimum and maximum are provided, *max* must be
greater than or equal to *min*. Value needs to be within
[1, 200].
If the *max* is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track
types, then those parameters will not be set; however,
an error will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
INTERVAL
: If specified, then generate values for all
columns linearly and evenly spaced with the given
interval value starting at the minimum value (instead of
generating random data). *Any provided max value is
disregarded.* For string-type columns, the interval
value is ignored but the string values would be
generated following the pattern:
'attrname_creationIndex#', i.e. the column name suffixed
with an underscore and a running counter (starting at
0). No nulls would be generated for nullable columns.
NULL_PERCENTAGE
: If specified and if this column is
nullable, then generate the given percentage of the
count as nulls. This option will result in an error if
the column is not nullable. The value must be within
the range [0, 1.0]. The default value is 5% (0.05).
TRACK_LENGTH
: This key-map pair is only valid for track
type data sets (an error is thrown otherwise). No nulls
would be generated for nullable columns.
MIN
: Minimum possible length for generated series;
default is 100 records per series. Must be an integral
value within the range [1, 500]. If both min and max are
specified, min must be less than or equal to max.
MAX
: Maximum possible length for generated series;
default is 500 records per series. Must be an integral
value within the range [1, 500]. If both min and max are
specified, max must be greater than or equal to min.
GPUdbException
- if an error occurs during the operation.InsertRecordsRandomResponse
public InsertSymbolResponse insertSymbol(InsertSymbolRequest request) throws GPUdbException
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
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'.
Supported values:
symbolData
- The actual symbol data. If symbolFormat
is
'svg' then this should be the raw bytes representing
an svg file. If symbolFormat
is svg path then
this should be an svg path string, for example:
'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'options
- Optional parameters.
COLOR
: If symbolFormat
is 'svg' this is
ignored. If symbolFormat
is 'svg_path' then this
option specifies the color (in RRGGBB hex format) of the
path. For example, to have the path rendered in red,
used 'FF0000'. If 'color' is not provided then '00FF00'
(i.e. green) is used by default.
GPUdbException
- if an error occurs during the operation.InsertSymbolResponse
public KillProcResponse killProc(KillProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.KillProcResponse
public KillProcResponse killProc(String runId, Map<String,String> options) throws GPUdbException
runId
- The run ID of the running proc instance. If the run ID is
not found or the proc instance has already completed, this
does nothing. If not specified, all running proc instances
will be killed.options
- Optional parameters.GPUdbException
- if an error occurs during the operation.KillProcResponse
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.
Supported values:
STATUS
: Show locked status
DISABLE
: Allow no read/write operations
READ_ONLY
: Allow only read operations
WRITE_ONLY
: Allow only write operations
UNLOCK
: Allow all read/write operations
STATUS
.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.
Supported values:
SYSTEM_ADMIN
: Full access to all data and system
functions.
SYSTEM_WRITE
: Read and write access to all tables.
SYSTEM_READ
: Read-only access to all tables.
options
- Optional parameters.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.
Supported values:
TABLE_ADMIN
: Full read/write and administrative
access to the table.
TABLE_INSERT
: Insert access to the table.
TABLE_UPDATE
: Update access to the table.
TABLE_DELETE
: Delete access to the table.
TABLE_READ
: Read access to the table.
tableName
- Name of the table to which the permission grants
access. Must be an existing table, collection, or
view.options
- Optional parameters.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 ShowProcResponse showProc(ShowProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ShowProcResponse
public ShowProcResponse showProc(String procName, Map<String,String> options) throws GPUdbException
procName
- Name of the proc to show information about. If
specified, must be the name of a currently existing
proc. If not specified, information about all procs
will be returned.options
- Optional parameters.
INCLUDE_FILES
: If set to true
, the files that
make up the proc will be returned. If set to false
, the files will not be returned.
Supported values:
The default value is FALSE
.
GPUdbException
- if an error occurs during the operation.ShowProcResponse
public ShowProcStatusResponse showProcStatus(ShowProcStatusRequest request) throws GPUdbException
executeProc(ExecuteProcRequest)
) and data segment ID (each
invocation of the proc command on a data segment is assigned a data
segment ID).request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ShowProcStatusResponse
public ShowProcStatusResponse showProcStatus(String runId, Map<String,String> options) throws GPUdbException
executeProc(String,
Map, Map, List, Map, List, Map)
) and data segment ID (each invocation
of the proc command on a data segment is assigned a data segment ID).runId
- The run ID of a specific running or completed proc
instance for which the status will be returned. If the run
ID is not found, nothing will be returned. If not
specified, the statuses of all running and completed proc
instances will be returned.options
- Optional parameters.
CLEAR_COMPLETE
: If set to true
, if a proc
instance has completed (either successfully or
unsuccessfully) then its status will be cleared and no
longer returned in subsequent calls.
Supported values:
The default value is FALSE
.
GPUdbException
- if an error occurs during the operation.ShowProcStatusResponse
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.
PROPERTIES
: A list of comma separated names of
properties requested. If not specified, all properties
will be returned.
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 can return information about either the collection
itself or the tables and views it contains. If tableName
is
empty, information about all collections and top-level tables and views
can be returned.
If the option get_sizes
is set to true
, then the sizes
(objects and elements) of each table are returned (in sizes
and
fullSizes
), along with the total number of objects in the
requested table (in totalSize
and totalFullSize
).
For a collection, setting the show_children
option to false
returns only information about the collection itself; setting
show_children
to true
returns a list of tables and views
contained in the collection, along with their description, type id,
schema, type label, type properties, and additional information
including TTL.
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 can return information about either the collection
itself or the tables and views it contains. If tableName
is
empty, information about all collections and top-level tables and views
can be returned.
If the option get_sizes
is set to true
, then the sizes
(objects and elements) of each table are returned (in sizes
and
fullSizes
), along with the total number of objects in the
requested table (in totalSize
and totalFullSize
).
For a collection, setting the show_children
option to false
returns only information about the collection itself; setting
show_children
to true
returns a list of tables and views
contained in the collection, along with their description, type id,
schema, type label, type properties, and additional information
including TTL.
tableName
- Name of the table for which to retrieve the
information. If blank, then information about all
collections and top-level tables and views is
returned.options
- Optional parameters.
GET_SIZES
: If true
then the table sizes will be
returned; blank, otherwise.
Supported values:
The default value is FALSE
.
SHOW_CHILDREN
: If tableName
is a collection,
then true
will return information about the
children of the collection, and false
will
return information about the collection itself. If
tableName
is a table or view, show_children
must be false
. If tableName
is empty, then show_children
must be
true
.
Supported values:
The default value is TRUE
.
NO_ERROR_IF_NOT_EXISTS
: If false
will return an
error if the provided tableName
does not exist.
If true
then it will return an empty result.
Supported values:
The default value is 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, or an error is returned.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 is to
be retrieved. An empty list means information will be
retrieved 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.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure
primary key' predicates are allowed when updating primary key values. If
the primary key for a table is the column 'attr1', then the operation
will only accept predicates of the form: "attr1 == 'foo'" if the attr1
column is being updated. For a composite primary key (e.g. columns
'attr1' and 'attr2') then this operation will only accept predicates of
the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary
key columns must appear in an equality predicate in the expressions.
Furthermore each 'pure primary key' predicate must be unique within a
given request. These restrictions can be removed by utilizing some
available options through options
.
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.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure
primary key' predicates are allowed when updating primary key values. If
the primary key for a table is the column 'attr1', then the operation
will only accept predicates of the form: "attr1 == 'foo'" if the attr1
column is being updated. For a composite primary key (e.g. columns
'attr1' and 'attr2') then this operation will only accept predicates of
the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary
key columns must appear in an equality predicate in the expressions.
Furthermore each 'pure primary key' predicate must be unique within a
given request. These restrictions can be removed by utilizing some
available options through options
.
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.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure
primary key' predicates are allowed when updating primary key values. If
the primary key for a table is the column 'attr1', then the operation
will only accept predicates of the form: "attr1 == 'foo'" if the attr1
column is being updated. For a composite primary key (e.g. columns
'attr1' and 'attr2') then this operation will only accept predicates of
the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary
key columns must appear in an equality predicate in the expressions.
Furthermore each 'pure primary key' predicate must be unique within a
given request. These restrictions can be removed by utilizing some
available options through options
.
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.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure
primary key' predicates are allowed when updating primary key values. If
the primary key for a table is the column 'attr1', then the operation
will only accept predicates of the form: "attr1 == 'foo'" if the attr1
column is being updated. For a composite primary key (e.g. columns
'attr1' and 'attr2') then this operation will only accept predicates of
the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary
key columns must appear in an equality predicate in the expressions.
Furthermore each 'pure primary key' predicate must be unique within a
given request. These restrictions can be removed by utilizing some
available options through options
.
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.
GLOBAL_EXPRESSION
: An optional global expression to
reduce the search space of the predicates listed in
expressions
.
BYPASS_SAFETY_CHECKS
: When set to 'true', all
predicates are available for primary key updates. Keep
in mind that it is possible to destroy data in this
case, since a single predicate may match multiple
objects (potentially all of records of a table), and
then updating all of those records to have the same
primary key will, due to the primary key uniqueness
constraints, effectively delete all but one of those
updated records.
Supported values:
The default value is FALSE
.
UPDATE_ON_EXISTING_PK
: Can be used to customize
behavior when the updated primary key value already
exists, as described in insertRecords(String, List, Map)
.
Supported values:
The default value is FALSE
.
RECORD_ID
: ID of a single record to be updated
(returned in the call to insertRecords(String, List, Map)
or getRecordsFromCollection(Object, String, long,
long, Map)
).
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.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure
primary key' predicates are allowed when updating primary key values. If
the primary key for a table is the column 'attr1', then the operation
will only accept predicates of the form: "attr1 == 'foo'" if the attr1
column is being updated. For a composite primary key (e.g. columns
'attr1' and 'attr2') then this operation will only accept predicates of
the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary
key columns must appear in an equality predicate in the expressions.
Furthermore each 'pure primary key' predicate must be unique within a
given request. These restrictions can be removed by utilizing some
available options through options
.
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.
GLOBAL_EXPRESSION
: An optional global expression to
reduce the search space of the predicates listed in
expressions
.
BYPASS_SAFETY_CHECKS
: When set to 'true', all
predicates are available for primary key updates. Keep
in mind that it is possible to destroy data in this
case, since a single predicate may match multiple
objects (potentially all of records of a table), and
then updating all of those records to have the same
primary key will, due to the primary key uniqueness
constraints, effectively delete all but one of those
updated records.
Supported values:
The default value is FALSE
.
UPDATE_ON_EXISTING_PK
: Can be used to customize
behavior when the updated primary key value already
exists, as described in insertRecords(TypeObjectMap, String, List, Map)
.
Supported values:
The default value is FALSE
.
RECORD_ID
: ID of a single record to be updated
(returned in the call to insertRecords(TypeObjectMap, String, List, Map)
or getRecordsFromCollection(Object, String,
long, long, Map)
).
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 an existing view.worldTableName
- Name of the table containing the complete series
(track) information.viewName
- Optional name of the view containing the series
(tracks) which have to be updated.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
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. The operation is synchronous, meaning that a response
will not be returned until the images for all the frames of the video
are fully available.
Once the request has been processed then the generated video frames are
available for download via WMS using STYLES=cached. In this request the
LAYERS parameter should be populated with the session key passed in
sessionKey
of the visualize video request and the FRAME
parameter indicates which 0-based frame of the video should be returned.
All other WMS parameters are ignored for this mode.
For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL:
http://
and the last frame could be retrieved with:
http://
The response payload provides, among other things, the number of frames which were created.
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
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. The operation is synchronous, meaning that a response
will not be returned until the images for all the frames of the video
are fully available.
Once the request has been processed then the generated video frames are
available for download via WMS using STYLES=cached. In this request the
LAYERS parameter should be populated with the session key passed in
sessionKey
of the visualize video request and the FRAME
parameter indicates which 0-based frame of the video should be returned.
All other WMS parameters are ignored for this mode.
For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL:
http://
and the last frame could be retrieved with:
http://
The response payload provides, among other things, the number of frames which were created.
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).
Supported values:
The default value is PLATE_CARREE
.bgColor
- Background color of the generated image.timeIntervals
- videoStyle
- sessionKey
- User Provided session key that is later used to
retrieve the generated video from the WMS.styleOptions
- Styling options for the image.
DO_POINTS
: Rasterize point data toggle.
Supported values:
The default value is TRUE
.
DO_SHAPES
: Rasterize shapes toggle.
Supported values:
The default value is TRUE
.
DO_TRACKS
: Rasterize tracks toggle.
Supported values:
The default value is TRUE
.
POINTCOLORS
: RGB color value in hex for the
points.
POINTSIZES
: Size of points.
POINTSHAPES
: Shape of the point.
Supported values:
SHAPELINEWIDTHS
: Width of the lines.
SHAPELINECOLORS
: RGB color values in hex for the
line.
SHAPEFILLCOLORS
: RGB color values in hex for the
fill color of the shapes. Use '-1' for no fill.
TRACKLINEWIDTHS
: Width of the track lines. '0'
implies do not draw track lines.
TRACKLINECOLORS
: RGB color values for the track
lines.
TRACKMARKERSIZES
: Size of the track point markers.
TRACKMARKERCOLORS
: Color of the track point
markers.
TRACKMARKERSHAPES
: Shape of track point markers.
Supported values:
The default value is NONE
.
TRACKHEADCOLORS
: Color of track head markers.
TRACKHEADSIZES
: Size of track head markers.
TRACKHEADSHAPES
: Shape of track head markers.
Supported values:
The default value is CIRCLE
.
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 © 2017. All rights reserved.