public class GPUdb extends GPUdbBase
GPUdb
instances are thread safe and may be used from any number of threads
simultaneously.GPUdbBase.GPUdbExitException, GPUdbBase.GPUdbHAUnavailableException, GPUdbBase.HASynchronicityMode, GPUdbBase.Options, GPUdbBase.SubmitException
END_OF_SET, HEADER_AUTHORIZATION, HEADER_CONTENT_TYPE, HEADER_HA_SYNC_MODE, PROTECTED_HEADERS
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 |
---|---|
AdminAddRanksResponse |
adminAddRanks(AdminAddRanksRequest request)
Add one or more new ranks to the Kinetica cluster.
|
AdminAddRanksResponse |
adminAddRanks(List<String> hosts,
List<Map<String,String>> configParams,
Map<String,String> options)
Add one or more new ranks to the Kinetica cluster.
|
AdminAlterJobsResponse |
adminAlterJobs(AdminAlterJobsRequest request)
Perform the requested action on a list of one or more job(s).
|
AdminAlterJobsResponse |
adminAlterJobs(List<Long> jobIds,
String action,
Map<String,String> options)
Perform the requested action on a list of one or more job(s).
|
AdminOfflineResponse |
adminOffline(AdminOfflineRequest request)
Take the system offline.
|
AdminOfflineResponse |
adminOffline(boolean offline,
Map<String,String> options)
Take the system offline.
|
AdminRebalanceResponse |
adminRebalance(AdminRebalanceRequest request)
Rebalance the cluster so that all the nodes contain approximately an
equal number of records.
|
AdminRebalanceResponse |
adminRebalance(Map<String,String> options)
Rebalance the cluster so that all the nodes contain approximately an
equal number of records.
|
AdminRemoveRanksResponse |
adminRemoveRanks(AdminRemoveRanksRequest request)
Remove one or more ranks from the cluster.
|
AdminRemoveRanksResponse |
adminRemoveRanks(List<Integer> ranks,
Map<String,String> options)
Remove one or more ranks from the cluster.
|
AdminShowAlertsResponse |
adminShowAlerts(AdminShowAlertsRequest request)
Requests a list of the most recent alerts.
|
AdminShowAlertsResponse |
adminShowAlerts(int numAlerts,
Map<String,String> options)
Requests a list of the most recent alerts.
|
AdminShowClusterOperationsResponse |
adminShowClusterOperations(AdminShowClusterOperationsRequest request)
Requests the detailed status of the current operation (by default) or a
prior cluster operation specified by
historyIndex . |
AdminShowClusterOperationsResponse |
adminShowClusterOperations(int historyIndex,
Map<String,String> options)
Requests the detailed status of the current operation (by default) or a
prior cluster operation specified by
historyIndex . |
AdminShowJobsResponse |
adminShowJobs(AdminShowJobsRequest request)
Get a list of the current jobs in GPUdb.
|
AdminShowJobsResponse |
adminShowJobs(Map<String,String> options)
Get a list of the current jobs in GPUdb.
|
AdminShowShardsResponse |
adminShowShards(AdminShowShardsRequest request)
Show the mapping of shards to the corresponding rank and tom.
|
AdminShowShardsResponse |
adminShowShards(Map<String,String> options)
Show the mapping of shards to the corresponding rank and tom.
|
AdminShutdownResponse |
adminShutdown(AdminShutdownRequest request)
Exits the database server application.
|
AdminShutdownResponse |
adminShutdown(String exitType,
String authorization,
Map<String,String> options)
Exits the database server application.
|
AdminVerifyDbResponse |
adminVerifyDb(AdminVerifyDbRequest request)
Verify database is in a consistent state.
|
AdminVerifyDbResponse |
adminVerifyDb(Map<String,String> options)
Verify database is in a consistent state.
|
AggregateConvexHullResponse |
aggregateConvexHull(AggregateConvexHullRequest request)
Calculates and returns the convex hull for the values in a table
specified by
tableName . |
AggregateConvexHullResponse |
aggregateConvexHull(String tableName,
String xColumnName,
String yColumnName,
Map<String,String> options)
Calculates and returns the convex hull for the values in a table
specified by
tableName . |
AggregateGroupByResponse |
aggregateGroupBy(AggregateGroupByRequest request)
Calculates unique combinations (groups) of values for the given columns
in a given table or view 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 or view 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 or view and computes aggregates on each unique
combination.
|
AggregateHistogramResponse |
aggregateHistogram(AggregateHistogramRequest request)
Performs a histogram calculation given a table, a column, and an
interval function.
|
AggregateHistogramResponse |
aggregateHistogram(String tableName,
String columnName,
double start,
double end,
double interval,
Map<String,String> options)
Performs a histogram calculation given a table, a column, and an
interval function.
|
AggregateKMeansResponse |
aggregateKMeans(AggregateKMeansRequest request)
This endpoint runs the k-means algorithm - a heuristic algorithm that
attempts to do k-means clustering.
|
AggregateKMeansResponse |
aggregateKMeans(String tableName,
List<String> columnNames,
int k,
double tolerance,
Map<String,String> options)
This endpoint runs the k-means algorithm - a heuristic algorithm that
attempts to do k-means clustering.
|
AggregateMinMaxResponse |
aggregateMinMax(AggregateMinMaxRequest request)
Calculates and returns the minimum and maximum values of a particular
column in a table.
|
AggregateMinMaxResponse |
aggregateMinMax(String tableName,
String columnName,
Map<String,String> options)
Calculates and returns the minimum and maximum values of a particular
column in a table.
|
AggregateMinMaxGeometryResponse |
aggregateMinMaxGeometry(AggregateMinMaxGeometryRequest request)
Calculates and returns the minimum and maximum x- and y-coordinates of a
particular geospatial geometry column in a table.
|
AggregateMinMaxGeometryResponse |
aggregateMinMaxGeometry(String tableName,
String columnName,
Map<String,String> options)
Calculates and returns the minimum and maximum x- and y-coordinates of a
particular geospatial geometry column in a table.
|
AggregateStatisticsResponse |
aggregateStatistics(AggregateStatisticsRequest request)
Calculates the requested statistics of the given column(s) in a given
table.
|
AggregateStatisticsResponse |
aggregateStatistics(String tableName,
String columnName,
String stats,
Map<String,String> options)
Calculates the requested statistics of the given column(s) in a given
table.
|
AggregateStatisticsByRangeResponse |
aggregateStatisticsByRange(AggregateStatisticsByRangeRequest request)
Divides the given set into bins and calculates statistics of the values
of a value-column in each bin.
|
AggregateStatisticsByRangeResponse |
aggregateStatisticsByRange(String tableName,
String selectExpression,
String columnName,
String valueColumnName,
String stats,
double start,
double end,
double interval,
Map<String,String> options)
Divides the given set into bins and calculates statistics of the values
of a value-column in each bin.
|
AggregateUniqueResponse |
aggregateUnique(AggregateUniqueRequest request)
Returns all the unique values from a particular column (specified by
columnName ) of a particular table or view (specified by tableName ). |
AggregateUniqueResponse |
aggregateUnique(String tableName,
String columnName,
long offset,
long limit,
Map<String,String> options)
Returns all the unique values from a particular column (specified by
columnName ) of a particular table or view (specified by tableName ). |
RawAggregateUniqueResponse |
aggregateUniqueRaw(AggregateUniqueRequest request)
Returns all the unique values from a particular column (specified by
columnName ) of a particular table or view (specified by tableName ). |
AggregateUnpivotResponse |
aggregateUnpivot(AggregateUnpivotRequest request)
Rotate the column values into rows values.
|
AggregateUnpivotResponse |
aggregateUnpivot(String tableName,
List<String> columnNames,
String variableColumnName,
String valueColumnName,
List<String> pivotedColumns,
Map<String,String> options)
Rotate the column values into rows values.
|
RawAggregateUnpivotResponse |
aggregateUnpivotRaw(AggregateUnpivotRequest request)
Rotate the column values into rows values.
|
AlterResourceGroupResponse |
alterResourceGroup(AlterResourceGroupRequest request)
Alters the properties of an exisiting resource group to facilitate
resource management.
|
AlterResourceGroupResponse |
alterResourceGroup(String name,
Map<String,Map<String,String>> tierAttributes,
String ranking,
String adjoiningResourceGroup,
Map<String,String> options)
Alters the properties of an exisiting resource group to facilitate
resource management.
|
AlterRoleResponse |
alterRole(AlterRoleRequest request)
Alters a Role.
|
AlterRoleResponse |
alterRole(String name,
String action,
String value,
Map<String,String> options)
Alters a Role.
|
AlterSystemPropertiesResponse |
alterSystemProperties(AlterSystemPropertiesRequest request)
The
alterSystemProperties(AlterSystemPropertiesRequest)
endpoint is primarily used to simplify the testing of the system and is
not expected to be used during normal execution. |
AlterSystemPropertiesResponse |
alterSystemProperties(Map<String,String> propertyUpdatesMap,
Map<String,String> options)
The
alterSystemProperties(Map, Map) endpoint is primarily
used to simplify the testing of the system and is not expected to be
used during normal execution. |
AlterTableResponse |
alterTable(AlterTableRequest request)
Apply various modifications to a table, view, or collection.
|
AlterTableResponse |
alterTable(String tableName,
String action,
String value,
Map<String,String> options)
Apply various modifications to a table, view, or collection.
|
AlterTableColumnsResponse |
alterTableColumns(AlterTableColumnsRequest request)
Apply various modifications to columns in a table, view.
|
AlterTableColumnsResponse |
alterTableColumns(String tableName,
List<Map<String,String>> columnAlterations,
Map<String,String> options)
Apply various modifications to columns in a table, view.
|
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.
|
AlterTierResponse |
alterTier(AlterTierRequest request)
Alters properties of an exisiting tier
to facilitate resource management.
|
AlterTierResponse |
alterTier(String name,
Map<String,String> options)
Alters properties of an exisiting tier
to facilitate resource management.
|
AlterUserResponse |
alterUser(AlterUserRequest request)
Alters a user.
|
AlterUserResponse |
alterUser(String name,
String action,
String value,
Map<String,String> options)
Alters a user.
|
AppendRecordsResponse |
appendRecords(AppendRecordsRequest request)
Append (or insert) all records from a source table (specified by
sourceTableName ) to a particular target table (specified by tableName ). |
AppendRecordsResponse |
appendRecords(String tableName,
String sourceTableName,
Map<String,String> fieldMap,
Map<String,String> options)
Append (or insert) all records from a source table (specified by
sourceTableName ) to a particular target table (specified by tableName ). |
ClearStatisticsResponse |
clearStatistics(ClearStatisticsRequest request)
Clears statistics (cardinality, mean value, etc.) for a column in a
specified table.
|
ClearStatisticsResponse |
clearStatistics(String tableName,
String columnName,
Map<String,String> options)
Clears statistics (cardinality, mean value, etc.) for a column in a
specified table.
|
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.
|
CollectStatisticsResponse |
collectStatistics(CollectStatisticsRequest request)
Collect statistics for a column(s) in a specified table.
|
CollectStatisticsResponse |
collectStatistics(String tableName,
List<String> columnNames,
Map<String,String> options)
Collect statistics for a column(s) in a specified table.
|
CreateExternalTableResponse |
createExternalTable(CreateExternalTableRequest request) |
CreateExternalTableResponse |
createExternalTable(String tableName,
List<String> filepaths,
Map<String,String> createTableOptions,
Map<String,String> options) |
CreateGraphResponse |
createGraph(CreateGraphRequest request)
Creates a new graph network using given nodes, edges, weights, and
restrictions.
|
CreateGraphResponse |
createGraph(String graphName,
boolean directedGraph,
List<String> nodes,
List<String> edges,
List<String> weights,
List<String> restrictions,
Map<String,String> options)
Creates a new graph network using given nodes, edges, weights, and
restrictions.
|
CreateJobResponse |
createJob(CreateJobRequest request)
Create a job which will run asynchronously.
|
CreateJobResponse |
createJob(String endpoint,
String requestEncoding,
ByteBuffer data,
String dataStr,
Map<String,String> options)
Create a job which will run asynchronously.
|
CreateJoinTableResponse |
createJoinTable(CreateJoinTableRequest request)
Creates a table that is the result of a SQL JOIN.
|
CreateJoinTableResponse |
createJoinTable(String joinTableName,
List<String> tableNames,
List<String> columnNames,
List<String> expressions,
Map<String,String> options)
Creates a table that is the result of a SQL JOIN.
|
CreateMaterializedViewResponse |
createMaterializedView(CreateMaterializedViewRequest request)
Initiates the process of creating a materialized view, reserving the
view's name to prevent other views or tables from being created with
that name.
|
CreateMaterializedViewResponse |
createMaterializedView(String tableName,
Map<String,String> options)
Initiates the process of creating a materialized view, reserving the
view's name to prevent other views or tables from being created with
that name.
|
CreateProcResponse |
createProc(CreateProcRequest request)
Creates an instance (proc) of the user-defined function (UDF) specified
by the given command, options, and files, and makes it available for
execution.
|
CreateProcResponse |
createProc(String procName,
String executionMode,
Map<String,ByteBuffer> files,
String command,
List<String> args,
Map<String,String> options)
Creates an instance (proc) of the user-defined function (UDF) specified
by the given command, options, and files, and makes it available for
execution.
|
CreateProjectionResponse |
createProjection(CreateProjectionRequest request)
Creates a new projection of an existing table.
|
CreateProjectionResponse |
createProjection(String tableName,
String projectionName,
List<String> columnNames,
Map<String,String> options)
Creates a new projection of an existing table.
|
CreateResourceGroupResponse |
createResourceGroup(CreateResourceGroupRequest request)
Creates a new resource group to facilitate resource management.
|
CreateResourceGroupResponse |
createResourceGroup(String name,
Map<String,Map<String,String>> tierAttributes,
String ranking,
String adjoiningResourceGroup,
Map<String,String> options)
Creates a new resource group to facilitate resource management.
|
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 a single table modification event
type (insert, update, or delete) on a particular table (identified by
tableName ) and forwards event notifications to subscribers via
ZMQ. |
CreateTableMonitorResponse |
createTableMonitor(String tableName,
Map<String,String> options)
Creates a monitor that watches for a single table modification event
type (insert, update, or delete) on a particular table (identified by
tableName ) and forwards event notifications to subscribers via
ZMQ. |
CreateTriggerByAreaResponse |
createTriggerByArea(CreateTriggerByAreaRequest request)
Sets up an area trigger mechanism for two column_names for one or more
tables.
|
CreateTriggerByAreaResponse |
createTriggerByArea(String requestId,
List<String> tableNames,
String xColumnName,
List<Double> xVector,
String yColumnName,
List<Double> yVector,
Map<String,String> options)
Sets up an area trigger mechanism for two column_names for one or more
tables.
|
CreateTriggerByRangeResponse |
createTriggerByRange(CreateTriggerByRangeRequest request)
Sets up a simple range trigger for a column_name for one or more tables.
|
CreateTriggerByRangeResponse |
createTriggerByRange(String requestId,
List<String> tableNames,
String columnName,
double min,
double max,
Map<String,String> options)
Sets up a simple range trigger for a column_name for one or more tables.
|
CreateTypeResponse |
createType(CreateTypeRequest request)
Creates a new type describing the layout or schema of a table.
|
CreateTypeResponse |
createType(String typeDefinition,
String label,
Map<String,List<String>> properties,
Map<String,String> options)
Creates a new type describing the layout or schema of a table.
|
CreateUnionResponse |
createUnion(CreateUnionRequest request)
Merges data from one or more tables with comparable data types into a
new table.
|
CreateUnionResponse |
createUnion(String tableName,
List<String> tableNames,
List<List<String>> inputColumnNames,
List<String> outputColumnNames,
Map<String,String> options)
Merges data from one or more tables with comparable data types into a
new table.
|
CreateUserExternalResponse |
createUserExternal(CreateUserExternalRequest request)
Creates a new external user (a user whose credentials are managed by an
external LDAP).
|
CreateUserExternalResponse |
createUserExternal(String name,
Map<String,String> options)
Creates a new external user (a user whose credentials are managed by an
external LDAP).
|
CreateUserInternalResponse |
createUserInternal(CreateUserInternalRequest request)
Creates a new internal user (a user whose credentials are managed by the
database system).
|
CreateUserInternalResponse |
createUserInternal(String name,
String password,
Map<String,String> options)
Creates a new internal user (a user whose credentials are managed by the
database system).
|
DeleteGraphResponse |
deleteGraph(DeleteGraphRequest request)
Deletes an existing graph from the graph server and/or persist.
|
DeleteGraphResponse |
deleteGraph(String graphName,
Map<String,String> options)
Deletes an existing graph from the graph server and/or persist.
|
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.
|
DeleteResourceGroupResponse |
deleteResourceGroup(DeleteResourceGroupRequest request)
Deletes a resource group.
|
DeleteResourceGroupResponse |
deleteResourceGroup(String name,
Map<String,String> options)
Deletes a resource group.
|
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.
|
ExecuteSqlResponse |
executeSql(ExecuteSqlRequest request)
SQL Request
|
ExecuteSqlResponse |
executeSql(String statement,
long offset,
long limit,
String requestSchemaStr,
List<ByteBuffer> data,
Map<String,String> options)
SQL Request
|
RawExecuteSqlResponse |
executeSqlRaw(ExecuteSqlRequest request)
SQL Request
|
FilterResponse |
filter(FilterRequest request)
Filters data based on the specified expression.
|
FilterResponse |
filter(String tableName,
String viewName,
String expression,
Map<String,String> options)
Filters data based on the specified expression.
|
FilterByAreaResponse |
filterByArea(FilterByAreaRequest request)
Calculates which objects from a table are within a named area of
interest (NAI/polygon).
|
FilterByAreaResponse |
filterByArea(String tableName,
String viewName,
String xColumnName,
List<Double> xVector,
String yColumnName,
List<Double> yVector,
Map<String,String> options)
Calculates which objects from a table are within a named area of
interest (NAI/polygon).
|
FilterByAreaGeometryResponse |
filterByAreaGeometry(FilterByAreaGeometryRequest request)
Calculates which geospatial geometry objects from a table intersect a
named area of interest (NAI/polygon).
|
FilterByAreaGeometryResponse |
filterByAreaGeometry(String tableName,
String viewName,
String columnName,
List<Double> xVector,
List<Double> yVector,
Map<String,String> options)
Calculates which geospatial geometry objects from a table intersect a
named area of interest (NAI/polygon).
|
FilterByBoxResponse |
filterByBox(FilterByBoxRequest request)
Calculates how many objects within the given table lie in a rectangular
box.
|
FilterByBoxResponse |
filterByBox(String tableName,
String viewName,
String xColumnName,
double minX,
double maxX,
String yColumnName,
double minY,
double maxY,
Map<String,String> options)
Calculates how many objects within the given table lie in a rectangular
box.
|
FilterByBoxGeometryResponse |
filterByBoxGeometry(FilterByBoxGeometryRequest request)
Calculates which geospatial geometry objects from a table intersect a
rectangular box.
|
FilterByBoxGeometryResponse |
filterByBoxGeometry(String tableName,
String viewName,
String columnName,
double minX,
double maxX,
double minY,
double maxY,
Map<String,String> options)
Calculates which geospatial geometry objects from a table intersect a
rectangular box.
|
FilterByGeometryResponse |
filterByGeometry(FilterByGeometryRequest request)
Applies a geometry filter against a geospatial geometry column in a
given table, collection or view.
|
FilterByGeometryResponse |
filterByGeometry(String tableName,
String viewName,
String columnName,
String inputWkt,
String operation,
Map<String,String> options)
Applies a geometry filter against a geospatial geometry column in a
given table, collection or view.
|
FilterByListResponse |
filterByList(FilterByListRequest request)
Calculates which records from a table have values in the given list for
the corresponding column.
|
FilterByListResponse |
filterByList(String tableName,
String viewName,
Map<String,List<String>> columnValuesMap,
Map<String,String> options)
Calculates which records from a table have values in the given list for
the corresponding column.
|
FilterByRadiusResponse |
filterByRadius(FilterByRadiusRequest request)
Calculates which objects from a table lie within a circle with the given
radius and center point (i.e.
|
FilterByRadiusResponse |
filterByRadius(String tableName,
String viewName,
String xColumnName,
double xCenter,
String yColumnName,
double yCenter,
double radius,
Map<String,String> options)
Calculates which objects from a table lie within a circle with the given
radius and center point (i.e.
|
FilterByRadiusGeometryResponse |
filterByRadiusGeometry(FilterByRadiusGeometryRequest request)
Calculates which geospatial geometry objects from a table intersect a
circle with the given radius and center point (i.e.
|
FilterByRadiusGeometryResponse |
filterByRadiusGeometry(String tableName,
String viewName,
String columnName,
double xCenter,
double yCenter,
double radius,
Map<String,String> options)
Calculates which geospatial geometry objects from a table intersect a
circle with the given radius and center point (i.e.
|
FilterByRangeResponse |
filterByRange(FilterByRangeRequest request)
Calculates which objects from a table have a column that is within the
given bounds.
|
FilterByRangeResponse |
filterByRange(String tableName,
String viewName,
String columnName,
double lowerBound,
double upperBound,
Map<String,String> options)
Calculates which objects from a table have a column that is within the
given bounds.
|
FilterBySeriesResponse |
filterBySeries(FilterBySeriesRequest request)
Filters objects matching all points of the given track (works only on
track type data).
|
FilterBySeriesResponse |
filterBySeries(String tableName,
String viewName,
String trackId,
List<String> targetTrackIds,
Map<String,String> options)
Filters objects matching all points of the given track (works only on
track type data).
|
FilterByStringResponse |
filterByString(FilterByStringRequest request)
Calculates which objects from a table, collection, or view match a
string expression for the given string columns.
|
FilterByStringResponse |
filterByString(String tableName,
String viewName,
String expression,
String mode,
List<String> columnNames,
Map<String,String> options)
Calculates which objects from a table, collection, or view match a
string expression for the given string columns.
|
FilterByTableResponse |
filterByTable(FilterByTableRequest request)
Filters objects in one table based on objects in another table.
|
FilterByTableResponse |
filterByTable(String tableName,
String viewName,
String columnName,
String sourceTableName,
String sourceTableColumnName,
Map<String,String> options)
Filters objects in one table based on objects in another table.
|
FilterByValueResponse |
filterByValue(FilterByValueRequest request)
Calculates which objects from a table has a particular value for a
particular column.
|
FilterByValueResponse |
filterByValue(String tableName,
String viewName,
boolean isString,
double value,
String valueStr,
String columnName,
Map<String,String> options)
Calculates which objects from a table has a particular value for a
particular column.
|
GetJobResponse |
getJob(GetJobRequest request)
Get the status and result of asynchronously running job.
|
GetJobResponse |
getJob(long jobId,
Map<String,String> options)
Get the status and result of asynchronously running job.
|
<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 from the requested column(s).
|
GetRecordsByColumnResponse |
getRecordsByColumn(String tableName,
List<String> columnNames,
long offset,
long limit,
Map<String,String> options)
For a given table, retrieves the values from the requested column(s).
|
RawGetRecordsByColumnResponse |
getRecordsByColumnRaw(GetRecordsByColumnRequest request)
For a given table, retrieves the values from the requested column(s).
|
<TResponse> |
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.
|
GetVectortileResponse |
getVectortile(GetVectortileRequest request) |
GetVectortileResponse |
getVectortile(List<String> tableNames,
List<String> columnNames,
Map<String,List<String>> layers,
int tileX,
int tileY,
int zoom,
Map<String,String> options) |
GrantPermissionProcResponse |
grantPermissionProc(GrantPermissionProcRequest request)
Grants a proc-level permission to a user or role.
|
GrantPermissionProcResponse |
grantPermissionProc(String name,
String permission,
String procName,
Map<String,String> options)
Grants a proc-level permission to a user or role.
|
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.
|
InsertRecordsFromFilesResponse |
insertRecordsFromFiles(InsertRecordsFromFilesRequest request)
Reads from one or more files located on the server and inserts the data
into a new or existing table.
|
InsertRecordsFromFilesResponse |
insertRecordsFromFiles(String tableName,
List<String> filepaths,
Map<String,String> createTableOptions,
Map<String,String> options)
Reads from one or more files located on the server and inserts the data
into a new or existing 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.
|
ListGraphResponse |
listGraph(ListGraphRequest request) |
ListGraphResponse |
listGraph(String graphName,
Map<String,String> options) |
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.
|
MatchGraphResponse |
matchGraph(MatchGraphRequest request)
Matches a directed route implied by a given set of
latitude/longitude points to an existing underlying road network graph
using a
given solution type.
|
MatchGraphResponse |
matchGraph(String graphName,
List<String> samplePoints,
String solveMethod,
String solutionTable,
Map<String,String> options)
Matches a directed route implied by a given set of
latitude/longitude points to an existing underlying road network graph
using a
given solution type.
|
MergeRecordsResponse |
mergeRecords(MergeRecordsRequest request)
Create a new empty result table (specified by
tableName ), and
insert all records from source tables (specified by sourceTableNames ) based on the field mapping information (specified by
fieldMaps ). |
MergeRecordsResponse |
mergeRecords(String tableName,
List<String> sourceTableNames,
List<Map<String,String>> fieldMaps,
Map<String,String> options)
Create a new empty result table (specified by
tableName ), and
insert all records from source tables (specified by sourceTableNames ) based on the field mapping information (specified by
fieldMaps ). |
ModifyGraphResponse |
modifyGraph(ModifyGraphRequest request)
Update an existing graph network using given nodes, edges, weights,
restrictions, and options.
|
ModifyGraphResponse |
modifyGraph(String graphName,
List<String> nodes,
List<String> edges,
List<String> weights,
List<String> restrictions,
Map<String,String> options)
Update an existing graph network using given nodes, edges, weights,
restrictions, and options.
|
QueryGraphResponse |
queryGraph(QueryGraphRequest request)
Employs a topological query on a network graph generated a-priori by
createGraph(CreateGraphRequest) and returns a list of
adjacent edge(s) or node(s), also known as an adjacency list, depending
on what's been provided to the endpoint; providing edges will return
nodes and providing nodes will return edges. |
QueryGraphResponse |
queryGraph(String graphName,
List<String> queries,
List<String> restrictions,
String adjacencyTable,
int rings,
Map<String,String> options)
Employs a topological query on a network graph generated a-priori by
createGraph(String, boolean, List, List, List, List, Map)
and returns a list of adjacent edge(s) or node(s), also known as an
adjacency list, depending on what's been provided to the endpoint;
providing edges will return nodes and providing nodes will return edges. |
RevokePermissionProcResponse |
revokePermissionProc(RevokePermissionProcRequest request)
Revokes a proc-level permission from a user or role.
|
RevokePermissionProcResponse |
revokePermissionProc(String name,
String permission,
String procName,
Map<String,String> options)
Revokes a proc-level permission from a user or role.
|
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.
|
ShowFunctionsResponse |
showFunctions(Map<String,String> options) |
ShowFunctionsResponse |
showFunctions(ShowFunctionsRequest request) |
ShowGraphResponse |
showGraph(ShowGraphRequest request)
Shows information and characteristics of graphs that exist on the graph
server.
|
ShowGraphResponse |
showGraph(String graphName,
Map<String,String> options)
Shows information and characteristics of graphs that exist on the graph
server.
|
ShowGraphGrammarResponse |
showGraphGrammar(Map<String,String> options) |
ShowGraphGrammarResponse |
showGraphGrammar(ShowGraphGrammarRequest request) |
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.
|
ShowResourceGroupsResponse |
showResourceGroups(List<String> names,
Map<String,String> options)
Requests resource group properties.
|
ShowResourceGroupsResponse |
showResourceGroups(ShowResourceGroupsRequest request)
Requests resource group properties.
|
ShowResourceStatisticsResponse |
showResourceStatistics(Map<String,String> options)
Requests various statistics for storage/memory tiers and resource
groups.
|
ShowResourceStatisticsResponse |
showResourceStatistics(ShowResourceStatisticsRequest request)
Requests various statistics for storage/memory tiers and resource
groups.
|
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.
|
ShowSqlProcResponse |
showSqlProc(ShowSqlProcRequest request)
Shows information about SQL procedures, including the full definition of
each requested procedure.
|
ShowSqlProcResponse |
showSqlProc(String procedureName,
Map<String,String> options)
Shows information about SQL procedures, including the full definition of
each requested procedure.
|
ShowStatisticsResponse |
showStatistics(List<String> tableNames,
Map<String,String> options)
Retrieves the collected column statistics for the specified table.
|
ShowStatisticsResponse |
showStatistics(ShowStatisticsRequest request)
Retrieves the collected column statistics for the specified table.
|
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 ID or type label.
|
ShowTypesResponse |
showTypes(String typeId,
String label,
Map<String,String> options)
Retrieves information for the specified data type ID or type label.
|
SolveGraphResponse |
solveGraph(SolveGraphRequest request)
Solves an existing graph for a type of problem (e.g., shortest path,
page rank, travelling salesman, etc.) using source nodes, destination
nodes, and
additional, optional weights and restrictions.
|
SolveGraphResponse |
solveGraph(String graphName,
List<String> weightsOnEdges,
List<String> restrictions,
String solverType,
List<String> sourceNodes,
List<String> destinationNodes,
String solutionTable,
Map<String,String> options)
Solves an existing graph for a type of problem (e.g., shortest path,
page rank, travelling salesman, etc.) using source nodes, destination
nodes, and
additional, optional weights and restrictions.
|
<TRequest> UpdateRecordsResponse |
updateRecords(String tableName,
List<String> expressions,
List<Map<String,String>> newValuesMaps,
List<TRequest> data,
Map<String,String> options)
Runs multiple predicate-based updates in a single call.
|
<TRequest> UpdateRecordsResponse |
updateRecords(TypeObjectMap<TRequest> typeObjectMap,
String tableName,
List<String> expressions,
List<Map<String,String>> newValuesMaps,
List<TRequest> data,
Map<String,String> options)
Runs multiple predicate-based updates in a single call.
|
<TRequest> UpdateRecordsResponse |
updateRecords(TypeObjectMap<TRequest> typeObjectMap,
UpdateRecordsRequest<TRequest> request)
Runs multiple predicate-based updates in a single call.
|
<TRequest> UpdateRecordsResponse |
updateRecords(UpdateRecordsRequest<TRequest> request)
Runs multiple predicate-based updates in a single call.
|
UpdateRecordsBySeriesResponse |
updateRecordsBySeries(String tableName,
String worldTableName,
String viewName,
List<String> reserved,
Map<String,String> options)
Updates the view specified by
tableName to include full series
(track) information from the worldTableName for the series
(tracks) present in the viewName . |
UpdateRecordsBySeriesResponse |
updateRecordsBySeries(UpdateRecordsBySeriesRequest request)
Updates the view specified by
tableName to include full series
(track) information from the worldTableName for the series
(tracks) present in the viewName . |
UpdateRecordsResponse |
updateRecordsRaw(RawUpdateRecordsRequest request)
Runs multiple predicate-based updates in a single call.
|
VisualizeImageResponse |
visualizeImage(List<String> tableNames,
List<String> worldTableNames,
String xColumnName,
String yColumnName,
String symbolColumnName,
String geometryColumnName,
List<List<String>> trackIds,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
long bgColor,
Map<String,List<String>> styleOptions,
Map<String,String> options) |
VisualizeImageResponse |
visualizeImage(VisualizeImageRequest request) |
VisualizeImageChartResponse |
visualizeImageChart(String tableName,
List<String> xColumnNames,
List<String> yColumnNames,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String bgColor,
Map<String,List<String>> styleOptions,
Map<String,String> options)
Scatter plot is the only plot type currently supported.
|
VisualizeImageChartResponse |
visualizeImageChart(VisualizeImageChartRequest request)
Scatter plot is the only plot type currently supported.
|
VisualizeImageClassbreakResponse |
visualizeImageClassbreak(List<String> tableNames,
List<String> worldTableNames,
String xColumnName,
String yColumnName,
String geometryColumnName,
List<List<String>> trackIds,
String cbAttr,
List<String> cbVals,
String cbPointcolorAttr,
List<String> cbPointcolorVals,
String cbPointalphaAttr,
List<String> cbPointalphaVals,
String cbPointsizeAttr,
List<String> cbPointsizeVals,
String cbPointshapeAttr,
List<String> cbPointshapeVals,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
long bgColor,
Map<String,List<String>> styleOptions,
Map<String,String> options,
List<Integer> cbTransparencyVec) |
VisualizeImageClassbreakResponse |
visualizeImageClassbreak(VisualizeImageClassbreakRequest request) |
VisualizeImageContourResponse |
visualizeImageContour(List<String> tableNames,
String xColumnName,
String yColumnName,
String valueColumnName,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
Map<String,String> styleOptions,
Map<String,String> options) |
VisualizeImageContourResponse |
visualizeImageContour(VisualizeImageContourRequest request) |
VisualizeImageHeatmapResponse |
visualizeImageHeatmap(List<String> tableNames,
String xColumnName,
String yColumnName,
String valueColumnName,
String geometryColumnName,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
Map<String,String> styleOptions,
Map<String,String> options) |
VisualizeImageHeatmapResponse |
visualizeImageHeatmap(VisualizeImageHeatmapRequest request) |
VisualizeImageLabelsResponse |
visualizeImageLabels(String tableName,
String xColumnName,
String yColumnName,
String xOffset,
String yOffset,
String textString,
String font,
String textColor,
String textAngle,
String textScale,
String drawBox,
String drawLeader,
String lineWidth,
String lineColor,
String fillColor,
String leaderXColumnName,
String leaderYColumnName,
String filter,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
Map<String,String> options) |
VisualizeImageLabelsResponse |
visualizeImageLabels(VisualizeImageLabelsRequest request) |
VisualizeIsochroneResponse |
visualizeIsochrone(String graphName,
String sourceNode,
double maxSolutionRadius,
List<String> weightsOnEdges,
List<String> restrictions,
int numLevels,
boolean generateImage,
String levelsTable,
Map<String,String> styleOptions,
Map<String,String> solveOptions,
Map<String,String> contourOptions,
Map<String,String> options)
Generate an image containing isolines for travel results using an
existing graph.
|
VisualizeIsochroneResponse |
visualizeIsochrone(VisualizeIsochroneRequest request)
Generate an image containing isolines for travel results using an
existing graph.
|
VisualizeVideoResponse |
visualizeVideo(List<String> tableNames,
List<String> worldTableNames,
List<List<String>> trackIds,
String xColumnName,
String yColumnName,
String geometryColumnName,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
long bgColor,
List<List<Double>> timeIntervals,
String videoStyle,
String sessionKey,
Map<String,List<String>> styleOptions,
Map<String,String> options) |
VisualizeVideoResponse |
visualizeVideo(VisualizeVideoRequest request) |
VisualizeVideoHeatmapResponse |
visualizeVideoHeatmap(List<String> tableNames,
String xColumnName,
String yColumnName,
double minX,
double maxX,
double minY,
double maxY,
List<List<Double>> timeIntervals,
int width,
int height,
String projection,
String videoStyle,
String sessionKey,
Map<String,String> styleOptions,
Map<String,String> options) |
VisualizeVideoHeatmapResponse |
visualizeVideoHeatmap(VisualizeVideoHeatmapRequest request) |
addHttpHeader, addKnownType, addKnownType, addKnownTypeFromTable, addKnownTypeFromTable, addKnownTypeObjectMap, decode, decode, decode, decodeMultiple, decodeMultiple, encode, encode, finalize, getApiVersion, getExecutor, getHARingSize, getHASyncMode, getHmURL, getHmURLs, getHttpHeaders, getNumClusterSwitches, getPassword, getPrimaryUrl, getThreadCount, getTimeout, getTypeDescriptor, getTypeObjectMap, getURL, getURLs, getUsername, getUseSnappy, incrementNumClusterSwitches, initializeHttpConnection, initializeHttpPostRequest, isKineticaRunning, list, options, ping, removeHttpHeader, setHASyncMode, setHostManagerPort, setTypeDescriptorIfMissing, submitRequest, submitRequest, submitRequest, submitRequestRaw, submitRequestToHM, submitRequestToHM, switchURL, updateHostManagerPort
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. Can be a comma-separated
string containing multiple full URLs, or a single URL.
For example 'http://172.42.40.1:9191,,http://172.42.40.2:9191'.
If a single URL is given, the given URL will be used as
the primary URL.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. The given URL will be used as
the primary URL.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. If a single URL is given,
it will be used as the primary URL.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. Can be a comma-separated
string containing multiple full URLs, or a single URL.
For example 'http://172.42.40.1:9191,,http://172.42.40.2:9191'.
If a single URL is given, and no primary URL is specified via
the options, the given URL will be used as the primary URL.options
- The options, e.g. primary cluster URL, to use.GPUdbException
- if an error occurs during creation.GPUdbBase.Options
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. If no primary URL is specified via
the options, the given URL will be used as the primary URL.options
- The options, e.g. primary cluster URL, to use.GPUdbException
- if an error occurs during creation.GPUdbBase.Options
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. If a single URL is given,
and no primary URL is specified via the options, the given
URL will be used as the primary URL.options
- The options, e.g. primary cluster URL, to use.GPUdbException
- if an error occurs during creation.GPUdbBase.Options
public AdminAddRanksResponse adminAddRanks(AdminAddRanksRequest request) throws GPUdbException
adminRebalance(AdminRebalanceRequest)
.
For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:
* hosts
would be an array including 172.123.45.67 in the first
two indices (signifying two ranks being added to host 172.123.45.67) and
172.123.45.68 in the last index (signifying one rank being added to host
172.123.45.67)
* configParams
would be an array of maps, with each map
corresponding to the ranks being added in hosts
. The key of each
map would be the configuration parameter name and the value would be the
parameter's value, e.g. 'rank.gpu':'1'
This endpoint's processing includes copying all replicated table data to
the new rank(s) and therefore could take a long time. The API call may
time out if run directly. It is recommended to run this endpoint
asynchronously via createJob(CreateJobRequest)
.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminAddRanksResponse
public AdminAddRanksResponse adminAddRanks(List<String> hosts, List<Map<String,String>> configParams, Map<String,String> options) throws GPUdbException
adminRebalance(Map)
.
For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:
* hosts
would be an array including 172.123.45.67 in the first
two indices (signifying two ranks being added to host 172.123.45.67) and
172.123.45.68 in the last index (signifying one rank being added to host
172.123.45.67)
* configParams
would be an array of maps, with each map
corresponding to the ranks being added in hosts
. The key of each
map would be the configuration parameter name and the value would be the
parameter's value, e.g. 'rank.gpu':'1'
This endpoint's processing includes copying all replicated table data to
the new rank(s) and therefore could take a long time. The API call may
time out if run directly. It is recommended to run this endpoint
asynchronously via createJob(String, String, ByteBuffer,
String, Map)
.
hosts
- The IP address of each rank being added to the cluster.
Insert one entry per rank, even if they are on the same
host. The order of the hosts in the array only matters as
it relates to the configParams
.configParams
- Configuration parameters to apply to the new ranks,
e.g., which GPU to use. Configuration parameters
that start with 'rankN.', where N is the rank
number, should omit the N, as the new rank
number(s) are not allocated until the ranks are
created. Each entry in this array corresponds to
the entry at the same array index in the hosts
. This array must either be completely empty
or have the same number of elements as the hosts
array. An empty array will result in the new ranks
being set only with default parameters.options
- Optional parameters.
DRY_RUN
: If true
, only validation checks will
be performed. No ranks are added.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.AdminAddRanksResponse
public AdminAlterJobsResponse adminAlterJobs(AdminAlterJobsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminAlterJobsResponse
public AdminAlterJobsResponse adminAlterJobs(List<Long> jobIds, String action, Map<String,String> options) throws GPUdbException
jobIds
- Jobs to be modified.action
- Action to be performed on the jobs specified by job_ids.
Supported values:
options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AdminAlterJobsResponse
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.
FLUSH_TO_DISK
: Flush to disk when going offline
Supported values:
Map
.GPUdbException
- if an error occurs during the operation.AdminOfflineResponse
public AdminRebalanceResponse adminRebalance(AdminRebalanceRequest request) throws GPUdbException
This endpoint may take a long time to run, depending on the amount of
data in the system. The API call may time out if run directly. It is
recommended to run this endpoint asynchronously via createJob(CreateJobRequest)
.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminRebalanceResponse
public AdminRebalanceResponse adminRebalance(Map<String,String> options) throws GPUdbException
This endpoint may take a long time to run, depending on the amount of
data in the system. The API call may time out if run directly. It is
recommended to run this endpoint asynchronously via createJob(String, String, ByteBuffer, String, Map)
.
options
- Optional parameters.
REBALANCE_SHARDED_DATA
: If true
, sharded data
will be rebalanced approximately equally across the
cluster. Note that for big clusters, this data transfer
could be time consuming and result in delayed query
responses.
Supported values:
The default value is TRUE
.
REBALANCE_UNSHARDED_DATA
: If true
, unsharded
data (data without primary keys and without shard keys)
will be rebalanced approximately equally across the
cluster. Note that for big clusters, this data transfer
could be time consuming and result in delayed query
responses.
Supported values:
The default value is TRUE
.
TABLE_WHITELIST
: Comma-separated list of unsharded
table names to rebalance. Not applicable to sharded
tables because they are always balanced in accordance
with their primary key or shard key. Cannot be used
simultaneously with table_blacklist
.
TABLE_BLACKLIST
: Comma-separated list of unsharded
table names to not rebalance. Not applicable to sharded
tables because they are always balanced in accordance
with their primary key or shard key. Cannot be used
simultaneously with table_whitelist
.
AGGRESSIVENESS
: Influences how much data to send per
rebalance round. A higher aggressiveness setting will
complete the rebalance faster. A lower aggressiveness
setting will take longer, but allow for better
interleaving between the rebalance and other queries.
Allowed values are 1 through 10. The default value is
'1'.
COMPACT_AFTER_REBALANCE
: Perform compaction of deleted
records once the rebalance completes, to reclaim memory
and disk space. Default is true, unless repair_incorrectly_sharded_data
is set to true
.
Supported values:
The default value is TRUE
.
COMPACT_ONLY
: Only perform compaction, do not
rebalance. Default is false.
Supported values:
The default value is FALSE
.
REPAIR_INCORRECTLY_SHARDED_DATA
: Scans for any data
sharded incorrectly and re-routes the correct location.
This can be done as part of a typical rebalance after
expanding the cluster, or in a standalone fashion when
it is believed that data is sharded incorrectly
somewhere in the cluster. Compaction will not be
performed by default when this is enabled. This option
may also lengthen rebalance time, and increase the
memory used by the rebalance.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.AdminRebalanceResponse
public AdminRemoveRanksResponse adminRemoveRanks(AdminRemoveRanksRequest request) throws GPUdbException
rebalance_sharded_data
or rebalance_unsharded_data
parameters are set to false
in the options
.
Due to the rebalancing, this endpoint may take a long time to run,
depending on the amount of data in the system. The API call may time out
if run directly. It is recommended to run this endpoint asynchronously
via createJob(CreateJobRequest)
.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminRemoveRanksResponse
public AdminRemoveRanksResponse adminRemoveRanks(List<Integer> ranks, Map<String,String> options) throws GPUdbException
rebalance_sharded_data
or rebalance_unsharded_data
parameters are set to false
in the options
.
Due to the rebalancing, this endpoint may take a long time to run,
depending on the amount of data in the system. The API call may time out
if run directly. It is recommended to run this endpoint asynchronously
via createJob(String, String, ByteBuffer, String, Map)
.
ranks
- Rank numbers of the ranks to be removed from the cluster.options
- Optional parameters.
REBALANCE_SHARDED_DATA
: When true
, data with
primary keys or shard keys will be rebalanced to other
ranks prior to rank removal. Note that for big clusters,
this data transfer could be time consuming and result in
delayed query responses.
Supported values:
The default value is TRUE
.
REBALANCE_UNSHARDED_DATA
: When true
, unsharded
data (data without primary keys and without shard keys)
will be rebalanced to other ranks prior to rank removal.
Note that for big clusters, this data transfer could be
time consuming and result in delayed query responses.
Supported values:
The default value is TRUE
.
AGGRESSIVENESS
: Influences how much data to send per
rebalance round, during the rebalance portion of
removing ranks. A higher aggressiveness setting will
complete the rebalance faster. A lower aggressiveness
setting will take longer, but allow for better
interleaving between the rebalance and other queries.
Allowed values are 1 through 10. The default value is
'1'.
Map
.GPUdbException
- if an error occurs during the operation.AdminRemoveRanksResponse
public AdminShowAlertsResponse adminShowAlerts(AdminShowAlertsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminShowAlertsResponse
public AdminShowAlertsResponse adminShowAlerts(int numAlerts, Map<String,String> options) throws GPUdbException
numAlerts
- Number of most recent alerts to request. The response
will include up to numAlerts
depending on how
many alerts there are in the system. A value of 0
returns all stored alerts.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AdminShowAlertsResponse
public AdminShowClusterOperationsResponse adminShowClusterOperations(AdminShowClusterOperationsRequest request) throws GPUdbException
historyIndex
.
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminShowClusterOperationsResponse
public AdminShowClusterOperationsResponse adminShowClusterOperations(int historyIndex, Map<String,String> options) throws GPUdbException
historyIndex
.
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
historyIndex
- Indicates which cluster operation to retrieve. Use
0 for the most recent. The default value is 0.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AdminShowClusterOperationsResponse
public AdminShowJobsResponse adminShowJobs(AdminShowJobsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminShowJobsResponse
public AdminShowJobsResponse adminShowJobs(Map<String,String> options) throws GPUdbException
options
- Optional parameters.
SHOW_ASYNC_JOBS
: If true
, then the completed
async jobs are also included in the response. By
default, once the async jobs are completed they are no
longer included in the jobs list.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.AdminShowJobsResponse
public AdminShowShardsResponse adminShowShards(AdminShowShardsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AdminShowShardsResponse
public AdminShowShardsResponse adminShowShards(Map<String,String> options) throws GPUdbException
options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AdminShowShardsResponse
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. The default value is an empty
Map
.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.
REBUILD_ON_ERROR
:
Supported values:
The default value is FALSE
.
VERIFY_NULLS
: When enabled, verifies that null values
are set to zero
Supported values:
The default value is FALSE
.
VERIFY_PERSIST
:
Supported values:
The default value is FALSE
.
CONCURRENT_SAFE
: When enabled, allows this endpoint to
be run safely with other concurrent database operations.
Other operations may be slower while this is running.
Supported values:
The default value is TRUE
.
VERIFY_RANK0
: When enabled, compares rank0 table
meta-data against workers meta-data
Supported values:
The default value is FALSE
.
Map
.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 cannot be a
collection.xColumnName
- Name of the column containing the x coordinates of
the points for the operation being performed.yColumnName
- Name of the column containing the y coordinates of
the points for the operation being performed.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AggregateConvexHullResponse
public RawAggregateGroupByResponse aggregateGroupByRaw(AggregateGroupByRequest request) throws GPUdbException
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset
and limit
parameters. For example, to get 10 groups with the largest counts the
inputs would be: limit=10, options={"sort_order":"descending",
"sort_by":"value"}.
options
can be used to customize behavior of this call e.g.
filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having
.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column
names must adhere to standard naming conventions; column/aggregation
expressions will need to be aliased. If the source table's shard
key is used as the grouping column(s) and all result records are
selected (offset
is 0 and limit
is -9999), the result
table will be sharded, in all other cases it will be replicated.
Sorting will properly function only if the result table is replicated or
if there is only one processing node and should not be relied upon in
other cases. Not available when any of the values of columnNames
is an unrestricted-length string.
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
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset
and limit
parameters. For example, to get 10 groups with the largest counts the
inputs would be: limit=10, options={"sort_order":"descending",
"sort_by":"value"}.
options
can be used to customize behavior of this call e.g.
filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having
.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column
names must adhere to standard naming conventions; column/aggregation
expressions will need to be aliased. If the source table's shard
key is used as the grouping column(s) and all result records are
selected (offset
is 0 and limit
is -9999), the result
table will be sharded, in all other cases it will be replicated.
Sorting will properly function only if the result table is replicated or
if there is only one processing node and should not be relied upon in
other cases. Not available when any of the values of columnNames
is an unrestricted-length string.
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
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset
and limit
parameters. For example, to get 10 groups with the largest counts the
inputs would be: limit=10, options={"sort_order":"descending",
"sort_by":"value"}.
options
can be used to customize behavior of this call e.g.
filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having
.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column
names must adhere to standard naming conventions; column/aggregation
expressions will need to be aliased. If the source table's shard
key is used as the grouping column(s) and all result records are
selected (offset
is 0 and limit
is -9999), the result
table will be sharded, in all other cases it will be replicated.
Sorting will properly function only if the result table is replicated or
if there is only one processing node and should not be relied upon in
other cases. Not available when any of the values of columnNames
is an unrestricted-length string.
tableName
- Name of an existing table or view on which the
operation will be performed.columnNames
- List of one or more column names, expressions, and
aggregate expressions.offset
- A positive integer indicating the number of initial
results to skip (this can be useful for paging through
the results). The default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned. The
number of records returned will never exceed the server's
own limit, defined by the max_get_records_size parameter in the
server configuration. Use hasMoreRecords
to see
if more records exist in the result to be fetched, and
offset
& limit
to request subsequent pages
of results. The default value is -9999.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the table specified in result_table
. If
the collection provided is non-existent, the collection
will be automatically created. If empty, then the table
will be a top-level table.
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.
VALUE
.
RESULT_TABLE
: The name of the table used to store the
results. Has the same naming restrictions as tables. Column names (group-by and
aggregate fields) need to be given aliases e.g.
["FChar256 as fchar256", "sum(FDouble) as sfd"]. If
present, no results are returned in the response. This
option is not available if one of the grouping
attributes is an unrestricted string (i.e.; not charN)
type.
RESULT_TABLE_PERSIST
: If true
, then the result
table specified in result_table
will be
persisted and will not expire unless a ttl
is
specified. If false
, then the result table
will be an in-memory table and will expire unless a
ttl
is specified otherwise.
Supported values:
The default value is FALSE
.
RESULT_TABLE_FORCE_REPLICATED
: Force the result table
to be replicated (ignores any sharding). Must be used in
combination with the result_table
option.
Supported values:
The default value is FALSE
.
RESULT_TABLE_GENERATE_PK
: If true
then set a
primary key for the result table. Must be used in
combination with the result_table
option.
Supported values:
The default value is FALSE
.
TTL
: Sets the TTL of the table specified in result_table
.
CHUNK_SIZE
: Indicates the number of records per chunk
to be used for the result table. Must be used in
combination with the result_table
option.
CREATE_INDEXES
: Comma-separated list of columns on
which to create indexes on the result table. Must be
used in combination with the result_table
option.
VIEW_ID
: ID of view of which the result table will be a
member. The default value is ''.
MATERIALIZE_ON_GPU
: No longer used. See Resource Management Concepts for
information about how resources are managed, Tier
Strategy Concepts for how resources are targeted for
VRAM, and Tier Strategy Usage for how to specify
a table's priority in VRAM.
Supported values:
The default value is FALSE
.
PIVOT
: pivot column
PIVOT_VALUES
: The value list provided will become the
column headers in the output. Should be the values from
the pivot_column.
GROUPING_SETS
: Customize the grouping attribute sets to
compute the aggregates. These sets can include ROLLUP or
CUBE operartors. The attribute sets should be enclosed
in paranthesis and can include composite attributes. All
attributes specified in the grouping sets must present
in the groupby attributes.
ROLLUP
: This option is used to specify the multilevel
aggregates.
CUBE
: This option is used to specify the
multidimensional aggregates.
Map
.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 this latter case the sum of the values corresponding
to the value_column
is used as the result instead. The total
number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA
(GPU-based) build to service a request that specifies a value_column
option.
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 this latter case the sum of the values corresponding
to the value_column
is used as the result instead. The total
number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA
(GPU-based) build to service a request that specifies a value_column
option.
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).
Map
.GPUdbException
- if an error occurs during the operation.AggregateHistogramResponse
public AggregateKMeansResponse aggregateKMeans(AggregateKMeansRequest request) throws GPUdbException
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
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
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
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.
Map
.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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AggregateMinMaxResponse
public AggregateMinMaxGeometryResponse aggregateMinMaxGeometry(AggregateMinMaxGeometryRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AggregateMinMaxGeometryResponse
public AggregateMinMaxGeometryResponse aggregateMinMaxGeometry(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 geospatial geometry column on which the
min-max will be calculated.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AggregateMinMaxGeometryResponse
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)').
A second, comma-separated value can be added to the percentile
statistic to calculate percentile resolution, e.g., a 50th percentile
with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight_column_name
to
be specified in options
. The weighted average is then defined as
the sum of the products of columnName
times the weight_column_name
values divided by the sum of the weight_column_name
values.
Additional columns can be used in the calculation of statistics via the
additional_column_names
option. Values in these columns will be
included in the overall aggregate calculation--individual aggregates
will not be calculated per additional column. For instance, requesting
the count
& mean
of columnName
x and additional_column_names
y & z, where x holds the numbers 1-10, y holds
11-20, and z holds 21-30, would return the total number of x, y, & z
values (30), and the single average value across all x, y, & z values
(15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
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)').
A second, comma-separated value can be added to the percentile
statistic to calculate percentile resolution, e.g., a 50th percentile
with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight_column_name
to
be specified in options
. The weighted average is then defined as
the sum of the products of columnName
times the weight_column_name
values divided by the sum of the weight_column_name
values.
Additional columns can be used in the calculation of statistics via the
additional_column_names
option. Values in these columns will be
included in the overall aggregate calculation--individual aggregates
will not be calculated per additional column. For instance, requesting
the count
& mean
of columnName
x and additional_column_names
y & z, where x holds the numbers 1-10, y holds
11-20, and z holds 21-30, would return the total number of x, y, & z
values (30), and the single average value across all x, y, & z values
(15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
tableName
- Name of the table on which the statistics operation
will be performed.columnName
- Name of the primary column for which the statistics
are to be calculated.stats
- Comma separated list of the statistics to calculate, e.g.
"sum,mean".
Supported values:
COUNT
: Number of objects (independent of the given
column(s)).
MEAN
: Arithmetic mean (average), equivalent to sum/count.
STDV
: Sample standard deviation (denominator is count-1).
VARIANCE
: Unbiased sample variance (denominator is
count-1).
SKEW
: Skewness (third standardized moment).
KURTOSIS
: Kurtosis (fourth standardized moment).
SUM
: Sum of all values in the column(s).
MIN
: Minimum value of the column(s).
MAX
: Maximum value of the column(s).
WEIGHTED_AVERAGE
: Weighted arithmetic mean (using the
option weight_column_name
as the weighting
column).
CARDINALITY
: Number of unique values in the column(s).
ESTIMATED_CARDINALITY
: Estimate (via hyperloglog
technique) of the number of unique values in the
column(s).
PERCENTILE
: Estimate (via t-digest) of the given
percentile of the column(s) (percentile(50.0) will be an
approximation of the median). Add a second,
comma-separated value to calculate percentile resolution,
e.g., 'percentile(75,150)'
PERCENTILE_RANK
: Estimate (via t-digest) of the
percentile rank of the given value in the column(s) (if
the given value is the median of the column(s),
percentile_rank(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.
Map
.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.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
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.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
tableName
- Name of the table on which the ranged-statistics
operation will be performed.selectExpression
- For a non-empty expression statistics are
calculated for those records for which the
expression is true. The default value is ''.columnName
- Name of the binning-column used to divide the set
samples into bins.valueColumnName
- Name of the value-column for which statistics
are to be computed.stats
- A string of comma separated list of the statistics to
calculate, e.g. 'sum,mean'. Available statistics: mean,
stdv (standard deviation), variance, skew, kurtosis, sum.start
- The lower bound of the binning-column.end
- The upper bound of the binning-column.interval
- The interval of a bin. Set members fall into bin i if
the binning-column falls in the range
[start+interval*i, start+interval*(i+1)).options
- Map of optional parameters:
ADDITIONAL_COLUMN_NAMES
: A list of comma separated
value-column names over which statistics can be
accumulated along with the primary value_column.
BIN_VALUES
: A list of comma separated binning-column
values. Values that match the nth bin_values value are
placed in the nth bin.
WEIGHT_COLUMN_NAME
: Name of the column used as
weighting column for the weighted_average statistic.
ORDER_COLUMN_NAME
: Name of the column used for
candlestick charting techniques.
Map
.GPUdbException
- if an error occurs during the operation.AggregateStatisticsByRangeResponse
public RawAggregateUniqueResponse aggregateUniqueRaw(AggregateUniqueRequest request) throws GPUdbException
columnName
) of a particular table or view (specified by tableName
). If columnName
is a numeric column the values will
be in binaryEncodedResponse
. Otherwise if columnName
is
a string column the values will be in jsonEncodedResponse
. The
results can be paged via the offset
and limit
parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options
would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column name
must adhere to standard naming conventions; any column expression
will need to be aliased. If the source table's shard
key is used as the columnName
, the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available if 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 or view (specified by tableName
). If columnName
is a numeric column the values will
be in binaryEncodedResponse
. Otherwise if columnName
is
a string column the values will be in jsonEncodedResponse
. The
results can be paged via the offset
and limit
parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options
would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column name
must adhere to standard naming conventions; any column expression
will need to be aliased. If the source table's shard
key is used as the columnName
, the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available if 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 or view (specified by tableName
). If columnName
is a numeric column the values will
be in binaryEncodedResponse
. Otherwise if columnName
is
a string column the values will be in jsonEncodedResponse
. The
results can be paged via the offset
and limit
parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options
would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table
name is specified in the options
, the
results are stored in a new table with that name--no results are
returned in the response. Both the table name and resulting column name
must adhere to standard naming conventions; any column expression
will need to be aliased. If the source table's shard
key is used as the columnName
, the result table will be
sharded, in all other cases it will be replicated. Sorting will
properly function only if the result table is replicated or if there is
only one processing node and should not be relied upon in other cases.
Not available if the value of columnName
is an
unrestricted-length string.
tableName
- Name of an existing table or view on which the
operation will be performed.columnName
- Name of the column or an expression containing one or
more column names on which the unique function would
be applied.offset
- A positive integer indicating the number of initial
results to skip (this can be useful for paging through
the results). The default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned. Or END_OF_SET (-9999) to indicate
that the max number of results should be returned. The
number of records returned will never exceed the server's
own limit, defined by the max_get_records_size parameter in the
server configuration. Use hasMoreRecords
to see
if more records exist in the result to be fetched, and
offset
& limit
to request subsequent pages
of results. The default value is -9999.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the table specified in result_table
. If
the collection provided is non-existent, the collection
will be automatically created. If empty, then the table
will be a top-level table.
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. Not available if columnName
is an unrestricted-length string.
RESULT_TABLE_PERSIST
: If true
, then the result
table specified in result_table
will be
persisted and will not expire unless a ttl
is
specified. If false
, then the result table
will be an in-memory table and will expire unless a
ttl
is specified otherwise.
Supported values:
The default value is FALSE
.
RESULT_TABLE_FORCE_REPLICATED
: Force the result table
to be replicated (ignores any sharding). Must be used in
combination with the result_table
option.
Supported values:
The default value is FALSE
.
RESULT_TABLE_GENERATE_PK
: If true
then set a
primary key for the result table. Must be used in
combination with the result_table
option.
Supported values:
The default value is FALSE
.
TTL
: Sets the TTL of the table specified in result_table
.
CHUNK_SIZE
: Indicates the number of records per chunk
to be used for the result table. Must be used in
combination with the result_table
option.
VIEW_ID
: ID of view of which the result table will be a
member. The default value is ''.
Map
.GPUdbException
- if an error occurs during the operation.AggregateUniqueResponse
public RawAggregateUnpivotResponse aggregateUnpivotRaw(AggregateUnpivotRequest request) throws GPUdbException
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.RawAggregateUnpivotResponse
public AggregateUnpivotResponse aggregateUnpivot(AggregateUnpivotRequest request) throws GPUdbException
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AggregateUnpivotResponse
public AggregateUnpivotResponse aggregateUnpivot(String tableName, List<String> columnNames, String variableColumnName, String valueColumnName, List<String> pivotedColumns, Map<String,String> options) throws GPUdbException
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
tableName
- Name of the table on which the operation will be
performed. Must be an existing table/view.columnNames
- List of column names or expressions. A wildcard '*'
can be used to include all the non-pivoted columns
from the source table.variableColumnName
- Specifies the variable/parameter column name.
The default value is ''.valueColumnName
- Specifies the value column name. The default
value is ''.pivotedColumns
- List of one or more values typically the column
names of the input table. All the columns in the
source table must have the same data type.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the table specified in result_table
. If
the collection provided is non-existent, the collection
will be automatically created. If empty, then the table
will be a top-level table.
RESULT_TABLE
: The name of the table used to store the
results. Has the same naming restrictions as tables. If present, no results are
returned in the response.
RESULT_TABLE_PERSIST
: If true
, then the result
table specified in result_table
will be
persisted and will not expire unless a ttl
is
specified. If false
, then the result table
will be an in-memory table and will expire unless a
ttl
is specified otherwise.
Supported values:
The default value is FALSE
.
EXPRESSION
: Filter expression to apply to the table
prior to unpivot processing.
ORDER_BY
: Comma-separated list of the columns to be
sorted by; e.g. 'timestamp asc, x desc'. The columns
specified must be present in input table. If any alias
is given for any column name, the alias must be used,
rather than the original column name. The default value
is ''.
CHUNK_SIZE
: Indicates the number of records per chunk
to be used for the result table. Must be used in
combination with the result_table
option.
LIMIT
: The number of records to keep. The default
value is ''.
TTL
: Sets the TTL of the table specified in result_table
.
VIEW_ID
: view this result table is part of. The
default value is ''.
MATERIALIZE_ON_GPU
: No longer used. See Resource Management Concepts for
information about how resources are managed, Tier
Strategy Concepts for how resources are targeted for
VRAM, and Tier Strategy Usage for how to specify
a table's priority in VRAM.
Supported values:
The default value is FALSE
.
CREATE_INDEXES
: Comma-separated list of columns on
which to create indexes on the table specified in result_table
. The columns specified must be present in
output column names. If any alias is given for any
column name, the alias must be used, rather than the
original column name.
RESULT_TABLE_FORCE_REPLICATED
: Force the result table
to be replicated (ignores any sharding). Must be used in
combination with the result_table
option.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.AggregateUnpivotResponse
public AlterResourceGroupResponse alterResourceGroup(AlterResourceGroupRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AlterResourceGroupResponse
public AlterResourceGroupResponse alterResourceGroup(String name, Map<String,Map<String,String>> tierAttributes, String ranking, String adjoiningResourceGroup, Map<String,String> options) throws GPUdbException
name
- Name of the group to be altered. Must be an existing
resource group name.tierAttributes
- Optional map containing tier names and their
respective attribute group limits. The only
valid attribute limit that can be set is
max_memory (in bytes) for the VRAM & RAM tiers.
For instance, to set max VRAM capacity to 1GB and
max RAM capacity to 10GB, use:
{'VRAM':{'max_memory':'1000000000'},
'RAM':{'max_memory':'10000000000'}}
MAX_MEMORY
: Maximum amount of memory usable in
the given tier at one time for this group.
Map
.ranking
- If the resource group ranking is to be updated, this
indicates the relative ranking among existing resource
groups where this resource group will be moved; leave
blank if not changing the ranking. When using before
or after
, specify which resource group
this one will be inserted before or after in adjoiningResourceGroup
.
Supported values:
The default value is EMPTY_STRING
.adjoiningResourceGroup
- If ranking
is before
or
after
, this field indicates the
resource group before or after which the
current group will be placed; otherwise,
leave blank. The default value is ''.options
- Optional parameters.
MAX_CPU_CONCURRENCY
: Maximum number of simultaneous
threads that will be used to execute a request for this
group.
MAX_SCHEDULING_PRIORITY
: Maximum priority of a
scheduled task for this group.
MAX_TIER_PRIORITY
: Maximum priority of a tiered object
for this group.
IS_DEFAULT_GROUP
: If true
, this request applies
to the global default resource group. It is an error for
this field to be true
when the name
field is also populated.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.AlterResourceGroupResponse
public AlterRoleResponse alterRole(AlterRoleRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AlterRoleResponse
public AlterRoleResponse alterRole(String name, String action, String value, Map<String,String> options) throws GPUdbException
name
- Name of the role to be altered. Must be an existing role.action
- Modification operation to be applied to the role.
Supported values:
SET_RESOURCE_GROUP
: Sets the resource group for an
internal role. The resource group must exist, otherwise,
an empty string assigns the role to the default resource
group.
value
- The value of the modification, depending on action
.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AlterRoleResponse
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:
SUBTASK_CONCURRENCY_LIMIT
: Sets the maximum
number of simultaneous threads allocated to a
given request, on each rank. Note that thread
allocation may also be limted by resource
group limits and/or system load.
CHUNK_SIZE
: Sets the number of records per
chunk to be used for all new tables.
EVICT_COLUMNS
: Attempts to evict columns
from memory to the persistent store. Value
string is a semicolon separated list of
entries, each entry being a table name
optionally followed by a comma and a comma
separated list of column names to attempt to
evict. An empty value string will attempt to
evict all tables and columns.
EXECUTION_MODE
: Sets the execution_mode for
kernel executions to the specified string
value. Possible values are host, device,
default (engine decides) or an integer value
that indicates max chunk size to exec on host
EXTERNAL_FILES_DIRECTORY
: Sets the root
directory path where external table data
files are accessed from. Path must exist on
the head node
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 the name of the table for which to
clear the cached results, or an empty string
to clear the cached results for all tables.
COMMUNICATOR_TEST
: Invoke the communicator
test and report timing results. Value string
is is a semicolon separated list of
[key]=[value] expressions. Expressions are:
num_transactions=[num] where num is the
number of request reply transactions to
invoke per test; message_size=[bytes] where
bytes is the size in bytes of the messages to
send; check_values=[enabled] where if enabled
is true the value of the messages received
are verified.
SET_MESSAGE_TIMERS_ENABLED
: Enables the
communicator test to collect additional
timing statistics when the value string is
true
. Disables the collection when
the value string is false
Supported values:
NETWORK_SPEED
: Invoke the network speed test
and report timing results. Value string is a
semicolon-separated list of [key]=[value]
expressions. Valid expressions are:
seconds=[time] where time is the time in
seconds to run the test; data_size=[bytes]
where bytes is the size in bytes of the block
to be transferred; threads=[number of
threads]; to_ranks=[space-separated list of
ranks] where the list of ranks is the ranks
that rank 0 will send data to and get data
from. If to_ranks is unspecified then all
worker ranks are used.
REQUEST_TIMEOUT
: Number of minutes after
which filtering (e.g., filter(String, String, String, Map)
)
and aggregating (e.g., aggregateGroupByRaw(AggregateGroupByRequest)
)
queries will timeout. The default value is
'20'.
MAX_GET_RECORDS_SIZE
: The maximum number of
records the database will serve for a given
data retrieval call. The default value is
'20000'.
ENABLE_AUDIT
: Enable or disable auditing.
AUDIT_HEADERS
: Enable or disable auditing of
request headers.
AUDIT_BODY
: Enable or disable auditing of
request bodies.
AUDIT_DATA
: Enable or disable auditing of
request data.
SHADOW_AGG_SIZE
: Size of the shadow
aggregate chunk cache in bytes. The default
value is '10000000'.
SHADOW_FILTER_SIZE
: Size of the shdow filter
chunk cache in bytes. The default value is
'10000000'.
SYNCHRONOUS_COMPRESSION
: compress vector on
set_compression (instead of waiting for
background thread). The default value is
'false'.
ENABLE_OVERLAPPED_EQUI_JOIN
: Enable
overlapped-equi-join filter. The default
value is 'true'.
ENABLE_COMPOUND_EQUI_JOIN
: Enable
compound-equi-join filter plan type. The
default value is 'false'.
options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AlterSystemPropertiesResponse
public AlterTableResponse alterTable(AlterTableRequest request) throws GPUdbException
Manage a table's columns--a column can be added, removed, or have its type and properties modified, including whether it is compressed or not.
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Create or delete a foreign key on a particular column.
Manage a range-partitioned or a manual list-partitioned table's partitions.
Set (or reset) the tier strategy of a table or view.
Refresh and manage the refresh mode of a materialized view.
Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
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
Manage a table's columns--a column can be added, removed, or have its type and properties modified, including whether it is compressed or not.
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Create or delete a foreign key on a particular column.
Manage a range-partitioned or a manual list-partitioned table's partitions.
Set (or reset) the tier strategy of a table or view.
Refresh and manage the refresh mode of a materialized view.
Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
tableName
- Table on which the operation will be performed. Must
be an existing table, view, or collection.action
- Modification operation to be applied
Supported values:
ALLOW_HOMOGENEOUS_TABLES
: No longer supported; action
will be ignored.
CREATE_INDEX
: Creates either a column (attribute) index or chunk skip index, depending on the
specified index_type
, on the column name
specified in value
. If this column already has
the specified index, an error will be returned.
DELETE_INDEX
: Deletes either a column (attribute) index or chunk skip index, depending on the
specified index_type
, on the column name
specified in value
. If this column does not have
the specified index, an error will be returned.
MOVE_TO_COLLECTION
: Moves a table or view into a
collection named value
. If the collection
provided is non-existent, the collection will be
automatically created. If value
is empty, then
the table or view will be top-level.
PROTECTED
: Sets whether the given tableName
should be protected or not. The value
must be either 'true' or 'false'.
RENAME_TABLE
: Renames a table, view or collection to
value
. Has the same naming restrictions as tables.
TTL
:
Sets the time-to-live in minutes of the table,
view, or collection specified in tableName
.
ADD_COLUMN
: Adds the column specified in value
to the table specified in tableName
. Use column_type
and column_properties
in options
to set the column's type and properties,
respectively.
CHANGE_COLUMN
: Changes type and properties of the column
specified in value
. Use column_type
and
column_properties
in options
to set the
column's type and properties, respectively. Note that
primary key and/or shard key columns cannot be changed.
All unchanging column properties must be listed for the
change to take place, e.g., to add dictionary encoding to
an existing 'char4' column, both 'char4' and 'dict' must
be specified in the options
map.
SET_COLUMN_COMPRESSION
: Modifies the compression setting on the column
specified in value
to the compression type
specified in compression_type
.
DELETE_COLUMN
: Deletes the column specified in value
from the table specified in tableName
.
CREATE_FOREIGN_KEY
: Creates a foreign key specified in value
using the format '(source_column_name [, ...]) references
target_table_name(primary_key_column_name [, ...]) [as
foreign_key_name]'.
DELETE_FOREIGN_KEY
: Deletes a foreign key. The value
should
be the foreign_key_name specified when creating the key
or the complete string used to define it.
ADD_PARTITION
: Adds the partition specified in value
, to either a range-partitioned or manual list-partitioned table.
REMOVE_PARTITION
: Removes the partition specified in
value
(and relocates all of its data to the
default partition) from either a range-partitioned or manual list-partitioned table.
DELETE_PARTITION
: Deletes the partition specified in
value
(and all of its data) from either a range-partitioned or manual list-partitioned table.
SET_GLOBAL_ACCESS_MODE
: Sets the global access mode
(i.e. locking) for the table specified in tableName
. Specify the access mode in value
.
Valid modes are 'no_access', 'read_only', 'write_only'
and 'read_write'.
REFRESH
: Replays all the table creation commands
required to create this materialized view.
SET_REFRESH_METHOD
: Sets the method by which this materialized view is refreshed to the
method specified in value
- one of 'manual',
'periodic', 'on_change'.
SET_REFRESH_START_TIME
: Sets the time to start periodic
refreshes of this materialized view to the datetime
string specified in value
with format 'YYYY-MM-DD
HH:MM:SS'. Subsequent refreshes occur at the specified
time + N * the refresh period.
SET_REFRESH_PERIOD
: Sets the time interval in seconds at
which to refresh this materialized view to the value
specified in value
. Also, sets the refresh
method to periodic if not already set.
REMOVE_TEXT_SEARCH_ATTRIBUTES
: Removes text search attribute from all columns.
SET_STRATEGY_DEFINITION
: Sets the tier strategy for the table and its
columns to the one specified in value
, replacing
the existing tier strategy in its entirety. See tier strategy usage for format and tier strategy examples for examples.
value
- The value of the modification, depending on action
. For example, if action
is add_column
, this would be the column name; while the
column's definition would be covered by the column_type
, column_properties
, column_default_value
, and add_column_expression
in options
. If action
is ttl
, it
would be the number of minutes for the new TTL. If action
is refresh
, this field would be blank.options
- Optional parameters.
ACTION
COLUMN_NAME
TABLE_NAME
COLUMN_DEFAULT_VALUE
: When adding a column, set a
default value for existing records. For nullable
columns, the default value will be null, regardless of
data type.
COLUMN_PROPERTIES
: When adding or changing a column,
set the column properties (strings, separated by a
comma: data, store_only, text_search, char8, int8 etc).
COLUMN_TYPE
: When adding or changing a column, set the
column type (strings, separated by a comma: int, double,
string, null etc).
COMPRESSION_TYPE
: When setting column compression
(set_column_compression
for action
),
compression type to use: none
(to use no
compression) or a valid compression type.
Supported values:
The default value is SNAPPY
.
COPY_VALUES_FROM_COLUMN
: Deprecated. Please use add_column_expression
instead.
RENAME_COLUMN
: When changing a column, specify new
column name.
VALIDATE_CHANGE_COLUMN
: When changing a column,
validate the change before applying it. If true
,
then validate all values. A value too large (or too
long) for the new type will prevent any change. If
false
, then when a value is too large or long,
it will be truncated.
Supported values:
The default value is TRUE
.
UPDATE_LAST_ACCESS_TIME
: Indicates whether the time-to-live (TTL) expiration
countdown timer should be reset to the table's TTL.
Supported values:
TRUE
:
Reset the expiration countdown timer to the table's
configured TTL.
FALSE
: Don't reset the timer; expiration countdown will
continue from where it is, as if the table had not been
accessed.
TRUE
.
ADD_COLUMN_EXPRESSION
: When adding a column, an
optional expression to use for the new column's values.
Any valid expression may be used, including one
containing references to existing columns in the same
table.
STRATEGY_DEFINITION
: Optional parameter for specifying
the tier strategy for the table and its
columns when action
is set_strategy_definition
, replacing the existing tier
strategy in its entirety. See tier strategy usage for format and tier strategy examples for examples.
This option will be ignored if value
is also
specified.
INDEX_TYPE
: Type of index to create, when action
is create_index
, or to delete, when
action
is delete_index
.
Supported values:
COLUMN
: Create or delete a column (attribute) index.
CHUNK_SKIP
: Create or delete a chunk skip index.
COLUMN
.
Map
.GPUdbException
- if an error occurs during the operation.AlterTableResponse
public AlterTableColumnsResponse alterTableColumns(AlterTableColumnsRequest request) throws GPUdbException
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table's columns--a column can be added, removed, or have its type and properties modified.
Set or unset compression for a column.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AlterTableColumnsResponse
public AlterTableColumnsResponse alterTableColumns(String tableName, List<Map<String,String>> columnAlterations, Map<String,String> options) throws GPUdbException
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table's columns--a column can be added, removed, or have its type and properties modified.
Set or unset compression for a column.
tableName
- Table on which the operation will be performed. Must
be an existing table or view.columnAlterations
- list of alter table add/delete/change column
requests - all for the same table.
each request is a map that
includes 'column_name', 'action' and the
options specific for the action,
note that the same options as
in alter table requests but in the same map as
the column name and the action. For example:
[{'column_name':'col_1','action':'change_column','rename_column':'col_2'},
{'column_name':'col_1','action':'add_column',
'type':'int','default_value':'1'}
]options
- Optional parameters.GPUdbException
- if an error occurs during the operation.AlterTableColumnsResponse
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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AlterTableMetadataResponse
public AlterTierResponse alterTier(AlterTierRequest request) throws GPUdbException
To disable watermark-based eviction, set both high_watermark
and low_watermark
to 100.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AlterTierResponse
public AlterTierResponse alterTier(String name, Map<String,String> options) throws GPUdbException
To disable watermark-based eviction, set both high_watermark
and low_watermark
to 100.
name
- Name of the tier to be altered. Must be an existing tier
group name.options
- Optional parameters.
CAPACITY
: Maximum size in bytes this tier may hold at
once.
HIGH_WATERMARK
: Threshold of usage of this tier's
resource that, once exceeded, will trigger
watermark-based eviction from this tier.
LOW_WATERMARK
: Threshold of resource usage that, once
fallen below after crossing the high_watermark
,
will cease watermark-based eviction from this tier.
Map
.GPUdbException
- if an error occurs during the operation.AlterTierResponse
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.
SET_RESOURCE_GROUP
: Sets the resource group for an
internal user. The resource group must exist, otherwise,
an empty string assigns the user to the default resource
group.
value
- The value of the modification, depending on action
.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.AlterUserResponse
public AppendRecordsResponse appendRecords(AppendRecordsRequest request) throws GPUdbException
sourceTableName
) to a particular target table (specified by tableName
). The field map (specified by fieldMap
) holds the
user specified map of target table column names with their mapped source
column names.request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.AppendRecordsResponse
public AppendRecordsResponse appendRecords(String tableName, String sourceTableName, Map<String,String> fieldMap, Map<String,String> options) throws GPUdbException
sourceTableName
) to a particular target table (specified by tableName
). The field map (specified by fieldMap
) holds the
user specified map of target table column names with their mapped source
column names.tableName
- The table name for the records to be appended. Must be
an existing table.sourceTableName
- The source table name to get records from. Must
be an existing table name.fieldMap
- Contains the mapping of column names from the target
table (specified by tableName
) as the keys, and
corresponding column names or expressions (e.g.,
'col_name+1') from the source table (specified by
sourceTableName
). Must be existing column names
in source table and target table, and their types must
be matched. For details on using expressions, see Expressions.options
- Optional parameters.
OFFSET
: A positive integer indicating the number of
initial results to skip from sourceTableName
.
Default is 0. The minimum allowed value is 0. The
maximum allowed value is MAX_INT. The default value is
'0'.
LIMIT
: A positive integer indicating the maximum number
of results to be returned from sourceTableName
.
Or END_OF_SET (-9999) to indicate that the max number of
results should be returned. The default value is
'-9999'.
EXPRESSION
: Optional filter expression to apply to the
sourceTableName
. The default value is ''.
ORDER_BY
: Comma-separated list of the columns to be
sorted by from source table (specified by sourceTableName
), e.g., 'timestamp asc, x desc'. The
order_by
columns do not have to be present in
fieldMap
. The default value is ''.
UPDATE_ON_EXISTING_PK
: Specifies the record collision
policy for inserting the source table records (specified
by sourceTableName
) into the target table
(specified by tableName
) table with a primary key. If set to true
,
any existing target table record with primary key values
that match those of a source table record being inserted
will be replaced by that new record. If set to false
, any existing target table record with primary
key values that match those of a source table record
being inserted will remain unchanged and the new record
discarded. If the specified table does not have a
primary key, then this option is ignored.
Supported values:
The default value is FALSE
.
TRUNCATE_STRINGS
: If set to true
, it allows
inserting longer strings into smaller charN string
columns by truncating the longer strings to fit.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.AppendRecordsResponse
public ClearStatisticsResponse clearStatistics(ClearStatisticsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ClearStatisticsResponse
public ClearStatisticsResponse clearStatistics(String tableName, String columnName, Map<String,String> options) throws GPUdbException
tableName
- Name of a table. Must be an existing table. The
default value is ''.columnName
- Name of the column in tableName
for which to
clear statistics. The column must be from an existing
table. An empty string clears statistics for all
columns in the table. The default value is ''.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.ClearStatisticsResponse
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,
though this behavior is be prevented by default via
gpudb.conf parameter 'disable_clear_all'. The default
value is ''.authorization
- No longer used. User can pass an empty string.
The default value is ''.options
- Optional parameters.
NO_ERROR_IF_NOT_EXISTS
: If true
and if the
table specified in tableName
does not exist no
error is returned. If false
and if the table
specified in tableName
does not exist then an
error is returned.
Supported values:
The default value is FALSE
.
Map
.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. The default value is an empty
Map
.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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.ClearTriggerResponse
public CollectStatisticsResponse collectStatistics(CollectStatisticsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.CollectStatisticsResponse
public CollectStatisticsResponse collectStatistics(String tableName, List<String> columnNames, Map<String,String> options) throws GPUdbException
tableName
- Name of a table. Must be an existing table.columnNames
- List of one or more column names in tableName
for which to collect statistics
(cardinality, mean value, etc.).options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.CollectStatisticsResponse
public CreateExternalTableResponse createExternalTable(CreateExternalTableRequest request) throws GPUdbException
GPUdbException
public CreateExternalTableResponse createExternalTable(String tableName, List<String> filepaths, Map<String,String> createTableOptions, Map<String,String> options) throws GPUdbException
GPUdbException
public CreateGraphResponse createGraph(CreateGraphRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.CreateGraphResponse
public CreateGraphResponse createGraph(String graphName, boolean directedGraph, List<String> nodes, List<String> edges, List<String> weights, List<String> restrictions, Map<String,String> options) throws GPUdbException
graphName
- Name of the graph resource to generate.directedGraph
- If set to true
, the graph will be
directed. If set to false
, the graph will
not be directed. Consult Directed Graphs for more
details.
Supported values:
The default value is TRUE
.nodes
- Nodes represent fundamental topological units of a graph.
Nodes must be specified using
identifiers;
identifiers are grouped as
combinations.
Identifiers can be used with existing column names, e.g.,
'table.column AS NODE_ID', expressions, e.g.,
'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or
constant values, e.g.,
'{9, 10, 11} AS NODE_ID'.
If using constant values in an identifier combination, the
number of values
specified must match across the combination.edges
- Edges represent the required fundamental topological unit
of
a graph that typically connect nodes. Edges must be
specified using
identifiers;
identifiers are grouped as
combinations.
Identifiers can be used with existing column names, e.g.,
'table.column AS EDGE_ID', expressions, e.g.,
'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant
values, e.g.,
"{'family', 'coworker'} AS EDGE_LABEL".
If using constant values in an identifier combination, the
number of values
specified must match across the combination.weights
- Weights represent a method of informing the graph solver
of
the cost of including a given edge in a solution.
Weights must be specified
using
identifiers;
identifiers are grouped as
combinations.
Identifiers can be used with existing column names,
e.g.,
'table.column AS WEIGHTS_EDGE_ID', expressions, e.g.,
'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant
values, e.g.,
'{4, 15} AS WEIGHTS_VALUESPECIFIED'.
If using constant values in an identifier combination,
the number of values specified
must match across the combination.restrictions
- Restrictions represent a method of informing the
graph
solver which edges and/or nodes should be ignored
for the solution. Restrictions
must be specified using
identifiers;
identifiers are grouped as
combinations.
Identifiers can be used with existing column names,
e.g.,
'table.column AS RESTRICTIONS_EDGE_ID',
expressions, e.g.,
'column/2 AS RESTRICTIONS_VALUECOMPARED', or
constant values, e.g.,
'{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'.
If using constant values in an identifier
combination, the number of values
specified must match across the combination.options
- Optional parameters.
RESTRICTION_THRESHOLD_VALUE
: Value-based restriction
comparison. Any node or edge with a
RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value
will not be included in the
graph.
MERGE_TOLERANCE
: If node geospatial positions are input
(e.g., WKTPOINT, X, Y), determines the minimum
separation allowed between unique nodes. If nodes are
within the tolerance of each other, they will be merged
as a single node. The default value is '1.0E-4'.
MIN_X
: Minimum x (longitude) value for spatial graph
associations. The default value is '-180.0'.
MAX_X
: Maximum x (longitude) value for spatial graph
associations. The default value is '180.0'.
MIN_Y
: Minimum y (latitude) value for spatial graph
associations. The default value is '-90.0'.
MAX_Y
: Maximum y (latitude) value for spatial graph
associations. The default value is '90.0'.
RECREATE
: If set to true
and the graph (using
graphName
) already exists, the graph is deleted
and recreated.
Supported values:
The default value is FALSE
.
MODIFY
: If set to true
, recreate
is set
to true
, and the graph (specified using graphName
) already exists, the graph is updated with
the given components.
Supported values:
The default value is FALSE
.
EXPORT_CREATE_RESULTS
: If set to true
, returns
the graph topology in the response as arrays.
Supported values:
The default value is FALSE
.
ENABLE_GRAPH_DRAW
: If set to true
, adds a
'EDGE_WKTLINE' column identifier to the specified graph_table
so the graph can be viewed via WMS; for
social and non-geospatial graphs, the 'EDGE_WKTLINE'
column identifier will be populated with spatial
coordinates derived from a flattening layout algorithm
so the graph can still be viewed.
Supported values:
The default value is FALSE
.
SAVE_PERSIST
: If set to true
, the graph will be
saved in the persist directory (see the config reference for more
information). If set to false
, the graph will be
removed when the graph server is shutdown.
Supported values:
The default value is FALSE
.
SYNC_DB
: If set to true
and save_persist
is set to true
, the graph will be
fully reconstructed upon a database restart and be
updated to align with any source table(s) updates made
since the creation of the graph. If dynamic graph
updates upon table inserts are desired, use add_table_monitor
instead.
Supported values:
The default value is FALSE
.
ADD_TABLE_MONITOR
: Adds a table monitor to every table
used in the creation of the graph; this table monitor
will trigger the graph to update dynamically upon
inserts to the source table(s). Note that upon database
restart, if save_persist
is also set to true
, the graph will be fully reconstructed and the
table monitors will be reattached. For more details on
table monitors, see createTableMonitor(String, Map)
.
Supported values:
The default value is FALSE
.
GRAPH_TABLE
: If specified, the created graph is also
created as a table with the given name and following
identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID',
'EDGE_NODE2_ID'. If left blank, no table is created.
The default value is ''.
REMOVE_LABEL_ONLY
: When RESTRICTIONS on labeled
entities requested, if set to true this will NOT delete
the entity but only the label associated with the
entity. Otherwise (default), it'll delete the label AND
the entity.
Supported values:
The default value is FALSE
.
ADD_TURNS
: Adds dummy 'pillowed' edges around
intersection nodes where there are more than three edges
so that additional weight penalties can be imposed by
the solve endpoints. (increases the total number of
edges).
Supported values:
The default value is FALSE
.
TURN_ANGLE
: Value in degrees modifies the thresholds
for attributing right, left, sharp turns, and
intersections. It is the vertical deviation angle from
the incoming edge to the intersection node. The larger
the value, the larger the threshold for sharp turns and
intersections; the smaller the value, the larger the
threshold for right and left turns; 0 < turn_angle < 90.
The default value is '60'.
Map
.GPUdbException
- if an error occurs during the operation.CreateGraphResponse
public CreateJobResponse createJob(CreateJobRequest request) throws GPUdbException
getJob(GetJobRequest)
.request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.CreateJobResponse
public CreateJobResponse createJob(String endpoint, String requestEncoding, ByteBuffer data, String dataStr, Map<String,String> options) throws GPUdbException
getJob(long, Map)
.endpoint
- Indicates which endpoint to execute, e.g.
'/alter/table'.requestEncoding
- The encoding of the request payload for the job.
Supported values:
The default value is BINARY
.data
- Binary-encoded payload for the job to be run
asynchronously. The payload must contain the relevant
input parameters for the endpoint indicated in endpoint
. Please see the documentation for the
appropriate endpoint to see what values must (or can) be
specified. If this parameter is used, then requestEncoding
must be binary
or snappy
.dataStr
- JSON-encoded payload for the job to be run
asynchronously. The payload must contain the relevant
input parameters for the endpoint indicated in endpoint
. Please see the documentation for the
appropriate endpoint to see what values must (or can) be
specified. If this parameter is used, then requestEncoding
must be json
.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.CreateJobResponse
public CreateJoinTableResponse createJoinTable(CreateJoinTableRequest request) throws GPUdbException
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
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
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
joinTableName
- Name of the join table to be created. Has the
same naming restrictions as tables.tableNames
- The list of table names composing the join.
Corresponds to a SQL statement FROM clause.columnNames
- List of member table columns or column expressions
to be included in the join. Columns can be prefixed
with 'table_id.column_name', where 'table_id' is the
table name or alias. Columns can be aliased via the
syntax 'column_name as alias'. Wild cards '*' can be
used to include all columns across member tables or
'table_id.*' for all of a single table's columns.
Columns and column expressions composing the join
must be uniquely named or aliased--therefore, the
'*' wild card cannot be used if column names aren't
unique across all tables.expressions
- An optional list of expressions to combine and
filter the joined tables. Corresponds to a SQL
statement WHERE clause. For details see: expressions. The default value is
an empty List
.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the join. If the collection provided is
non-existent, the collection will be automatically
created. If empty, then the join will be at the top
level. The default value is ''.
MAX_QUERY_DIMENSIONS
: Obsolete in GPUdb v7.0
OPTIMIZE_LOOKUPS
: Use more memory to speed up the
joining of tables.
Supported values:
The default value is FALSE
.
TTL
: Sets the TTL of the join table specified in
joinTableName
.
VIEW_ID
: view this projection is part of. The default
value is ''.
NO_COUNT
: return a count of 0 for the join table for
logging and for show_table. optimization needed for
large overlapped equi-join stencils. The default value
is 'false'.
CHUNK_SIZE
: Maximum number of records per joined-chunk
for this table. Defaults to the gpudb.conf file chunk
size
Map
.GPUdbException
- if an error occurs during the operation.CreateJoinTableResponse
public CreateMaterializedViewResponse createMaterializedView(CreateMaterializedViewRequest request) throws GPUdbException
For materialized view details and examples, see Materialized Views.
The response contains viewId
, which is used to tag each
subsequent operation (projection, union, aggregation, filter, or join)
that will compose the view.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.CreateMaterializedViewResponse
public CreateMaterializedViewResponse createMaterializedView(String tableName, Map<String,String> options) throws GPUdbException
For materialized view details and examples, see Materialized Views.
The response contains viewId
, which is used to tag each
subsequent operation (projection, union, aggregation, filter, or join)
that will compose the view.
tableName
- Name of the table to be created that is the top-level
table of the materialized view.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
table will be a top-level table.
TTL
: Sets the TTL of the table specified in tableName
.
PERSIST
: If true
, then the materialized view
specified in tableName
will be persisted and
will not expire unless a ttl
is specified. If
false
, then the materialized view will be an
in-memory table and will expire unless a ttl
is
specified otherwise.
Supported values:
The default value is FALSE
.
REFRESH_METHOD
: Method by which the join can be
refreshed when the data in underlying member tables have
changed.
Supported values:
MANUAL
: Refresh only occurs when manually requested by
calling alterTable(String, String, String,
Map)
with an 'action' of 'refresh'
ON_QUERY
: For future use.
ON_CHANGE
: If possible, incrementally refresh (refresh
just those records added) whenever an insert, update,
delete or refresh of input table is done. A full
refresh is done if an incremental refresh is not
possible.
PERIODIC
: Refresh table periodically at rate specified
by refresh_period
MANUAL
.
REFRESH_PERIOD
: When refresh_method
is periodic
, specifies the period in seconds at which
refresh occurs
REFRESH_START_TIME
: When refresh_method
is
periodic
, specifies the first time at which a
refresh is to be done. Value is a datetime string with
format 'YYYY-MM-DD HH:MM:SS'.
Map
.GPUdbException
- if an error occurs during the operation.CreateMaterializedViewResponse
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. The default value
is an empty Map
.command
- The command (excluding arguments) that will be invoked
when the proc is executed. It will be invoked from the
directory containing the proc files
and may be
any command that can be resolved from that directory. It
need not refer to a file actually in that directory; for
example, it could be 'java' if the proc is a Java
application; however, any necessary external programs
must be preinstalled on every database node. If the
command refers to a file in that directory, it must be
preceded with './' as per Linux convention. If not
specified, and exactly one file is provided in files
, that file will be invoked. The default value is
''.args
- An array of command-line arguments that will be passed to
command
when the proc is executed. The default
value is an empty List
.options
- Optional parameters.
MAX_CONCURRENCY_PER_NODE
: The maximum number of
concurrent instances of the proc that will be executed
per node. 0 allows unlimited concurrency. The default
value is '0'.
Map
.GPUdbException
- if an error occurs during the operation.CreateProcResponse
public CreateProjectionResponse createProjection(CreateProjectionRequest request) throws GPUdbException
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window
functions, which can perform operations like moving averages, are
available through this endpoint as well as getRecordsByColumnRaw(GetRecordsByColumnRequest)
.
A projection can be created with a different shard
key than the source table. By specifying shard_key
, the
projection will be sharded according to the specified columns,
regardless of how the source table is sharded. The source table can
even be unsharded or replicated.
If tableName
is empty, selection is performed against a
single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
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
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window
functions, which can perform operations like moving averages, are
available through this endpoint as well as getRecordsByColumnRaw(GetRecordsByColumnRequest)
.
A projection can be created with a different shard
key than the source table. By specifying shard_key
, the
projection will be sharded according to the specified columns,
regardless of how the source table is sharded. The source table can
even be unsharded or replicated.
If tableName
is empty, selection is performed against a
single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
tableName
- Name of the existing table on which the projection is
to be applied. An empty table name creates a
projection from a single-row virtual table, where
columns specified should be constants or constant
expressions.projectionName
- Name of the projection to be created. Has the
same naming restrictions as tables.columnNames
- List of columns from tableName
to be
included in the projection. Can include derived
columns. Can be specified as aliased via the syntax
'column_name as alias'.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection to which the projection is
to be assigned as a child. If the collection provided is
non-existent, the collection will be automatically
created. If empty, then the projection will be at the
top level. The default value is ''.
EXPRESSION
: An optional filter expression to be applied to the source
table prior to the projection. The default value is ''.
IS_REPLICATED
: If true
then the projection will
be replicated even if the source table is not.
Supported values:
The default value is FALSE
.
LIMIT
: The number of records to keep. The default
value is ''.
ORDER_BY
: Comma-separated list of the columns to be
sorted by; e.g. 'timestamp asc, x desc'. The columns
specified must be present in columnNames
. If
any alias is given for any column name, the alias must
be used, rather than the original column name. The
default value is ''.
MATERIALIZE_ON_GPU
: No longer used. See Resource Management Concepts for
information about how resources are managed, Tier
Strategy Concepts for how resources are targeted for
VRAM, and Tier Strategy Usage for how to specify
a table's priority in VRAM.
Supported values:
The default value is FALSE
.
CHUNK_SIZE
: Indicates the number of records per chunk
to be used for this projection.
CREATE_INDEXES
: Comma-separated list of columns on
which to create indexes on the projection. The columns
specified must be present in columnNames
. If
any alias is given for any column name, the alias must
be used, rather than the original column name.
TTL
: Sets the TTL of the projection specified in
projectionName
.
SHARD_KEY
: Comma-separated list of the columns to be
sharded on; e.g. 'column1, column2'. The columns
specified must be present in columnNames
. If
any alias is given for any column name, the alias must
be used, rather than the original column name. The
default value is ''.
PERSIST
: If true
, then the projection specified
in projectionName
will be persisted and will not
expire unless a ttl
is specified. If false
, then the projection will be an in-memory table
and will expire unless a ttl
is specified
otherwise.
Supported values:
The default value is FALSE
.
PRESERVE_DICT_ENCODING
: If true
, then columns
that were dict encoded in the source table will be dict
encoded in the projection.
Supported values:
The default value is TRUE
.
RETAIN_PARTITIONS
: Determines whether the created
projection will retain the partitioning scheme from the
source table.
Supported values:
The default value is FALSE
.
VIEW_ID
: ID of view of which this projection is a
member. The default value is ''.
Map
.GPUdbException
- if an error occurs during the operation.CreateProjectionResponse
public CreateResourceGroupResponse createResourceGroup(CreateResourceGroupRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.CreateResourceGroupResponse
public CreateResourceGroupResponse createResourceGroup(String name, Map<String,Map<String,String>> tierAttributes, String ranking, String adjoiningResourceGroup, Map<String,String> options) throws GPUdbException
name
- Name of the group to be created. Must contain only letters,
digits, and underscores, and cannot begin with a digit.
Must not match existing resource group name.tierAttributes
- Optional map containing tier names and their
respective attribute group limits. The only
valid attribute limit that can be set is
max_memory (in bytes) for the VRAM & RAM tiers.
For instance, to set max VRAM capacity to 1GB and
max RAM capacity to 10GB, use:
{'VRAM':{'max_memory':'1000000000'},
'RAM':{'max_memory':'10000000000'}}
MAX_MEMORY
: Maximum amount of memory usable in
the given tier at one time for this group.
Map
.ranking
- Indicates the relative ranking among existing resource
groups where this new resource group will be placed.
When using before
or after
, specify
which resource group this one will be inserted before or
after in adjoiningResourceGroup
.
Supported values:
adjoiningResourceGroup
- If ranking
is before
or
after
, this field indicates the
resource group before or after which the
current group will be placed; otherwise,
leave blank. The default value is ''.options
- Optional parameters.
MAX_CPU_CONCURRENCY
: Maximum number of simultaneous
threads that will be used to execute a request for this
group.
MAX_SCHEDULING_PRIORITY
: Maximum priority of a
scheduled task for this group.
MAX_TIER_PRIORITY
: Maximum priority of a tiered object
for this group.
Map
.GPUdbException
- if an error occurs during the operation.CreateResourceGroupResponse
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.
RESOURCE_GROUP
: Name of an existing resource group to
associate with this user
Map
.GPUdbException
- if an error occurs during the operation.CreateRoleResponse
public CreateTableResponse createTable(CreateTableRequest request) throws GPUdbException
typeId
, which must 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.
A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.
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 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.
A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.
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 the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
table will be a top-level table.
IS_COLLECTION
: Indicates whether the new table to be
created will be a collection.
Supported values:
The default value is FALSE
.
DISALLOW_HOMOGENEOUS_TABLES
: No longer supported; value
will be ignored.
Supported values:
The default value is FALSE
.
IS_REPLICATED
: For a table, affects the distribution scheme for the table's
data. If true and the given type has no explicit shard key defined, the table will be
replicated. If false, the table will
be sharded according to the shard key
specified in the given typeId
, or randomly sharded, if no shard key is
specified. Note that a type containing a shard key
cannot be used to create a replicated table.
Supported values:
The default value is FALSE
.
FOREIGN_KEYS
: Semicolon-separated list of foreign keys, of the format
'(source_column_name [, ...]) references
target_table_name(primary_key_column_name [, ...]) [as
foreign_key_name]'.
FOREIGN_SHARD_KEY
: Foreign shard key of the format
'source_column references shard_by_column from
target_table(primary_key_column)'.
PARTITION_TYPE
: Partitioning scheme to use.
Supported values:
RANGE
: Use range partitioning.
INTERVAL
: Use interval partitioning.
LIST
: Use list partitioning.
HASH
: Use hash partitioning.
PARTITION_KEYS
: Comma-separated list of partition keys,
which are the columns or column expressions by which
records will be assigned to partitions defined by partition_definitions
.
PARTITION_DEFINITIONS
: Comma-separated list of
partition definitions, whose format depends on the
choice of partition_type
. See range partitioning, interval partitioning, list partitioning, or hash partitioning for example formats.
IS_AUTOMATIC_PARTITION
: If true, a new partition will
be created for values which don't fall into an existing
partition. Currently only supported for list partitions.
Supported values:
The default value is FALSE
.
TTL
:
For a table, sets the TTL of the table specified in tableName
.
CHUNK_SIZE
: Indicates the number of records per chunk
to be used for this table.
IS_RESULT_TABLE
: For a table, indicates whether the
table is an in-memory table. A result table cannot
contain store_only, text_search, or string columns
(charN columns are acceptable), and it will not be
retained if the server is restarted.
Supported values:
The default value is FALSE
.
STRATEGY_DEFINITION
: The tier strategy for the table and its
columns. See tier strategy usage for format and tier strategy examples for examples.
Map
.GPUdbException
- if an error occurs during the operation.CreateTableResponse
public CreateTableMonitorResponse createTableMonitor(CreateTableMonitorRequest request) throws GPUdbException
tableName
) and forwards event notifications to subscribers via
ZMQ.
After this call completes, subscribe to the returned topicId
on
the
ZMQ table monitor port (default 9002). Each time an operation of the
given type
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 corresponds to the event and can be
decoded
using typeSchema
. The monitor will continue to run (regardless
of
whether or not there are any subscribers) until deactivated with
clearTableMonitor(ClearTableMonitorRequest)
.
For more information on table monitors, see Table Monitors.
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 event notifications to subscribers via
ZMQ.
After this call completes, subscribe to the returned topicId
on
the
ZMQ table monitor port (default 9002). Each time an operation of the
given type
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 corresponds to the event and can be
decoded
using typeSchema
. The monitor will continue to run (regardless
of
whether or not there are any subscribers) until deactivated with
clearTableMonitor(String, Map)
.
For more information on table monitors, see Table Monitors.
tableName
- Name of the table to monitor. Must not refer to a
collection.options
- Optional parameters.
EVENT
: Type of modification event on the target table
to be monitored by this table monitor.
Supported values:
INSERT
: Get notifications of new record insertions. The
new row images are forwarded to the subscribers.
UPDATE
: Get notifications of update operations. The
modified row count information is forwarded to the
subscribers.
DELETE
: Get notifications of delete operations. The
deleted row count information is forwarded to the
subscribers.
INSERT
.
Map
.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. The default value is an empty
Map
.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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.CreateTriggerByRangeResponse
public CreateTypeResponse createType(CreateTypeRequest request) throws GPUdbException
data
and store_only
.
A single primary key and/or single shard
key can be set across one or more columns. If a primary key is
specified, then a uniqueness constraint is enforced, in that only a
single object can exist with a given primary key. When inserting
data into a
table with a primary key, depending on the parameters in the request,
incoming objects with primary key values that match existing objects
will either overwrite (i.e. update) the existing object or will be
skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
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
.
A single primary key and/or single shard
key can be set across one or more columns. If a primary key is
specified, then a uniqueness constraint is enforced, in that only a
single object can exist with a given primary key. When inserting
data into a
table with a primary key, depending on the parameters in the request,
incoming objects with primary key values that match existing objects
will either overwrite (i.e. update) the existing object or will be
skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
typeDefinition
- a JSON string describing the columns of the type
to be registered.label
- A user-defined description string which can be used to
differentiate between tables and types with otherwise
identical schemas.properties
- Each key-value pair specifies the properties to use
for a given column where the key is the column name.
All keys used must be relevant column names for the
given table. Specifying any property overrides the
default properties for that column (which is based on
the column's data type).
Valid values are:
DATA
: Default property for all numeric and string
type columns; makes the column available for GPU
queries.
TEXT_SEARCH
: Valid only for 'string' columns.
Enables full text search for string columns. Can be
set independently of data
and store_only
.
STORE_ONLY
: Persist the column value but do not make
it available to queries (e.g. filter(String, String, String, Map)
)-i.e. it
is mutually exclusive to the data
property.
Any 'bytes' type column must have a store_only
property. This property reduces system
memory usage.
DISK_OPTIMIZED
: Works in conjunction with the data
property for string columns. This property
reduces system disk usage by disabling reverse string
lookups. Queries like filter(String,
String, String, Map)
, filterByList(String, String, Map, Map)
, and
filterByValue(String, String, boolean,
double, String, String, Map)
work as usual but
aggregateUniqueRaw(AggregateUniqueRequest)
and
aggregateGroupByRaw(AggregateGroupByRequest)
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.
ULONG
: Valid only for 'string' columns. It
represents an unsigned long integer data type. The
string can only be interpreted as an unsigned long
data type with minimum value of zero, and maximum
value of 18446744073709551615.
DECIMAL
: Valid only for 'string' columns. It
represents a SQL type NUMERIC(19, 4) data type.
There can be up to 15 digits before the decimal point
and up to four digits in the fractional part. The
value can be positive or negative (indicated by a
minus sign at the beginning). This property is
mutually exclusive with the text_search
property.
DATE
: Valid only for 'string' columns. Indicates
that this field represents a date and will be
provided in the format 'YYYY-MM-DD'. The allowable
range is 1000-01-01 through 2900-01-01. This
property is mutually exclusive with the text_search
property.
TIME
: Valid only for 'string' columns. Indicates
that this field represents a time-of-day and will be
provided in the format 'HH:MM:SS.mmm'. The allowable
range is 00:00:00.000 through 23:59:59.999. This
property is mutually exclusive with the text_search
property.
DATETIME
: Valid only for 'string' columns.
Indicates that this field represents a datetime and
will be provided in the format 'YYYY-MM-DD
HH:MM:SS.mmm'. The allowable range is 1000-01-01
00:00:00.000 through 2900-01-01 23:59:59.999. This
property is mutually exclusive with the text_search
property.
CHAR1
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 1
character.
CHAR2
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 2
characters.
CHAR4
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 4
characters.
CHAR8
: This property provides optimized memory, disk
and query performance for string columns. Strings
with this property must be no longer than 8
characters.
CHAR16
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 16
characters.
CHAR32
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 32
characters.
CHAR64
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 64
characters.
CHAR128
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 128
characters.
CHAR256
: This property provides optimized memory,
disk and query performance for string columns.
Strings with this property must be no longer than 256
characters.
INT8
: This property provides optimized memory and
query performance for int columns. Ints with this
property must be between -128 and +127 (inclusive)
INT16
: This property provides optimized memory and
query performance for int columns. Ints with this
property must be between -32768 and +32767
(inclusive)
IPV4
: This property provides optimized memory, disk
and query performance for string columns representing
IPv4 addresses (i.e. 192.168.1.1). Strings with this
property must be of the form: A.B.C.D where A, B, C
and D are in the range of 0-255.
WKT
: Valid only for 'string' and 'bytes' columns.
Indicates that this field contains geospatial
geometry objects in Well-Known Text (WKT) or
Well-Known Binary (WKB) format.
PRIMARY_KEY
: This property indicates that this
column will be part of (or the entire) primary key.
SHARD_KEY
: This property indicates that this column
will be part of (or the entire) shard key.
NULLABLE
: This property indicates that this column
is nullable. However, setting this property is
insufficient for making the column nullable. The
user must declare the type of the column as a union
between its regular type and 'null' in the avro
schema for the record type in typeDefinition
.
For example, if a column is of type integer and is
nullable, then the entry for the column in the avro
schema must be: ['int', 'null'].
The C++, C#, Java, and Python APIs have built-in
convenience for bypassing setting the avro schema by
hand. For those languages, one can use this property
as usual and not have to worry about the avro schema
for the record.
DICT
: This property indicates that this column
should be dictionary encoded. It can only be
used in conjunction with restricted string (charN),
int, long or date columns. Dictionary encoding is
best for columns where the cardinality (the number of
unique values) is expected to be low. This property
can save a large amount of memory.
INIT_WITH_NOW
: For 'date', 'time', 'datetime', or
'timestamp' column types, replace empty strings and
invalid timestamps with 'NOW()' upon insert.
options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.CreateTypeResponse
public CreateUnionResponse createUnion(CreateUnionRequest request) throws GPUdbException
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
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
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
tableName
- Name of the table to be created. Has the same naming
restrictions as tables.tableNames
- The list of table names to merge. Must contain the
names of one or more existing tables.inputColumnNames
- The list of columns from each of the
corresponding input tables.outputColumnNames
- The list of names of the columns to be stored
in the output table.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the output table. If the collection provided is
non-existent, the collection will be automatically
created. If empty, the output table will be a top-level
table. The default value is ''.
MATERIALIZE_ON_GPU
: No longer used. See Resource Management Concepts for
information about how resources are managed, Tier
Strategy Concepts for how resources are targeted for
VRAM, and Tier Strategy Usage for how to specify
a table's priority in VRAM.
Supported values:
The default value is FALSE
.
MODE
: If merge_views
, then this operation will
merge the provided views. All tableNames
must be
views from the same underlying base table.
Supported values:
UNION_ALL
: Retains all rows from the specified tables.
UNION
: Retains all unique rows from the specified
tables (synonym for union_distinct
).
UNION_DISTINCT
: Retains all unique rows from the
specified tables.
EXCEPT
: Retains all unique rows from the first table
that do not appear in the second table (only works on 2
tables).
EXCEPT_ALL
: Retains all rows(including duplicates) from
the first table that do not appear in the second table
(only works on 2 tables).
INTERSECT
: Retains all unique rows that appear in both
of the specified tables (only works on 2 tables).
INTERSECT_ALL
: Retains all rows(including duplicates)
that appear in both of the specified tables (only works
on 2 tables).
MERGE_VIEWS
: Merge two or more views (or views of
views) of the same base data set into a new view. If
this mode is selected inputColumnNames
AND
outputColumnNames
must be empty. The resulting
view would match the results of a SQL OR operation,
e.g., if filter 1 creates a view using the expression 'x
= 20' and filter 2 creates a view using the expression
'x <= 10', then the merge views operation creates a new
view using the expression 'x = 20 OR x <= 10'.
UNION_ALL
.
CHUNK_SIZE
: Indicates the number of records per chunk
to be used for this output table.
CREATE_INDEXES
: Comma-separated list of columns on
which to create indexes on the output table. The
columns specified must be present in outputColumnNames
.
TTL
:
Sets the TTL of the output table specified in
tableName
.
PERSIST
: If true
, then the output table
specified in tableName
will be persisted and
will not expire unless a ttl
is specified. If
false
, then the output table will be an
in-memory table and will expire unless a ttl
is
specified otherwise.
Supported values:
The default value is FALSE
.
VIEW_ID
: ID of view of which this output table is a
member. The default value is ''.
FORCE_REPLICATED
: If true
, then the output
table specified in tableName
will be replicated
even if the source tables are not.
Supported values:
The default value is FALSE
.
Map
.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. The default value is an empty
Map
.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.
RESOURCE_GROUP
: Name of an existing resource group to
associate with this user
Map
.GPUdbException
- if an error occurs during the operation.CreateUserInternalResponse
public DeleteGraphResponse deleteGraph(DeleteGraphRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.DeleteGraphResponse
public DeleteGraphResponse deleteGraph(String graphName, Map<String,String> options) throws GPUdbException
graphName
- Name of the graph to be deleted.options
- Optional parameters.
DELETE_PERSIST
: If set to true
, the graph is
removed from the server and persist. If set to false
, the graph is removed from the server but is left
in persist. The graph can be reloaded from persist if it
is recreated with the same 'graph_name'.
Supported values:
The default value is TRUE
.
Map
.GPUdbException
- if an error occurs during the operation.DeleteGraphResponse
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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.DeleteProcResponse
public DeleteRecordsResponse deleteRecords(DeleteRecordsRequest request) throws GPUdbException
expressions
(matching multiple records), a single record identified by
record_id
options, or all records when using delete_all_records
. Note that the three selection criteria are
mutually exclusive. This operation cannot be run on a collection or a
view. The operation is synchronous meaning that a response will not be
available until the request is completely processed and all the matching
records are deleted.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), a single record identified by
record_id
options, or all records when using delete_all_records
. Note that the three selection criteria are
mutually exclusive. This operation cannot be run on a collection or a
view. The operation is synchronous meaning that a response will not be
available until the request is completely processed and all the matching
records are deleted.tableName
- Name of the table from which to delete records. The
set must be a currently existing table and not a
collection or a view.expressions
- A list of the actual predicates, one for each
select; format should follow the guidelines provided
here. Specifying one or more
expressions
is mutually exclusive to
specifying record_id
in the options
.options
- Optional parameters.
GLOBAL_EXPRESSION
: An optional global expression to
reduce the search space of the expressions
. The
default value is ''.
RECORD_ID
: A record ID identifying a single record,
obtained at the time of insertion of the record
or by calling getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)
with the *return_record_ids* option. This option cannot
be used to delete records from replicated tables.
DELETE_ALL_RECORDS
: If set to true
, all records
in the table will be deleted. If set to false
,
then the option is effectively ignored.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.DeleteRecordsResponse
public DeleteResourceGroupResponse deleteResourceGroup(DeleteResourceGroupRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.DeleteResourceGroupResponse
public DeleteResourceGroupResponse deleteResourceGroup(String name, Map<String,String> options) throws GPUdbException
name
- Name of the resource group to be deleted.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.DeleteResourceGroupResponse
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. The default value is an empty
Map
.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. The default value is an empty
Map
.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. The default value is an empty Map
.binParams
- A map containing named binary parameters to pass to
the proc. Each key/value pair specifies the name of a
parameter and its value. The default value is an
empty Map
.inputTableNames
- Names of the tables containing data to be passed
to the proc. Each name specified must be the
name of a currently existing table. If no table
names are specified, no data will be passed to
the proc. The default value is an empty List
.inputColumnNames
- Map of table names from inputTableNames
to lists of names of columns from those tables
that will be passed to the proc. Each column
name specified must be the name of an existing
column in the corresponding table. If a table
name from inputTableNames
is not
included, all columns from that table will be
passed to the proc. The default value is an
empty Map
.outputTableNames
- Names of the tables to which output data from
the proc will be written. If a specified table
does not exist, it will automatically be
created with the same schema as the
corresponding table (by order) from inputTableNames
, excluding any primary and
shard keys. If a specified table is a
non-persistent result table, it must not have
primary or shard keys. If no table names are
specified, no output data can be returned from
the proc. The default value is an empty List
.options
- Optional parameters.
CACHE_INPUT
: A comma-delimited list of table names from
inputTableNames
from which input data will be
cached for use in subsequent calls to executeProc(String, Map, Map, List, Map, List,
Map)
with the use_cached_input
option. Cached
input data will be retained until the proc status is
cleared with the clear_complete
option of showProcStatus(String, Map)
and all proc
instances using the cached data have completed. The
default value is ''.
USE_CACHED_INPUT
: A comma-delimited list of run IDs (as
returned from prior calls to executeProc(String, Map, Map, List, Map, List,
Map)
) of running or completed proc instances from which
input data cached using the cache_input
option
will be used. Cached input data will not be used for any
tables specified in inputTableNames
, but data
from all other tables cached for the specified run IDs
will be passed to the proc. If the same table was cached
for multiple specified run IDs, the cached data from the
first run ID specified in the list that includes that
table will be used. The default value is ''.
KIFS_INPUT_DIRS
: A comma-delimited list of KiFS
directories whose local files will be made directly
accessible to the proc through the API. (All KiFS files,
local or not, are also accessible through the file
system below the KiFS mount point.) Each name specified
must the name of an existing KiFS directory. The
default value is ''.
RUN_TAG
: A string that, if not empty, can be used in
subsequent calls to showProcStatus(String,
Map)
or killProc(String, Map)
to identify
the proc instance. The default value is ''.
Map
.GPUdbException
- if an error occurs during the operation.ExecuteProcResponse
public RawExecuteSqlResponse executeSqlRaw(ExecuteSqlRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.RawExecuteSqlResponse
public ExecuteSqlResponse executeSql(ExecuteSqlRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ExecuteSqlResponse
public ExecuteSqlResponse executeSql(String statement, long offset, long limit, String requestSchemaStr, List<ByteBuffer> data, Map<String,String> options) throws GPUdbException
statement
- SQL statement (query, DML, or DDL) to be executedoffset
- A positive integer indicating the number of initial
results to skip (this can be useful for paging through
the results). The default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned, or END_OF_SET (-9999) to indicate
that the maximum number of results allowed by the server
should be returned. The number of records returned will
never exceed the server's own limit, defined by the max_get_records_size parameter in the
server configuration. Use hasMoreRecords
to see
if more records exist in the result to be fetched, and
offset
& limit
to request subsequent pages
of results. The default value is -9999.requestSchemaStr
- Avro schema of data
. The default value
is ''.data
- An array of binary-encoded data for the records to be
binded to the SQL query. The default value is an empty
List
.options
- Optional parameters.
PARALLEL_EXECUTION
: If false
, disables the
parallel step execution of the given query.
Supported values:
The default value is TRUE
.
COST_BASED_OPTIMIZATION
: If false
, disables the
cost-based optimization of the given query.
Supported values:
The default value is FALSE
.
PLAN_CACHE
: If false
, disables plan caching for
the given query.
Supported values:
The default value is TRUE
.
RULE_BASED_OPTIMIZATION
: If false
, disables
rule-based rewrite optimizations for the given query
Supported values:
The default value is TRUE
.
RESULTS_CACHING
: If false
, disables caching of
the results of the given query
Supported values:
The default value is TRUE
.
PAGING_TABLE
: When empty or the specified paging table
not exists, the system will create a paging table and
return when query output has more records than the user
asked. If the paging table exists in the system, the
records from the paging table are returned without
evaluating the query.
PAGING_TABLE_TTL
: Sets the TTL of the paging table.
DISTRIBUTED_JOINS
: If true
, enables the use of
distributed joins in servicing the given query. Any
query requiring a distributed join will succeed, though
hints can be used in the query to change the
distribution of the source data to allow the query to
succeed.
Supported values:
The default value is FALSE
.
DISTRIBUTED_OPERATIONS
: If true
, enables the
use of distributed operations in servicing the given
query. Any query requiring a distributed join will
succeed, though hints can be used in the query to change
the distribution of the source data to allow the query
to succeed.
Supported values:
The default value is FALSE
.
SSQ_OPTIMIZATION
: If false
, scalar subqueries
will be translated into joins
Supported values:
The default value is TRUE
.
LATE_MATERIALIZATION
: If true
, Joins/Filters
results will always be materialized ( saved to result
tables format)
Supported values:
The default value is FALSE
.
TTL
:
Sets the TTL of the intermediate result tables
used in query execution.
UPDATE_ON_EXISTING_PK
: Can be used to customize
behavior when the updated primary key value already
exists as described in insertRecordsRaw(RawInsertRecordsRequest)
.
Supported values:
The default value is FALSE
.
PRESERVE_DICT_ENCODING
: If true
, then columns
that were dict encoded in the source table will be dict
encoded in the projection table.
Supported values:
The default value is TRUE
.
VALIDATE_CHANGE_COLUMN
: When changing a column using
alter table, validate the change before applying it. If
true
, then validate all values. A value too
large (or too long) for the new type will prevent any
change. If false
, then when a value is too large
or long, it will be truncated.
Supported values:
The default value is TRUE
.
PREPARE_MODE
: If true
, compiles a query into an
execution plan and saves it in query cache. Query
execution is not performed and an empty response will be
returned to user
Supported values:
The default value is FALSE
.
VIEW_ID
: NO_COUNT
: Map
.GPUdbException
- if an error occurs during the operation.ExecuteSqlResponse
public FilterResponse filter(FilterRequest request) throws GPUdbException
viewName
.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
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 Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
tableName
- Name of the table to filter. This may be the name of
a collection, a table, or a view (when chaining
queries). If filtering a collection, all child tables
where the filter expression is valid will be filtered;
the filtered result tables will then be placed in a
collection specified by viewName
.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables. The default value is ''.expression
- The select expression to filter the specified table.
For details see Expressions.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
VIEW_ID
: view this filtered-view is part of. The
default value is ''.
TTL
: Sets
the TTL of the view specified in viewName
.
Map
.GPUdbException
- if an error occurs during the operation.FilterResponse
public FilterByAreaResponse filterByArea(FilterByAreaRequest request) throws GPUdbException
viewName
passed in as
part of the input.request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.FilterByAreaResponse
public FilterByAreaResponse filterByArea(String tableName, String viewName, String xColumnName, List<Double> xVector, String yColumnName, List<Double> yVector, Map<String,String> options) throws GPUdbException
viewName
passed in as
part of the input.tableName
- Name of the table to filter. This may be the name of
a collection, a table, or a view (when chaining
queries). If filtering a collection, all child tables
where the filter expression is valid will be filtered;
the filtered result tables will then be placed in a
collection specified by viewName
.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables. The default value is ''.xColumnName
- Name of the column containing the x values to be
filtered.xVector
- List of x coordinates of the vertices of the polygon
representing the area to be filtered.yColumnName
- Name of the column containing the y values to be
filtered.yVector
- List of y coordinates of the vertices of the polygon
representing the area to be filtered.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.GPUdbException
- if an error occurs during the operation.FilterByAreaResponse
public FilterByAreaGeometryResponse filterByAreaGeometry(FilterByAreaGeometryRequest request) throws GPUdbException
viewName
passed in as part of the input.request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.FilterByAreaGeometryResponse
public FilterByAreaGeometryResponse filterByAreaGeometry(String tableName, String viewName, String columnName, List<Double> xVector, List<Double> yVector, Map<String,String> options) throws GPUdbException
viewName
passed in as part of the input.tableName
- Name of the table to filter. This may be the name of
a collection, a table, or a view (when chaining
queries). If filtering a collection, all child tables
where the filter expression is valid will be filtered;
the filtered result tables will then be placed in a
collection specified by viewName
.viewName
- If provided, then this will be the name of the view
containing the results. Must not be an already existing
collection, table or view. The default value is ''.columnName
- Name of the geospatial geometry column to be
filtered.xVector
- List of x coordinates of the vertices of the polygon
representing the area to be filtered.yVector
- List of y coordinates of the vertices of the polygon
representing the area to be filtered.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.GPUdbException
- if an error occurs during the operation.FilterByAreaGeometryResponse
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. The default value is ''.xColumnName
- Name of the column on which to perform the bounding
box query. Must be a valid numeric column.minX
- Lower bound for the column chosen by xColumnName
.
Must be less than or equal to maxX
.maxX
- Upper bound for xColumnName
. Must be greater than
or equal to minX
.yColumnName
- Name of a column on which to perform the bounding
box query. Must be a valid numeric column.minY
- Lower bound for yColumnName
. Must be less than or
equal to maxY
.maxY
- Upper bound for yColumnName
. Must be greater than
or equal to minY
.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.GPUdbException
- if an error occurs during the operation.FilterByBoxResponse
public FilterByBoxGeometryResponse filterByBoxGeometry(FilterByBoxGeometryRequest 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.FilterByBoxGeometryResponse
public FilterByBoxGeometryResponse filterByBoxGeometry(String tableName, String viewName, String columnName, double minX, double maxX, 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. Must not be an
already existing collection, table or view. The
default value is ''.columnName
- Name of the geospatial geometry column to be
filtered.minX
- Lower bound for the x-coordinate of the rectangular box.
Must be less than or equal to maxX
.maxX
- Upper bound for the x-coordinate of the rectangular box.
Must be greater than or equal to minX
.minY
- Lower bound for the y-coordinate of the rectangular box.
Must be less than or equal to maxY
.maxY
- Upper bound for the y-coordinate of the rectangular box.
Must be greater than or equal to minY
.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.GPUdbException
- if an error occurs during the operation.FilterByBoxGeometryResponse
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 geospatial geometry column.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables. The default value is ''.columnName
- Name of the column to be used in the filter. Must be
a geospatial geometry column.inputWkt
- A geometry in WKT format that will be used to filter
the objects in tableName
. The default value is
''.operation
- The geometric filtering operation to perform
Supported values:
CONTAINS
: Matches records that contain the given WKT
in inputWkt
, i.e. the given WKT is within the
bounds of a record's geometry.
CROSSES
: Matches records that cross the given WKT.
DISJOINT
: Matches records that are disjoint from the
given WKT.
EQUALS
: Matches records that are the same as the
given WKT.
INTERSECTS
: Matches records that intersect the given
WKT.
OVERLAPS
: Matches records that overlap the given WKT.
TOUCHES
: Matches records that touch the given WKT.
WITHIN
: Matches records that are within the given
WKT.
options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.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 name of
a collection, a table, or a view (when chaining
queries). If filtering a collection, all child tables
where the filter expression is valid will be filtered;
the filtered result tables will then be placed in a
collection specified by viewName
.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables. The default value is ''.columnValuesMap
- List of values for the corresponding column in
the tableoptions
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
FILTER_MODE
: String indicating the filter mode, either
'in_list' or 'not_in_list'.
Supported values:
IN_LIST
: The filter will match all items that are in
the provided list(s).
NOT_IN_LIST
: The filter will match all items that are
not in the provided list(s).
IN_LIST
.
Map
.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.
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.
tableName
- Name of the table on which the filter by radius
operation will be performed. Must be an existing
table.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables. The default value is ''.xColumnName
- Name of the column to be used for the x-coordinate
(the longitude) of the center.xCenter
- Value of the longitude of the center. Must be within
[-180.0, 180.0]. The minimum allowed value is -180. The
maximum allowed value is 180.yColumnName
- Name of the column to be used for the
y-coordinate-the latitude-of the center.yCenter
- Value of the latitude of the center. Must be within
[-90.0, 90.0]. The minimum allowed value is -90. The
maximum allowed value is 90.radius
- The radius of the circle within which the search will be
performed. Must be a non-zero positive value. It is in
meters; so, for example, a value of '42000' means 42 km.
The minimum allowed value is 0. The maximum allowed value
is MAX_INT.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.GPUdbException
- if an error occurs during the operation.FilterByRadiusResponse
public FilterByRadiusGeometryResponse filterByRadiusGeometry(FilterByRadiusGeometryRequest request) throws GPUdbException
viewName
is passed in as part of the request.request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.FilterByRadiusGeometryResponse
public FilterByRadiusGeometryResponse filterByRadiusGeometry(String tableName, String viewName, String columnName, double xCenter, double yCenter, double radius, Map<String,String> options) throws GPUdbException
viewName
is passed in as part of the request.tableName
- Name of the table on which the filter by radius
operation will be performed. Must be an existing
table.viewName
- If provided, then this will be the name of the view
containing the results. Must not be an already existing
collection, table or view. The default value is ''.columnName
- Name of the geospatial geometry column to be
filtered.xCenter
- Value of the longitude of the center. Must be within
[-180.0, 180.0]. The minimum allowed value is -180. The
maximum allowed value is 180.yCenter
- Value of the latitude of the center. Must be within
[-90.0, 90.0]. The minimum allowed value is -90. The
maximum allowed value is 90.radius
- The radius of the circle within which the search will be
performed. Must be a non-zero positive value. It is in
meters; so, for example, a value of '42000' means 42 km.
The minimum allowed value is 0. The maximum allowed value
is MAX_INT.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.GPUdbException
- if an error occurs during the operation.FilterByRadiusGeometryResponse
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. The default value is ''.columnName
- Name of a column on which the operation would be
applied.lowerBound
- Value of the lower bound (inclusive).upperBound
- Value of the upper bound (inclusive).options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.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 a track present.viewName
- If provided, then this will be the name of the view
containing the results. Has the same naming
restrictions as tables. The default value is ''.trackId
- The ID of the track which will act as the filtering
points. Must be an existing track within the given
table.targetTrackIds
- Up to one track ID to intersect with the "filter"
track. If any provided, it must be an valid track
ID within the given set.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
SPATIAL_RADIUS
: A positive number passed as a string
representing the radius of the search area centered
around each track point's geospatial coordinates. The
value is interpreted in meters. Required parameter.
TIME_RADIUS
: A positive number passed as a string
representing the maximum allowable time difference
between the timestamps of a filtered object and the
given track's points. The value is interpreted in
seconds. Required parameter.
SPATIAL_DISTANCE_METRIC
: A string representing the
coordinate system to use for the spatial search
criteria. Acceptable values are 'euclidean' and
'great_circle'. Optional parameter; default is
'euclidean'.
Supported values:
Map
.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. The default value is ''.expression
- The expression with which to filter the table.mode
- The string filtering mode to apply. See below for details.
Supported values:
SEARCH
: Full text search query with wildcards and boolean
operators. Note that for this mode, no column can be
specified in columnNames
; all string columns of the
table that have text search enabled will be searched.
EQUALS
: Exact whole-string match (accelerated).
CONTAINS
: Partial substring match (not accelerated). If
the column is a string type (non-charN) and the number of
records is too large, it will return 0.
STARTS_WITH
: Strings that start with the given expression
(not accelerated). If the column is a string type
(non-charN) and the number of records is too large, it will
return 0.
REGEX
:
Full regular expression search (not accelerated). If the
column is a string type (non-charN) and the number of
records is too large, it will return 0.
columnNames
- List of columns on which to apply the filter.
Ignored for 'search' mode.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
CASE_SENSITIVE
: If 'false' then string filtering will
ignore case. Does not apply to 'search' mode.
Supported values:
The default value is TRUE
.
Map
.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. The default value is ''.columnName
- Name of the column by whose value the data will be
filtered from the table designated by tableName
.sourceTableName
- Name of the table whose data will be compared
against in the table called tableName
.
Must be an existing table.sourceTableColumnName
- Name of the column in the sourceTableName
whose values will be used
as the filter for table tableName
.
Must be a geospatial geometry column if in
'spatial' mode; otherwise, Must match the
type of the columnName
.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
FILTER_MODE
: String indicating the filter mode, either
in_table
or not_in_table
.
Supported values:
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. The default value is '0'.
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. The
default value is '0'.
MAX_PARTITION_SCORE
: Maximum number of points * edges
in a partition. Only relevant for spatial
mode.
The default value is '8000000'.
X_COLUMN_NAME
: Name of column containing x value of
point being filtered in spatial
mode. The
default value is 'x'.
Y_COLUMN_NAME
: Name of column containing y value of
point being filtered in spatial
mode. The
default value is 'y'.
Map
.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. The default value is ''.isString
- Indicates whether the value being searched for is
string or numeric.value
- The value to search for. The default value is 0.valueStr
- The string value to search for. The default value is
''.columnName
- Name of a column on which the filter by value would
be applied.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created view. If the collection
provided is non-existent, the collection will be
automatically created. If empty, then the newly created
view will be top-level.
Map
.GPUdbException
- if an error occurs during the operation.FilterByValueResponse
public GetJobResponse getJob(GetJobRequest request) throws GPUdbException
createJob(CreateJobRequest)
for starting an asynchronous job.
Some fields of the response are filled only after the submitted job has
finished execution.request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.GetJobResponse
public GetJobResponse getJob(long jobId, Map<String,String> options) throws GPUdbException
createJob(String, String, ByteBuffer, String, Map)
for starting
an asynchronous job. Some fields of the response are filled only after
the submitted job has finished execution.jobId
- A unique identifier for the job whose status and result is
to be fetched.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.GetJobResponse
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 default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned. Or END_OF_SET (-9999) to indicate
that the max number of results should be returned. The
number of records returned will never exceed the server's
own limit, defined by the max_get_records_size parameter in the
server configuration. Use hasMoreRecords
to see
if more records exist in the result to be fetched, and
offset
& limit
to request subsequent pages
of results. The default value is -9999.options
- EXPRESSION
: Optional filter expression to apply to the
table.
FAST_INDEX_LOOKUP
: Indicates if indexes should be used
to perform the lookup for a given expression if
possible. Only applicable if there is no sorting, the
expression contains only equivalence comparisons based
on existing tables indexes and the range of requested
values is from [0 to END_OF_SET].
Supported values:
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
.
Map
.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 default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned. Or END_OF_SET (-9999) to indicate
that the max number of results should be returned. The
number of records returned will never exceed the server's
own limit, defined by the max_get_records_size parameter in the
server configuration. Use hasMoreRecords
to see
if more records exist in the result to be fetched, and
offset
& limit
to request subsequent pages
of results. The default value is -9999.options
- EXPRESSION
: Optional filter expression to apply to the
table.
FAST_INDEX_LOOKUP
: Indicates if indexes should be used
to perform the lookup for a given expression if
possible. Only applicable if there is no sorting, the
expression contains only equivalence comparisons based
on existing tables indexes and the range of requested
values is from [0 to END_OF_SET].
Supported values:
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
.
Map
.GPUdbException
- if an error occurs during the operation.GetRecordsResponse
public RawGetRecordsByColumnResponse getRecordsByColumnRaw(GetRecordsByColumnRequest request) throws GPUdbException
offset
and limit
parameters.
Window
functions, which can perform operations like moving averages, are
available through this endpoint as well as createProjection(CreateProjectionRequest)
.
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If tableName
is empty, selection is performed against a
single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
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
offset
and limit
parameters.
Window
functions, which can perform operations like moving averages, are
available through this endpoint as well as createProjection(CreateProjectionRequest)
.
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If tableName
is empty, selection is performed against a
single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
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
offset
and limit
parameters.
Window
functions, which can perform operations like moving averages, are
available through this endpoint as well as createProjection(String, String, List, Map)
.
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If tableName
is empty, selection is performed against a
single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
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. An empty table name retrieves one record
from a single-row virtual table, where columns
specified should be constants or constant expressions.
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 default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned, or END_OF_SET (-9999) to indicate
that the maximum number of results allowed by the server
should be returned. The number of records returned will
never exceed the server's own limit, defined by the max_get_records_size parameter in the
server configuration. Use hasMoreRecords
to see
if more records exist in the result to be fetched, and
offset
& limit
to request subsequent pages
of results. The default value is -9999.options
- EXPRESSION
: Optional filter expression to apply to the
table.
SORT_BY
: Optional column that the data should be sorted
by. Used in conjunction with sort_order
. The
order_by
option can be used in lieu of sort_by
/ sort_order
. The default value is ''.
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
.
ORDER_BY
: Comma-separated list of the columns to be
sorted by as well as the sort direction, e.g.,
'timestamp asc, x desc'. The default value is ''.
CONVERT_WKTS_TO_WKBS
: If true, then WKT string columns
will be returned as WKB bytes.
Supported values:
The default value is FALSE
.
Map
.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 default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
series/tracks to be returned. Or END_OF_SET (-9999) to
indicate that the max number of results should be
returned. The default value is 250.options
- Optional parameters. The default value is an empty
Map
.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 default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
series/tracks to be returned. Or END_OF_SET (-9999) to
indicate that the max number of results should be
returned. The default value is 250.options
- Optional parameters. The default value is an empty
Map
.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 default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned. The
number of records returned will never exceed the server's
own limit, defined by the max_get_records_size parameter in the
server configuration. Use offset
& limit
to request subsequent pages of results. The default value
is -9999.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
.
Map
.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 default value is 0.The minimum allowed
value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of
results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned. The
number of records returned will never exceed the server's
own limit, defined by the max_get_records_size parameter in the
server configuration. Use offset
& limit
to request subsequent pages of results. The default value
is -9999.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
.
Map
.GPUdbException
- if an error occurs during the operation.GetRecordsFromCollectionResponse
public GetVectortileResponse getVectortile(GetVectortileRequest request) throws GPUdbException
GPUdbException
public GetVectortileResponse getVectortile(List<String> tableNames, List<String> columnNames, Map<String,List<String>> layers, int tileX, int tileY, int zoom, Map<String,String> options) throws GPUdbException
GPUdbException
public GrantPermissionProcResponse grantPermissionProc(GrantPermissionProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.GrantPermissionProcResponse
public GrantPermissionProcResponse grantPermissionProc(String name, String permission, String procName, 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:
PROC_EXECUTE
: Execute access to the proc.
procName
- Name of the proc to which the permission grants access.
Must be an existing proc, or an empty string to grant
access to all procs.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.GrantPermissionProcResponse
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_USER_ADMIN
: Access to administer users and
roles that do not have system_admin permission.
SYSTEM_WRITE
: Read and write access to all tables.
SYSTEM_READ
: Read-only access to all tables.
options
- Optional parameters. The default value is an empty
Map
.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
- Optional filter expression to apply to this
grant. Only rows that match the filter will be
affected. The default value is ''.options
- Optional parameters.
COLUMNS
: Apply security to these columns,
comma-separated. The default value is ''.
Map
.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. The default value is an empty
Map
.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. The default value is an empty
Map
.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. The default value is an empty
Map
.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. The default value is an empty
Map
.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.
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.
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.
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.
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
.
TRUNCATE_STRINGS
: If set to true
, any strings
which are too long for their target charN string columns
will be truncated to fit.
Supported values:
The default value is FALSE
.
RETURN_INDIVIDUAL_ERRORS
: If set to true
,
success will always be returned, and any errors found
will be included in the info map. The
"bad_record_indices" entry is a comma-separated list of
bad records (0-based). And if so, there will also be an
"error_N" entry for each record with an error, where N
is the index (0-based).
Supported values:
The default value is FALSE
.
ALLOW_PARTIAL_BATCH
: If set to true
, all
correct records will be inserted and incorrect records
will be rejected and reported. Otherwise, the entire
batch will be rejected if any records are incorrect.
Supported values:
The default value is FALSE
.
DRY_RUN
: If set to true
, no data will be saved
and any errors will be returned.
Supported values:
The default value is FALSE
.
Map
.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.
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
.
TRUNCATE_STRINGS
: If set to true
, any strings
which are too long for their target charN string columns
will be truncated to fit.
Supported values:
The default value is FALSE
.
RETURN_INDIVIDUAL_ERRORS
: If set to true
,
success will always be returned, and any errors found
will be included in the info map. The
"bad_record_indices" entry is a comma-separated list of
bad records (0-based). And if so, there will also be an
"error_N" entry for each record with an error, where N
is the index (0-based).
Supported values:
The default value is FALSE
.
ALLOW_PARTIAL_BATCH
: If set to true
, all
correct records will be inserted and incorrect records
will be rejected and reported. Otherwise, the entire
batch will be rejected if any records are incorrect.
Supported values:
The default value is FALSE
.
DRY_RUN
: If set to true
, no data will be saved
and any errors will be returned.
Supported values:
The default value is FALSE
.
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.InsertRecordsResponse
public InsertRecordsFromFilesResponse insertRecordsFromFiles(InsertRecordsFromFilesRequest request) throws GPUdbException
For CSV files, there are two loading schemes: positional and name-based.
The name-based loading scheme is enabled when the file has a header
present and text_has_header
is set to true
. In this
scheme, the source file(s) field names must match the target table's
column names exactly; however, the source file can have more fields than
the target table has columns. If error_handling
is set to permissive
, the source file can have fewer fields than the target table
has columns. If the name-based loading scheme is being used, names
matching the file header's names may be provided to columns_to_load
instead of numbers, but ranges are not supported.
Returns once all files are processed.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.InsertRecordsFromFilesResponse
public InsertRecordsFromFilesResponse insertRecordsFromFiles(String tableName, List<String> filepaths, Map<String,String> createTableOptions, Map<String,String> options) throws GPUdbException
For CSV files, there are two loading schemes: positional and name-based.
The name-based loading scheme is enabled when the file has a header
present and text_has_header
is set to true
. In this
scheme, the source file(s) field names must match the target table's
column names exactly; however, the source file can have more fields than
the target table has columns. If error_handling
is set to permissive
, the source file can have fewer fields than the target table
has columns. If the name-based loading scheme is being used, names
matching the file header's names may be provided to columns_to_load
instead of numbers, but ranges are not supported.
Returns once all files are processed.
tableName
- Name of the table into which the data will be
inserted. If the table does not exist, the table will
be created using either an existing type_id
or
the type inferred from the file.filepaths
- Absolute or relative filepath(s) from where files will
be loaded. Relative filepaths are relative to the
defined external_files_directory parameter
in the server configuration. The filepaths may include
wildcards (*). If the first path ends in .tsv, the
text delimiter will be defaulted to a tab character.
If the first path ends in .psv, the text delimiter
will be defaulted to a pipe character (|).createTableOptions
- Options used when creating a new table.
TYPE_ID
: ID of a currently registered type. The default value is
''.
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 the
collection provided is non-existent, the
collection will be automatically created. If
empty, then the newly created table will be a
top-level table.
IS_REPLICATED
: For a table, affects the distribution scheme for the
table's data. If true and the given type has
no explicit shard key defined, the
table will be replicated. If false, the
table will be sharded according to the
shard key specified in the given type_id
, or randomly sharded, if no
shard key is specified. Note that a type
containing a shard key cannot be used to
create a replicated table.
Supported values:
The default value is FALSE
.
FOREIGN_KEYS
: Semicolon-separated list of foreign keys, of the format
'(source_column_name [, ...]) references
target_table_name(primary_key_column_name [,
...]) [as foreign_key_name]'.
FOREIGN_SHARD_KEY
: Foreign shard key of the
format 'source_column references
shard_by_column from
target_table(primary_key_column)'.
PARTITION_TYPE
: Partitioning scheme to use.
Supported values:
RANGE
: Use range partitioning.
INTERVAL
: Use interval partitioning.
LIST
: Use list partitioning.
HASH
: Use hash partitioning.
PARTITION_KEYS
: Comma-separated list of
partition keys, which are the columns or
column expressions by which records will be
assigned to partitions defined by partition_definitions
.
PARTITION_DEFINITIONS
: Comma-separated list
of partition definitions, whose format
depends on the choice of partition_type
. See range partitioning, interval partitioning, list partitioning, or hash partitioning for
example formats.
IS_AUTOMATIC_PARTITION
: If true, a new
partition will be created for values which
don't fall into an existing partition.
Currently only supported for list partitions.
Supported values:
The default value is FALSE
.
TTL
: For a table, sets the TTL of the table specified
in tableName
.
CHUNK_SIZE
: Indicates the number of records
per chunk to be used for this table.
IS_RESULT_TABLE
: For a table, indicates
whether the table is an in-memory table. A
result table cannot contain store_only,
text_search, or string columns (charN columns
are acceptable), and it will not be retained
if the server is restarted.
Supported values:
The default value is FALSE
.
STRATEGY_DEFINITION
: The tier strategy for the table
and its columns. See tier strategy usage for
format and tier strategy examples for
examples.
Map
.options
- Optional parameters.
BATCH_SIZE
: Specifies number of records to process
before inserting.
COLUMN_FORMATS
: For each target column specified,
applies the column-property-bound format to the source
data loaded into that column. Each column format will
contain a mapping of one or more of its column
properties to an appropriate format for each property.
Currently supported column properties include date,
time, & datetime. The parameter value must be formatted
as a JSON string of maps of column names to maps of
column properties to their corresponding column formats,
e.g., { "order_date" : { "date" : "%Y.%m.%d" },
"order_time" : { "time" : "%H:%M:%S" } }. See default_column_formats
for valid format syntax.
COLUMNS_TO_LOAD
: For delimited_text
file_type
only. Specifies a comma-delimited list of
column positions or names to load instead of loading all
columns in the file(s); if more than one file is being
loaded, the list of columns will apply to all files.
Column numbers can be specified discretely or as a
range, e.g., a value of '5,7,1..3' will create a table
with the first column in the table being the fifth
column in the file, followed by seventh column in the
file, then the first column through the fourth column in
the file.
DEFAULT_COLUMN_FORMATS
: Specifies the default format to
be applied to source data loaded into columns with the
corresponding column property. This default
column-property-bound format can be overridden by
specifying a column property & format for a given target
column in column_formats
. For each specified
annotation, the format will apply to all columns with
that annotation unless a custom column_formats
for that annotation is specified. The parameter value
must be formatted as a JSON string that is a map of
column properties to their respective column formats,
e.g., { "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }.
Column formats are specified as a string of control
characters and plain text. The supported control
characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's',
which follow the Linux 'strptime()' specification, as
well as 's', which specifies seconds and fractional
seconds (though the fractional component will be
truncated past milliseconds). Formats for the 'date'
annotation must include the 'Y', 'm', and 'd' control
characters. Formats for the 'time' annotation must
include the 'H', 'M', and either 'S' or 's' (but not
both) control characters. Formats for the 'datetime'
annotation meet both the 'date' and 'time' control
character requirements. For example, '{"datetime" :
"%m/%d/%Y %H:%M:%S" }' would be used to interpret text
as "05/04/2000 12:12:11"
DRY_RUN
: If set to true
, no data will be
inserted but the file will be read with the applied
error_handling
mode and the number of valid
records that would be normally inserted are returned.
Supported values:
The default value is FALSE
.
ERROR_HANDLING
: Specifies how errors should be handled
upon insertion.
Supported values:
PERMISSIVE
: Records with missing columns are populated
with nulls if possible; otherwise, the malformed records
are skipped.
IGNORE_BAD_RECORDS
: Malformed records are skipped.
ABORT
: Stops current insertion and aborts entire
operation when an error is encountered.
PERMISSIVE
.
FILE_TYPE
: File type for the file(s).
Supported values:
DELIMITED_TEXT
: Indicates the file(s) are in delimited
text format, e.g., CSV, TSV, PSV, etc.
DELIMITED_TEXT
.
LOADING_MODE
: Specifies how to divide data loading
among nodes.
Supported values:
HEAD
: The head node loads all data. All files must be
available on the head node.
DISTRIBUTED_SHARED
: The worker nodes coordinate loading
a set of files that are available to all of them. All
files must be available on all nodes. This option is
best when there is a shared file system.
DISTRIBUTED_LOCAL
: Each worker node loads all files
that are available to it. This option is best when each
worker node has its own file system.
HEAD
.
TEXT_COMMENT_STRING
: For delimited_text
file_type
only. All lines in the file(s) starting with
the provided string are ignored. The comment string has
no effect unless it appears at the beginning of a line.
The default value is '#'.
TEXT_DELIMITER
: For delimited_text
file_type
only. Specifies the delimiter for values and
columns in the header row (if present). Must be a single
character. The default value is ','.
TEXT_ESCAPE_CHARACTER
: For delimited_text
file_type
only. The character used in the
file(s) to escape certain character sequences in text.
For example, the escape character followed by a literal
'n' escapes to a newline character within the field. Can
be used within quoted string to escape a quote
character. An empty value for this option does not
specify an escape character.
TEXT_HAS_HEADER
: For delimited_text
file_type
only. Indicates whether the delimited text
files have a header row.
Supported values:
The default value is TRUE
.
TEXT_HEADER_PROPERTY_DELIMITER
: For delimited_text
file_type
only. Specifies the
delimiter for column properties in the header row (if
present). Cannot be set to same value as text_delimiter.
The default value is '|'.
TEXT_NULL_STRING
: For delimited_text
file_type
only. The value in the file(s) to treat as a
null value in the database. The default value is ''.
TEXT_QUOTE_CHARACTER
: For delimited_text
file_type
only. The quote character used in the
file(s), typically encompassing a field value. The
character must appear at beginning and end of field to
take effect. Delimiters within quoted fields are not
treated as delimiters. Within a quoted field, double
quotes (") can be used to escape a single literal quote
character. To not have a quote character, specify an
empty string (""). The default value is '"'.
TRUNCATE_TABLE
: If set to true
, truncates the
table specified by tableName
prior to loading
the file(s).
Supported values:
The default value is FALSE
.
NUM_TASKS_PER_RANK
: Optional: number of tasks for
reading file per rank. Default will be
external_file_reader_num_tasks
Map
.GPUdbException
- if an error occurs during the operation.InsertRecordsFromFilesResponse
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. These parameters
take on different meanings depending on the type of the
column. Below follows a more detailed description of
the map:
SEED
: If provided, the internal random number generator
will be initialized with the given value. The minimum
is 0. This allows for the same set of random numbers to
be generated across invocation of this endpoint in case
the user wants to repeat the test. Since options
, is a map of maps, we need an internal map to
provide the seed value. For example, to pass 100 as the
seed value through this parameter, you need something
equivalent to: 'options' = {'seed': { 'value': 100 } }
VALUE
: Pass the seed value here.
ALL
: This key indicates that the specifications relayed
in the internal map are to be applied to all columns of
the records.
MIN
: For numerical columns, the minimum of the
generated values is set to this value. Default is
-99999. For point, shape, and track columns, min for
numeric 'x' and 'y' columns needs to be within [-180,
180] and [-90, 90], respectively. The default minimum
possible values for these columns in such cases are
-180.0 and -90.0. For the 'TIMESTAMP' column, the
default minimum corresponds to Jan 1, 2010.
For string columns, the minimum length of the randomly
generated strings is set to this value (default is 0).
If both minimum and maximum are provided, minimum must
be less than or equal to max. Value needs to be within
[0, 200].
If the min is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track,
then those parameters will not be set; however, an error
will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
MAX
: For numerical columns, the maximum of the
generated values is set to this value. Default is 99999.
For point, shape, and track columns, max for numeric 'x'
and 'y' columns needs to be within [-180, 180] and [-90,
90], respectively. The default minimum possible values
for these columns in such cases are 180.0 and 90.0.
For string columns, the maximum length of the randomly
generated strings is set to this value (default is 200).
If both minimum and maximum are provided, *max* must be
greater than or equal to *min*. Value needs to be within
[0, 200].
If the *max* is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track,
then those parameters will not be set; however, an error
will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
INTERVAL
: If specified, generate values for all columns
evenly spaced with the given interval value. If a max
value is specified for a given column the data is
randomly generated between min and max and decimated
down to the interval. If no max is provided the data is
linerally generated starting at the minimum value
(instead of generating random data). For non-decimated
string-type columns the interval value is ignored.
Instead the values are generated following the pattern:
'attrname_creationIndex#', i.e. the column name suffixed
with an underscore and a running counter (starting at
0). For string types with limited size (eg char4) the
prefix is dropped. No nulls will be generated for
nullable columns.
NULL_PERCENTAGE
: If specified, then generate the given
percentage of the count as nulls for all nullable
columns. This option will be ignored for non-nullable
columns. The value must be within the range [0, 1.0].
The default value is 5% (0.05).
CARDINALITY
: If specified, limit the randomly generated
values to a fixed set. Not allowed on a column with
interval specified, and is not applicable to WKT or
Track-specific columns. The value must be greater than
0. This option is disabled by default.
ATTR_NAME
: Use the desired column name in place of
attr_name
, and set the following parameters for
the column specified. This overrides any parameter set
by all
.
MIN
: For numerical columns, the minimum of the
generated values is set to this value. Default is
-99999. For point, shape, and track columns, min for
numeric 'x' and 'y' columns needs to be within [-180,
180] and [-90, 90], respectively. The default minimum
possible values for these columns in such cases are
-180.0 and -90.0. For the 'TIMESTAMP' column, the
default minimum corresponds to Jan 1, 2010.
For string columns, the minimum length of the randomly
generated strings is set to this value (default is 0).
If both minimum and maximum are provided, minimum must
be less than or equal to max. Value needs to be within
[0, 200].
If the min is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track,
then those parameters will not be set; however, an error
will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
MAX
: For numerical columns, the maximum of the
generated values is set to this value. Default is 99999.
For point, shape, and track columns, max for numeric 'x'
and 'y' columns needs to be within [-180, 180] and [-90,
90], respectively. The default minimum possible values
for these columns in such cases are 180.0 and 90.0.
For string columns, the maximum length of the randomly
generated strings is set to this value (default is 200).
If both minimum and maximum are provided, *max* must be
greater than or equal to *min*. Value needs to be within
[0, 200].
If the *max* is outside the accepted ranges for strings
columns and 'x' and 'y' columns for point/shape/track,
then those parameters will not be set; however, an error
will not be thrown in such a case. It is the
responsibility of the user to use the all
parameter judiciously.
INTERVAL
: If specified, generate values for all columns
evenly spaced with the given interval value. If a max
value is specified for a given column the data is
randomly generated between min and max and decimated
down to the interval. If no max is provided the data is
linerally generated starting at the minimum value
(instead of generating random data). For non-decimated
string-type columns the interval value is ignored.
Instead the values are generated following the pattern:
'attrname_creationIndex#', i.e. the column name suffixed
with an underscore and a running counter (starting at
0). For string types with limited size (eg char4) the
prefix is dropped. No nulls will be generated for
nullable columns.
NULL_PERCENTAGE
: If specified and if this column is
nullable, then generate the given percentage of the
count as nulls. This option will result in an error if
the column is not nullable. The value must be within
the range [0, 1.0]. The default value is 5% (0.05).
CARDINALITY
: If specified, limit the randomly generated
values to a fixed set. Not allowed on a column with
interval specified, and is not applicable to WKT or
Track-specific columns. The value must be greater than
0. This option is disabled by default.
TRACK_LENGTH
: This key-map pair is only valid for track
data sets (an error is thrown otherwise). No nulls
would be generated for nullable columns.
MIN
: Minimum possible length for generated series;
default is 100 records per series. Must be an integral
value within the range [1, 500]. If both min and max are
specified, min must be less than or equal to max.
MAX
: Maximum possible length for generated series;
default is 500 records per series. Must be an integral
value within the range [1, 500]. If both min and max are
specified, max must be greater than or equal to min.
Map
.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.
Map
.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 a running proc instance. If a proc with a
matching run ID is not found or the proc instance has
already completed, no procs will be killed. If not
specified, all running proc instances will be killed. The
default value is ''.options
- Optional parameters.
RUN_TAG
: If runId
is specified, kill the proc
instance that has a matching run ID and a matching run
tag that was provided to executeProc(String, Map, Map, List, Map, List,
Map)
. If runId
is not specified, kill the proc
instance(s) where a matching run tag was provided to
executeProc(String, Map, Map, List, Map,
List, Map)
. The default value is ''.
Map
.GPUdbException
- if an error occurs during the operation.KillProcResponse
public ListGraphResponse listGraph(ListGraphRequest request) throws GPUdbException
GPUdbException
public ListGraphResponse listGraph(String graphName, Map<String,String> options) throws GPUdbException
GPUdbException
public LockTableResponse lockTable(LockTableRequest request) throws GPUdbException
lockType
of read_write
, indicating all operations are
permitted. A user may request a read_only
or a write_only
lock, after which only read or write operations,
respectively, are permitted on the table until the lock is removed.
When lockType
is no_access
then no operations are
permitted on the table. The lock status can be queried by setting
lockType
to status
.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 read_write
, indicating all operations are
permitted. A user may request a read_only
or a write_only
lock, after which only read or write operations,
respectively, are permitted on the table until the lock is removed.
When lockType
is no_access
then no operations are
permitted on the table. The lock status can be queried by setting
lockType
to status
.tableName
- Name of the table to be locked. It must be a currently
existing table, collection, or view.lockType
- The type of lock being applied to the table. Setting it
to status
will return the current lock status
of the table without changing it.
Supported values:
STATUS
: Show locked status
NO_ACCESS
: Allow no read/write operations
READ_ONLY
: Allow only read operations
WRITE_ONLY
: Allow only write operations
READ_WRITE
: Allow all read/write operations
STATUS
.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.LockTableResponse
public MatchGraphResponse matchGraph(MatchGraphRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.MatchGraphResponse
public MatchGraphResponse matchGraph(String graphName, List<String> samplePoints, String solveMethod, String solutionTable, Map<String,String> options) throws GPUdbException
graphName
- Name of the underlying geospatial graph resource to
match to using samplePoints
.samplePoints
- Sample points used to match to an underlying
geospatial
graph. Sample points must be specified using
identifiers;
identifiers are grouped as
combinations.
Identifiers can be used with: existing column
names, e.g.,
'table.column AS SAMPLE_X'; expressions, e.g.,
'ST_MAKEPOINT(table.x, table.y) AS
SAMPLE_WKTPOINT'; or constant values, e.g.,
'{1, 2, 10} AS SAMPLE_TRIPID'.solveMethod
- The type of solver to use for graph matching.
Supported values:
MARKOV_CHAIN
: Matches samplePoints
to the
graph using the Hidden Markov Model (HMM)-based
method, which conducts a range-tree closest-edge
search to find the best combinations of possible
road segments (num_segments
) for each sample
point to create the best route. The route is secured
one point at a time while looking ahead chain_width
number of points, so the prediction is
corrected after each point. This solution type is
the most accurate but also the most computationally
intensive. Related options: num_segments
and
chain_width
.
MATCH_OD_PAIRS
: Matches samplePoints
to
find the most probable path between origin and
destination pairs with cost constraints.
MATCH_SUPPLY_DEMAND
: Matches samplePoints
to optimize scheduling multiple supplies (trucks)
with varying sizes to varying demand sites with
varying capacities per depot. Related options:
partial_loading
and max_combinations
.
MATCH_BATCH_SOLVES
: Matches samplePoints
source and destination pairs for the shortest path
solves in batch mode.
MARKOV_CHAIN
.solutionTable
- The name of the table used to store the results;
this table contains a track of geospatial points for
the matched portion of the graph, a track ID, and
a score value. Also outputs a details table
containing a trip ID (that matches the track ID),
the latitude/longitude pair, the timestamp the
point was recorded at, and an edge ID
corresponding to the matched road segment. Has the
same naming restrictions as tables. Must not be an existing
table of the same name. The default value is ''.options
- Additional parameters
GPS_NOISE
: GPS noise value (in meters) to remove
redundant sample points. Use -1 to disable noise
reduction. The default value accounts for 95% of point
variation (+ or -5 meters). The default value is '5.0'.
NUM_SEGMENTS
: Maximum number of potentially matching
road segments for each sample point. For the markov_chain
solver, the default is 3. The default
value is '3'.
SEARCH_RADIUS
: Maximum search radius used when snapping
sample points onto potentially matching surrounding
segments. The default value corresponds to approximately
100 meters. The default value is '0.001'.
CHAIN_WIDTH
: For the markov_chain
solver only.
Length of the sample points lookahead window within the
Markov kernel; the larger the number, the more accurate
the solution. The default value is '9'.
SOURCE
: Optional WKT starting point from samplePoints
for the solver. The default behavior for
the endpoint is to use time to determine the starting
point. The default value is 'POINT NULL'.
DESTINATION
: Optional WKT ending point from samplePoints
for the solver. The default behavior for
the endpoint is to use time to determine the destination
point. The default value is 'POINT NULL'.
PARTIAL_LOADING
: For the match_supply_demand
solver only. When false (non-default), trucks do not
off-load at the demand (store) side if the remainder is
less than the store's need
Supported values:
TRUE
:
Partial off-loading at multiple store (demand) locations
FALSE
: No partial off-loading allowed if supply is less
than the store's demand.
TRUE
.
MAX_COMBINATIONS
: For the match_supply_demand
solver only. This is the cutoff for the number of
generated combinations for sequencing the demand
locations - can increase this up to 2M. The default
value is '10000'.
LEFT_TURN_PENALTY
: This will add an additonal weight
over the edges labelled as 'left turn' if the 'add_turn'
option parameter of the createGraph(String,
boolean, List, List, List, List, Map)
was invoked at
graph creation. The default value is '0.0'.
RIGHT_TURN_PENALTY
: This will add an additonal weight
over the edges labelled as' right turn' if the
'add_turn' option parameter of the createGraph(String, boolean, List, List, List,
List, Map)
was invoked at graph creation. The default
value is '0.0'.
INTERSECTION_PENALTY
: This will add an additonal weight
over the edges labelled as 'intersection' if the
'add_turn' option parameter of the createGraph(String, boolean, List, List, List,
List, Map)
was invoked at graph creation. The default
value is '0.0'.
SHARP_TURN_PENALTY
: This will add an additonal weight
over the edges labelled as 'sharp turn' or 'u-turn' if
the 'add_turn' option parameter of the createGraph(String, boolean, List, List, List,
List, Map)
was invoked at graph creation. The default
value is '0.0'.
AGGREGATED_OUTPUT
: For the match_supply_demand
solver only. When it is true (default), each record in
the output table shows a particular truck's scheduled
cumulative round trip path (MULTILINESTRING) and the
corresponding aggregated cost. Otherwise, each record
shows a single scheduled truck route (LINESTRING)
towards a particular demand location (store id) with its
corresponding cost. The default value is 'true'.
MAX_TRIP_COST
: For the match_supply_demand
solver only. If this constraint is greater than zero
(default) then the trucks will skip travelling from one
demand location to another if the cost between them is
greater than this number (distance or time). Zero
(default) value means no check is performed. The
default value is '0.0'.
FILTER_FOLDING_PATHS
: For the markov_chain
solver only. When true (non-default), the paths per
sequence combination is checked for folding over
patterns and can significantly increase the execution
time depending on the chain width and the number of gps
samples.
Supported values:
The default value is FALSE
.
UNIT_UNLOADING_COST
: For the match_supply_demand
solver only. The unit cost per load
amount to be delivered. If this value is greater than
zero (default) then the additional cost of this unit
load multiplied by the total dropped load will be added
over to the trip cost to the demand location. The
default value is '0.0'.
MAX_NUM_THREADS
: For the markov_chain
solver
only. If specified (greater than zero), the maximum
number of threads will not be greater than the specified
value. It can be lower due to the memory and the number
cores available. Default value of zero allows the
algorithm to set the maximal number of threads within
these constraints. The default value is '0'.
TRUCK_SERVICE_LIMIT
: For the match_supply_demand
solver only. If specified (greather
than zero), any truck's total service cost (distance or
time) will be limited by the specified value including
multiple rounds (if set). The default value is '0.0'.
ENABLE_TRUCK_REUSE
: For the match_supply_demand
solver only. If specified (true), all trucks can be
scheduled for second rounds from their originating
depots.
Supported values:
TRUE
:
Allows reusing trucks for scheduling again.
FALSE
: Trucks are scheduled only once from their
depots.
FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.MatchGraphResponse
public MergeRecordsResponse mergeRecords(MergeRecordsRequest request) throws GPUdbException
tableName
), and
insert all records from source tables (specified by sourceTableNames
) based on the field mapping information (specified by
fieldMaps
).
For merge records details and examples, see Merge
Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps
) holds the user-specified
maps of target table column names to source table columns. The array of
fieldMaps
must match one-to-one with the sourceTableNames
, e.g., there's a map present in fieldMaps
for
each table listed in sourceTableNames
.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.MergeRecordsResponse
public MergeRecordsResponse mergeRecords(String tableName, List<String> sourceTableNames, List<Map<String,String>> fieldMaps, Map<String,String> options) throws GPUdbException
tableName
), and
insert all records from source tables (specified by sourceTableNames
) based on the field mapping information (specified by
fieldMaps
).
For merge records details and examples, see Merge
Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps
) holds the user-specified
maps of target table column names to source table columns. The array of
fieldMaps
must match one-to-one with the sourceTableNames
, e.g., there's a map present in fieldMaps
for
each table listed in sourceTableNames
.
tableName
- The new result table name for the records to be
merged. Must NOT be an existing table.sourceTableNames
- The list of source table names to get the
records from. Must be existing table names.fieldMaps
- Contains a list of source/target column mappings, one
mapping for each source table listed in sourceTableNames
being merged into the target table
specified by tableName
. Each mapping contains
the target column names (as keys) that the data in the
mapped source columns or column expressions (as values) will be
merged into. All of the source columns being merged
into a given target column must match in type, as that
type will determine the type of the new target column.options
- Optional parameters.
COLLECTION_NAME
: Name of a collection which is to
contain the newly created merged table specified by
tableName
. If the collection provided is
non-existent, the collection will be automatically
created. If empty, then the newly created merged table
will be a top-level table.
IS_REPLICATED
: Indicates the distribution scheme for the data of
the merged table specified in tableName
. If
true, the table will be replicated. If false, the table will
be randomly sharded.
Supported values:
The default value is FALSE
.
TTL
:
Sets the TTL of the merged table specified in
tableName
.
PERSIST
: If true
, then the table specified in
tableName
will be persisted and will not expire
unless a ttl
is specified. If false
,
then the table will be an in-memory table and will
expire unless a ttl
is specified otherwise.
Supported values:
The default value is TRUE
.
CHUNK_SIZE
: Indicates the number of records per chunk
to be used for the merged table specified in tableName
.
VIEW_ID
: view this result table is part of. The
default value is ''.
Map
.GPUdbException
- if an error occurs during the operation.MergeRecordsResponse
public ModifyGraphResponse modifyGraph(ModifyGraphRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ModifyGraphResponse
public ModifyGraphResponse modifyGraph(String graphName, List<String> nodes, List<String> edges, List<String> weights, List<String> restrictions, Map<String,String> options) throws GPUdbException
graphName
- Name of the graph resource to modify.nodes
- Nodes with which to update existing nodes
in graph
specified by graphName
. Review Nodes for more information. Nodes must
be specified using identifiers; identifiers are grouped as
combinations. Identifiers can be used
with existing column names, e.g., 'table.column AS
NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1,
column2) AS NODE_WKTPOINT', or raw values, e.g., '{9, 10,
11} AS NODE_ID'. If using raw values in an identifier
combination, the number of values specified must match
across the combination. Identifier combination(s) do not
have to match the method used to create the graph, e.g.,
if column names were specified to create the graph,
expressions or raw values could also be used to modify the
graph.edges
- Edges with which to update existing edges
in graph
specified by graphName
. Review Edges for more information. Edges must
be specified using identifiers; identifiers are grouped as
combinations. Identifiers can be used
with existing column names, e.g., 'table.column AS
EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS
EDGE_NODE1_NAME', or raw values, e.g., "{'family',
'coworker'} AS EDGE_LABEL". If using raw values in an
identifier combination, the number of values specified
must match across the combination. Identifier
combination(s) do not have to match the method used to
create the graph, e.g., if column names were specified to
create the graph, expressions or raw values could also be
used to modify the graph.weights
- Weights with which to update existing weights
in
graph specified by graphName
. Review Weights for more information. Weights
must be specified using identifiers; identifiers are grouped
as combinations. Identifiers can be used
with existing column names, e.g., 'table.column AS
WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS
WEIGHTS_VALUESPECIFIED', or raw values, e.g., '{4, 15}
AS WEIGHTS_VALUESPECIFIED'. If using raw values in an
identifier combination, the number of values specified
must match across the combination. Identifier
combination(s) do not have to match the method used to
create the graph, e.g., if column names were specified
to create the graph, expressions or raw values could
also be used to modify the graph.restrictions
- Restrictions with which to update existing restrictions
in graph specified by graphName
. Review Restrictions for more
information. Restrictions must be specified using
identifiers; identifiers are
grouped as combinations. Identifiers can be
used with existing column names, e.g.,
'table.column AS RESTRICTIONS_EDGE_ID',
expressions, e.g., 'column/2 AS
RESTRICTIONS_VALUECOMPARED', or raw values, e.g.,
'{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If
using raw values in an identifier combination, the
number of values specified must match across the
combination. Identifier combination(s) do not have
to match the method used to create the graph, e.g.,
if column names were specified to create the graph,
expressions or raw values could also be used to
modify the graph.options
- Optional parameters.
RESTRICTION_THRESHOLD_VALUE
: Value-based restriction
comparison. Any node or edge with a
RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value
will not be included in the
graph.
EXPORT_CREATE_RESULTS
: If set to true
, returns
the graph topology in the response as arrays.
Supported values:
The default value is FALSE
.
ENABLE_GRAPH_DRAW
: If set to true
, adds a
'EDGE_WKTLINE' column identifier to the specified graph_table
so the graph can be viewed via WMS; for
social and non-geospatial graphs, the 'EDGE_WKTLINE'
column identifier will be populated with spatial
coordinates derived from a flattening layout algorithm
so the graph can still be viewed.
Supported values:
The default value is FALSE
.
SAVE_PERSIST
: If set to true
, the graph will be
saved in the persist directory (see the config reference for more
information). If set to false
, the graph will be
removed when the graph server is shutdown.
Supported values:
The default value is FALSE
.
ADD_TABLE_MONITOR
: Adds a table monitor to every table
used in the creation of the graph; this table monitor
will trigger the graph to update dynamically upon
inserts to the source table(s). Note that upon database
restart, if save_persist
is also set to true
, the graph will be fully reconstructed and the
table monitors will be reattached. For more details on
table monitors, see createTableMonitor(String, Map)
.
Supported values:
The default value is FALSE
.
GRAPH_TABLE
: If specified, the created graph is also
created as a table with the given name and following
identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID',
'EDGE_NODE2_ID'. If left blank, no table is created.
The default value is ''.
REMOVE_LABEL_ONLY
: When RESTRICTIONS on labeled
entities requested, if set to true this will NOT delete
the entity but only the label associated with the
entity. Otherwise (default), it'll delete the label AND
the entity.
Supported values:
The default value is FALSE
.
ADD_TURNS
: Adds dummy 'pillowed' edges around
intersection nodes where there are more than three edges
so that additional weight penalties can be imposed by
the solve endpoints. (increases the total number of
edges).
Supported values:
The default value is FALSE
.
TURN_ANGLE
: Value in degrees modifies the thresholds
for attributing right, left, sharp turns, and
intersections. It is the vertical deviation angle from
the incoming edge to the intersection node. The larger
the value, the larger the threshold for sharp turns and
intersections; the smaller the value, the larger the
threshold for right and left turns; 0 < turn_angle < 90.
The default value is '60'.
Map
.GPUdbException
- if an error occurs during the operation.ModifyGraphResponse
public QueryGraphResponse queryGraph(QueryGraphRequest request) throws GPUdbException
createGraph(CreateGraphRequest)
and returns a list of
adjacent edge(s) or node(s), also known as an adjacency list, depending
on what's been provided to the endpoint; providing edges will return
nodes and providing nodes will return edges.
To determine the node(s) or edge(s) adjacent to a value from a given
column, provide a list of values to queries
. This field can be
populated with column values from any table as long as the type is
supported by the given identifier. See Query Identifiers for more information.
To return the adjacency list in the response, leave adjacencyTable
empty. To return the adjacency list in a table and not
in the response, provide a value to adjacencyTable
and set
export_query_results
to false
. To return the adjacency
list both in a table and the response, provide a value to adjacencyTable
and set export_query_results
to true
.
IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.QueryGraphResponse
public QueryGraphResponse queryGraph(String graphName, List<String> queries, List<String> restrictions, String adjacencyTable, int rings, Map<String,String> options) throws GPUdbException
createGraph(String, boolean, List, List, List, List, Map)
and returns a list of adjacent edge(s) or node(s), also known as an
adjacency list, depending on what's been provided to the endpoint;
providing edges will return nodes and providing nodes will return edges.
To determine the node(s) or edge(s) adjacent to a value from a given
column, provide a list of values to queries
. This field can be
populated with column values from any table as long as the type is
supported by the given identifier. See Query Identifiers for more information.
To return the adjacency list in the response, leave adjacencyTable
empty. To return the adjacency list in a table and not
in the response, provide a value to adjacencyTable
and set
export_query_results
to false
. To return the adjacency
list both in a table and the response, provide a value to adjacencyTable
and set export_query_results
to true
.
IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.
graphName
- Name of the graph resource to query.queries
- Nodes or edges to be queried specified using query identifiers. Identifiers can be
used with existing column names, e.g., 'table.column AS
QUERY_NODE_ID', raw values, e.g., '{0, 2} AS
QUERY_NODE_ID', or expressions, e.g.,
'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'.
Multiple values can be provided as long as the same
identifier is used for all values. If using raw values
in an identifier combination, the number of values
specified must match across the combination.restrictions
- Additional restrictions to apply to the nodes/edges
of an existing graph. Restrictions must be
specified using identifiers; identifiers are
grouped as combinations. Identifiers can be
used with existing column names, e.g.,
'table.column AS RESTRICTIONS_EDGE_ID',
expressions, e.g., 'column/2 AS
RESTRICTIONS_VALUECOMPARED', or raw values, e.g.,
'{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If
using raw values in an identifier combination, the
number of values specified must match across the
combination. The default value is an empty List
.adjacencyTable
- Name of the table to store the resulting
adjacencies. If left blank, the query results are
instead returned in the response even if export_query_results
is set to false
. If
the 'QUERY_TARGET_NODE_LABEL' query identifier is used in
queries
, then two additional columns will
be available: 'PATH_ID' and 'RING_ID'. See
Using Labels for more
information. The default value is ''.rings
- Sets the number of rings around the node to query for
adjacency, with '1' being the edges directly attached to
the queried node. Also known as number of hops. For
example, if it is set to '2', the edge(s) directly
attached to the queried node(s) will be returned; in
addition, the edge(s) attached to the node(s) attached to
the initial ring of edge(s) surrounding the queried
node(s) will be returned. If the value is set to '0', any
nodes that meet the criteria in queries
and restrictions
will be returned. This parameter is only
applicable when querying nodes. The default value is 1.options
- Additional parameters
FORCE_UNDIRECTED
: If set to true
, all inbound
edges and outbound edges relative to the node will be
returned. If set to false
, only outbound edges
relative to the node will be returned. This parameter is
only applicable if the queried graph graphName
is directed and when querying nodes. Consult Directed Graphs for more details.
Supported values:
The default value is FALSE
.
LIMIT
: When specified, limits the number of query
results. Note that if the target_nodes_table
is
provided, the size of the corresponding table will be
limited by the limit
value. The default value
is an empty Map
.
TARGET_NODES_TABLE
: Name of the table to store the list
of the final nodes reached during the traversal. If this
value is left as the default, the table name will
default to the adjacencyTable
value plus a
'_nodes' suffix, e.g., 'RESTRICTION_THRESHOLD_VALUE
: Value-based restriction
comparison. Any node or edge with a
RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value
will not be included in the
solution.
EXPORT_QUERY_RESULTS
: Returns query results in the
response. If set to true
, the adjacencyListIntArray
(if the query was based on IDs),
adjacencyListStringArray
(if the query was based
on names), or adjacencyListWktArray
(if the
query was based on WKTs) will be populated with the
results. If set to false
, none of the arrays
will be populated.
Supported values:
The default value is FALSE
.
ENABLE_GRAPH_DRAW
: If set to true
, adds a
WKT-type column named 'QUERY_EDGE_WKTLINE' to the given
adjacencyTable
and inputs WKT values from the
source graph (if available) or auto-generated WKT values
(if there are no WKT values in the source graph). A
subsequent call to the /wms endpoint can then be made to
display the query results on a map.
Supported values:
The default value is FALSE
.
AND_LABELS
: If set to true
, the result of the
query has entities that satisfy all of the target
labels, instead of any.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.QueryGraphResponse
public RevokePermissionProcResponse revokePermissionProc(RevokePermissionProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.RevokePermissionProcResponse
public RevokePermissionProcResponse revokePermissionProc(String name, String permission, String procName, 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:
PROC_EXECUTE
: Execute access to the proc.
procName
- Name of the proc to which the permission grants access.
Must be an existing proc, or an empty string if the
permission grants access to all procs.options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.RevokePermissionProcResponse
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_USER_ADMIN
: Access to administer users and
roles that do not have system_admin permission.
SYSTEM_WRITE
: Read and write access to all tables.
SYSTEM_READ
: Read-only access to all tables.
options
- Optional parameters. The default value is an empty
Map
.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.
COLUMNS
: Apply security to these columns,
comma-separated. The default value is ''.
Map
.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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.RevokeRoleResponse
public ShowFunctionsResponse showFunctions(ShowFunctionsRequest request) throws GPUdbException
GPUdbException
public ShowFunctionsResponse showFunctions(Map<String,String> options) throws GPUdbException
GPUdbException
public ShowGraphResponse showGraph(ShowGraphRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ShowGraphResponse
public ShowGraphResponse showGraph(String graphName, Map<String,String> options) throws GPUdbException
graphName
- Name of the graph on which to retrieve information. If
left as the default value, information about all
graphs is returned. The default value is ''.options
- Optional parameters.
SHOW_ORIGINAL_REQUEST
: If set to true
, the
request that was originally used to create the graph is
also returned as JSON.
Supported values:
The default value is TRUE
.
Map
.GPUdbException
- if an error occurs during the operation.ShowGraphResponse
public ShowGraphGrammarResponse showGraphGrammar(ShowGraphGrammarRequest request) throws GPUdbException
GPUdbException
public ShowGraphGrammarResponse showGraphGrammar(Map<String,String> options) throws GPUdbException
GPUdbException
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. The default value is ''.options
- Optional parameters.
INCLUDE_FILES
: If set to true
, the files that
make up the proc will be returned. If set to false
, the files will not be returned.
Supported values:
The default value is FALSE
.
Map
.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 proc instance for which the
status will be returned. If a proc with a matching run ID
is not found, the response will be empty. If not
specified, the statuses of all executed proc instances
will be returned. The default value is ''.options
- Optional parameters.
CLEAR_COMPLETE
: If set to true
, if a proc
instance has completed (either successfully or
unsuccessfully) then its status will be cleared and no
longer returned in subsequent calls.
Supported values:
The default value is FALSE
.
RUN_TAG
: If runId
is specified, return the
status for a proc instance that has a matching run ID
and a matching run tag that was provided to executeProc(String, Map, Map, List, Map, List,
Map)
. If runId
is not specified, return
statuses for all proc instances where a matching run tag
was provided to executeProc(String, Map,
Map, List, Map, List, Map)
. The default value is ''.
Map
.GPUdbException
- if an error occurs during the operation.ShowProcStatusResponse
public ShowResourceStatisticsResponse showResourceStatistics(ShowResourceStatisticsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ShowResourceStatisticsResponse
public ShowResourceStatisticsResponse showResourceStatistics(Map<String,String> options) throws GPUdbException
options
- Optional parameters. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.ShowResourceStatisticsResponse
public ShowResourceGroupsResponse showResourceGroups(ShowResourceGroupsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ShowResourceGroupsResponse
public ShowResourceGroupsResponse showResourceGroups(List<String> names, Map<String,String> options) throws GPUdbException
names
- List of names of groups to be shown. A single entry with
an empty string returns all groups.options
- Optional parameters.
SHOW_DEFAULT_VALUES
: If true
include values of
fields that are based on the default resource group.
Supported values:
The default value is TRUE
.
SHOW_DEFAULT_GROUP
: If true
include the default
resource group in the response.
Supported values:
The default value is TRUE
.
Map
.GPUdbException
- if an error occurs during the operation.ShowResourceGroupsResponse
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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.ShowSecurityResponse
public ShowSqlProcResponse showSqlProc(ShowSqlProcRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ShowSqlProcResponse
public ShowSqlProcResponse showSqlProc(String procedureName, Map<String,String> options) throws GPUdbException
procedureName
- Name of the procedure for which to retrieve the
information. If blank, then information about all
procedures is returned. The default value is ''.options
- Optional parameters.
NO_ERROR_IF_NOT_EXISTS
: If true
, no error will
be returned if the requested procedure does not exist.
If false
, an error will be returned if the
requested procedure does not exist.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.ShowSqlProcResponse
public ShowStatisticsResponse showStatistics(ShowStatisticsRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.ShowStatisticsResponse
public ShowStatisticsResponse showStatistics(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. The default value is an empty
Map
.GPUdbException
- if an error occurs during the operation.ShowStatisticsResponse
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.
Map
.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. The default
value is an empty Map
.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. The default
value is an empty Map
.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 number of records
in each table is returned (in sizes
and
fullSizes
), along with the total number of objects across all
requested tables (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 corresponding detail.
To retrieve a list of every table, view, and collection in the database,
set tableName
to '*' and show_children
to true
.
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 number of records
in each table is returned (in sizes
and
fullSizes
), along with the total number of objects across all
requested tables (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 corresponding detail.
To retrieve a list of every table, view, and collection in the database,
set tableName
to '*' and show_children
to true
.
tableName
- Name of the table for which to retrieve the
information. If blank, then information about all
collections and top-level tables and views is
returned.options
- Optional parameters.
FORCE_SYNCHRONOUS
: If true
then the table sizes
will wait for read lock before returning.
Supported values:
The default value is TRUE
.
GET_SIZES
: If true
then the number of records
in each table, along with a cumulative count, 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
.
GET_COLUMN_INFO
: If true
then column info
(memory usage, etc) will be returned.
Supported values:
The default value is FALSE
.
Map
.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. The default value is an empty
Map
.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. The default value is an empty
Map
.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. The default value is an empty
Map
.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.
NO_JOIN_TYPES
: When set to 'true', no join types will
be included.
Supported values:
The default value is FALSE
.
Map
.GPUdbException
- if an error occurs during the operation.ShowTypesResponse
public SolveGraphResponse solveGraph(SolveGraphRequest request) throws GPUdbException
IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.SolveGraphResponse
public SolveGraphResponse solveGraph(String graphName, List<String> weightsOnEdges, List<String> restrictions, String solverType, List<String> sourceNodes, List<String> destinationNodes, String solutionTable, Map<String,String> options) throws GPUdbException
IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
graphName
- Name of the graph resource to solve.weightsOnEdges
- Additional weights to apply to the edges of an
existing
graph. Weights must be specified using
identifiers;
identifiers are grouped as
combinations.
Identifiers can be used with existing column
names, e.g.,
'table.column AS WEIGHTS_EDGE_ID', expressions,
e.g.,
'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or
constant values, e.g.,
'{4, 15, 2} AS WEIGHTS_VALUESPECIFIED'. Any
provided weights will be added
(in the case of 'WEIGHTS_VALUESPECIFIED') to or
multiplied with
(in the case of 'WEIGHTS_FACTORSPECIFIED') the
existing weight(s). If using
constant values in an identifier combination, the
number of values specified
must match across the combination. The default
value is an empty List
.restrictions
- Additional restrictions to apply to the nodes/edges
of an
existing graph. Restrictions must be specified
using
identifiers;
identifiers are grouped as
combinations.
Identifiers can be used with existing column names,
e.g.,
'table.column AS RESTRICTIONS_EDGE_ID',
expressions, e.g.,
'column/2 AS RESTRICTIONS_VALUECOMPARED', or
constant values, e.g.,
'{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If
using constant values in an
identifier combination, the number of values
specified must match across the
combination. If remove_previous_restrictions
is set
to true
, any
provided restrictions will replace the existing
restrictions. If
remove_previous_restrictions
is set to
false
, any provided
restrictions will be added (in the case of
'RESTRICTIONS_VALUECOMPARED') to or
replaced (in the case of
'RESTRICTIONS_ONOFFCOMPARED'). The default value
is an empty List
.solverType
- The type of solver to use for the graph.
Supported values:
SHORTEST_PATH
: Solves for the optimal (shortest)
path based on weights and restrictions from one
source to destinations nodes. Also known as the
Dijkstra solver.
PAGE_RANK
: Solves for the probability of each
destination node being visited based on the links of
the graph topology. Weights are not required to use
this solver.
PROBABILITY_RANK
: Solves for the transitional
probability (Hidden Markov) for each node based on
the weights (probability assigned over given edges).
CENTRALITY
: Solves for the degree of a node to
depict how many pairs of individuals that would have
to go through the node to reach one another in the
minimum number of hops. Also known as betweenness.
MULTIPLE_ROUTING
: Solves for finding the minimum
cost cumulative path for a round-trip starting from
the given source and visiting each given destination
node once then returning to the source. Also known as
the travelling salesman problem.
INVERSE_SHORTEST_PATH
: Solves for finding the
optimal path cost for each destination node to route
to the source node. Also known as inverse Dijkstra or
the service man routing problem.
BACKHAUL_ROUTING
: Solves for optimal routes that
connect remote asset nodes to the fixed (backbone)
asset nodes.
ALLPATHS
: Solves for paths that would give costs
between max and min solution radia - Make sure to
limit by the 'max_solution_targets' option. Min cost
shoudl be >= shortest_path cost.
SHORTEST_PATH
.sourceNodes
- It can be one of the nodal identifiers - e.g:
'NODE_WKTPOINT' for source nodes. For BACKHAUL_ROUTING
, this list depicts the fixed
assets. The default value is an empty List
.destinationNodes
- It can be one of the nodal identifiers - e.g:
'NODE_WKTPOINT' for destination (target) nodes.
For BACKHAUL_ROUTING
, this list depicts
the remote assets. The default value is an
empty List
.solutionTable
- Name of the table to store the solution. The
default value is 'graph_solutions'.options
- Additional parameters
MAX_SOLUTION_RADIUS
: For SHORTEST_PATH
and
INVERSE_SHORTEST_PATH
solvers only. Sets the
maximum solution cost radius, which ignores the destinationNodes
list and instead outputs the nodes
within the radius sorted by ascending cost. If set to
'0.0', the setting is ignored. The default value is
'0.0'.
MIN_SOLUTION_RADIUS
: For SHORTEST_PATH
and
INVERSE_SHORTEST_PATH
solvers only. Applicable
only when max_solution_radius
is set. Sets the
minimum solution cost radius, which ignores the destinationNodes
list and instead outputs the nodes
within the radius sorted by ascending cost. If set to
'0.0', the setting is ignored. The default value is
'0.0'.
MAX_SOLUTION_TARGETS
: For SHORTEST_PATH
and
INVERSE_SHORTEST_PATH
solvers only. Sets the
maximum number of solution targets, which ignores the
destinationNodes
list and instead outputs no
more than n number of nodes sorted by ascending cost
where n is equal to the setting value. If set to 0, the
setting is ignored. The default value is '0'.
EXPORT_SOLVE_RESULTS
: Returns solution results inside
the resultPerDestinationNode
array in the
response if set to true
.
Supported values:
The default value is FALSE
.
REMOVE_PREVIOUS_RESTRICTIONS
: Ignore the restrictions
applied to the graph during the creation stage and only
use the restrictions specified in this request if set to
true
.
Supported values:
The default value is FALSE
.
RESTRICTION_THRESHOLD_VALUE
: Value-based restriction
comparison. Any node or edge with a
RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value
will not be included in the
solution.
UNIFORM_WEIGHTS
: When specified, assigns the given
value to all the edges in the graph. Note that weights
provided in weightsOnEdges
will override this
value.
LEFT_TURN_PENALTY
: This will add an additonal weight
over the edges labelled as 'left turn' if the 'add_turn'
option parameter of the createGraph(String,
boolean, List, List, List, List, Map)
was invoked at
graph creation. The default value is '0.0'.
RIGHT_TURN_PENALTY
: This will add an additonal weight
over the edges labelled as' right turn' if the
'add_turn' option parameter of the createGraph(String, boolean, List, List, List,
List, Map)
was invoked at graph creation. The default
value is '0.0'.
INTERSECTION_PENALTY
: This will add an additonal weight
over the edges labelled as 'intersection' if the
'add_turn' option parameter of the createGraph(String, boolean, List, List, List,
List, Map)
was invoked at graph creation. The default
value is '0.0'.
SHARP_TURN_PENALTY
: This will add an additonal weight
over the edges labelled as 'sharp turn' or 'u-turn' if
the 'add_turn' option parameter of the createGraph(String, boolean, List, List, List,
List, Map)
was invoked at graph creation. The default
value is '0.0'.
NUM_BEST_PATHS
: For MULTIPLE_ROUTING
solvers
only; sets the number of shortest paths computed from
each node. This is the heuristic criterion. Default
value of zero allows the number to be computed
automatically by the solver. The user may want to
override this parameter to speed-up the solver. The
default value is '0'.
MAX_NUM_COMBINATIONS
: For MULTIPLE_ROUTING
solvers only; sets the cap on the combinatorial
sequences generated. If the default value of two
millions is overridden to a lesser value, it can
potentially speed up the solver. The default value is
'2000000'.
ACCURATE_SNAPS
: Valid for single source destination
pair solves if points are described in NODE_WKTPOINT
identifier types: When true (default), it snaps to the
nearest node of the graph; otherwise, it searches for
the closest entity that could be an edge. For the latter
case (false), the solver modifies the resulting cost
with the weights proportional to the ratio of the snap
location within the edge. This may be an over-kill when
the performance is considered and the difference is well
less than 1 percent. In batch runs, since the
performance is of utmost importance, the option is
always considered 'false'.
Supported values:
The default value is TRUE
.
OUTPUT_EDGE_PATH
: If true then concatenated edge ids
will be added as the EDGE path column of the solution
table for each source and target pair in shortest path
solves.
Supported values:
The default value is FALSE
.
OUTPUT_WKT_PATH
: If true then concatenated wkt line
segments will be added as the Wktroute column of the
solution table for each source and target pair in
shortest path solves.
Supported values:
The default value is TRUE
.
Map
.GPUdbException
- if an error occurs during the operation.SolveGraphResponse
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
.Note that this operation can
only be run on an original table and not on a collection or a result
view.
The update_on_existing_pk
option specifies the record collision
policy for tables with a primary key, and is ignored on tables with no primary
key.
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
.Note that this operation can
only be run on an original table and not on a collection or a result
view.
The update_on_existing_pk
option specifies the record collision
policy for tables with a primary key, and is ignored on tables with no primary
key.
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
.Note that this operation can
only be run on an original table and not on a collection or a result
view.
The update_on_existing_pk
option specifies the record collision
policy for tables with a primary key, and is ignored on tables with no primary
key.
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
.Note that this operation can
only be run on an original table and not on a collection or a result
view.
The update_on_existing_pk
option specifies the record collision
policy for tables with a primary key, and is ignored on tables with no primary
key.
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. The default value is an empty List
.options
- Optional parameters.
GLOBAL_EXPRESSION
: An optional global expression to
reduce the search space of the predicates listed in
expressions
. The default value is ''.
BYPASS_SAFETY_CHECKS
: When set to true
, all
predicates are available for primary key updates. Keep
in mind that it is possible to destroy data in this
case, since a single predicate may match multiple
objects (potentially all of records of a table), and
then updating all of those records to have the same
primary key will, due to the primary key uniqueness
constraints, effectively delete all but one of those
updated records.
Supported values:
The default value is FALSE
.
UPDATE_ON_EXISTING_PK
: Specifies the record collision
policy for tables with a primary key when updating columns of
the primary key or inserting new records.
If true
, existing records with primary key
values that match those of a record being updated or
inserted will be replaced by the updated and new
records. If false
, existing records with
matching primary key values will remain unchanged, and
the updated or new records with primary key values that
match those of existing records will be discarded. If
the specified table does not have a primary key, then
this option has no effect.
Supported values:
TRUE
: Overwrite existing records when updated and
inserted records have the same primary keys
FALSE
: Discard updated and inserted records when the
same primary keys already exist
FALSE
.
UPDATE_PARTITION
: Force qualifying records to be
deleted and reinserted so their partition membership
will be reevaluated.
Supported values:
The default value is FALSE
.
TRUNCATE_STRINGS
: If set to true
, any strings
which are too long for their charN string fields will be
truncated to fit.
Supported values:
The default value is FALSE
.
USE_EXPRESSIONS_IN_NEW_VALUES_MAPS
: When set to true
, all new values in newValuesMaps
are
considered as expression values. When set to false
, all new values in newValuesMaps
are
considered as constants. NOTE: When true
,
string constants will need to be quoted to avoid being
evaluated as expressions.
Supported values:
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)
).
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
.Note that this operation can
only be run on an original table and not on a collection or a result
view.
The update_on_existing_pk
option specifies the record collision
policy for tables with a primary key, and is ignored on tables with no primary
key.
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. The default value is an empty List
.options
- Optional parameters.
GLOBAL_EXPRESSION
: An optional global expression to
reduce the search space of the predicates listed in
expressions
. The default value is ''.
BYPASS_SAFETY_CHECKS
: When set to true
, all
predicates are available for primary key updates. Keep
in mind that it is possible to destroy data in this
case, since a single predicate may match multiple
objects (potentially all of records of a table), and
then updating all of those records to have the same
primary key will, due to the primary key uniqueness
constraints, effectively delete all but one of those
updated records.
Supported values:
The default value is FALSE
.
UPDATE_ON_EXISTING_PK
: Specifies the record collision
policy for tables with a primary key when updating columns of
the primary key or inserting new records.
If true
, existing records with primary key
values that match those of a record being updated or
inserted will be replaced by the updated and new
records. If false
, existing records with
matching primary key values will remain unchanged, and
the updated or new records with primary key values that
match those of existing records will be discarded. If
the specified table does not have a primary key, then
this option has no effect.
Supported values:
TRUE
: Overwrite existing records when updated and
inserted records have the same primary keys
FALSE
: Discard updated and inserted records when the
same primary keys already exist
FALSE
.
UPDATE_PARTITION
: Force qualifying records to be
deleted and reinserted so their partition membership
will be reevaluated.
Supported values:
The default value is FALSE
.
TRUNCATE_STRINGS
: If set to true
, any strings
which are too long for their charN string fields will be
truncated to fit.
Supported values:
The default value is FALSE
.
USE_EXPRESSIONS_IN_NEW_VALUES_MAPS
: When set to true
, all new values in newValuesMaps
are
considered as expression values. When set to false
, all new values in newValuesMaps
are
considered as constants. NOTE: When true
,
string constants will need to be quoted to avoid being
evaluated as expressions.
Supported values:
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)
).
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
- name of the view containing the series (tracks) which
have to be updated. The default value is ''.reserved
- The default value is an empty List
.options
- Optional parameters. The default value is an empty
Map
.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, String symbolColumnName, String geometryColumnName, List<List<String>> trackIds, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, Map<String,List<String>> styleOptions, Map<String,String> options) throws GPUdbException
GPUdbException
public VisualizeImageChartResponse visualizeImageChart(VisualizeImageChartRequest request) throws GPUdbException
imageData
field.request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.VisualizeImageChartResponse
public VisualizeImageChartResponse visualizeImageChart(String tableName, List<String> xColumnNames, List<String> yColumnNames, double minX, double maxX, double minY, double maxY, int width, int height, String bgColor, Map<String,List<String>> styleOptions, Map<String,String> options) throws GPUdbException
imageData
field.tableName
- Name of the table containing the data to be drawn as a
chart.xColumnNames
- Names of the columns containing the data mapped to
the x axis of a chart.yColumnNames
- Names of the columns containing the data mapped to
the y axis of a chart.minX
- Lower bound for the x column values. For non-numeric x
column, each x column item is mapped to an integral value
starting from 0.maxX
- Upper bound for the x column values. For non-numeric x
column, each x column item is mapped to an integral value
starting from 0.minY
- Lower bound for the y column values. For non-numeric y
column, each y column item is mapped to an integral value
starting from 0.maxY
- Upper bound for the y column values. For non-numeric y
column, each y column item is mapped to an integral value
starting from 0.width
- Width of the generated image in pixels.height
- Height of the generated image in pixels.bgColor
- Background color of the generated image.styleOptions
- Rendering style options for a chart.
POINTCOLOR
: The color of points in the plot
represented as a hexadecimal number. The default
value is '0000FF'.
POINTSIZE
: The size of points in the plot
represented as number of pixels. The default value
is '3'.
POINTSHAPE
: The shape of points in the plot.
Supported values:
The default value is SQUARE
.
CB_POINTCOLORS
: Point color class break
information consisting of three entries:
class-break attribute, class-break values/ranges,
and point color values. This option overrides the
pointcolor option if both are provided. Class-break
ranges are represented in the form of "min:max".
Class-break values/ranges and point color values
are separated by cb_delimiter, e.g. {"price",
"20:30;30:40;40:50", "0xFF0000;0x00FF00;0x0000FF"}.
CB_POINTSIZES
: Point size class break information
consisting of three entries: class-break attribute,
class-break values/ranges, and point size values.
This option overrides the pointsize option if both
are provided. Class-break ranges are represented in
the form of "min:max". Class-break values/ranges
and point size values are separated by
cb_delimiter, e.g. {"states", "NY;TX;CA", "3;5;7"}.
CB_POINTSHAPES
: Point shape class break
information consisting of three entries:
class-break attribute, class-break values/ranges,
and point shape names. This option overrides the
pointshape option if both are provided. Class-break
ranges are represented in the form of "min:max".
Class-break values/ranges and point shape names are
separated by cb_delimiter, e.g. {"states",
"NY;TX;CA", "circle;square;diamond"}.
CB_DELIMITER
: A character or string which
separates per-class values in a class-break style
option string. The default value is ';'.
X_ORDER_BY
: An expression or aggregate expression
by which non-numeric x column values are sorted,
e.g. "avg(price) descending".
Y_ORDER_BY
: An expression or aggregate expression
by which non-numeric y column values are sorted,
e.g. "avg(price)", which defaults to "avg(price)
ascending".
SCALE_TYPE_X
: Type of x axis scale.
Supported values:
The default value is NONE
.
SCALE_TYPE_Y
: Type of y axis scale.
Supported values:
The default value is NONE
.
MIN_MAX_SCALED
: If this options is set to "false",
this endpoint expects request's min/max values are
not yet scaled. They will be scaled according to
scale_type_x or scale_type_y for response. If this
options is set to "true", this endpoint expects
request's min/max values are already scaled
according to scale_type_x/scale_type_y. Response's
min/max values will be equal to request's min/max
values. The default value is 'false'.
JITTER_X
: Amplitude of horizontal jitter applied
to non-numeric x column values. The default value
is '0.0'.
JITTER_Y
: Amplitude of vertical jitter applied to
non-numeric y column values. The default value is
'0.0'.
PLOT_ALL
: If this options is set to "true", all
non-numeric column values are plotted ignoring
min_x, max_x, min_y and max_y parameters. The
default value is 'false'.
options
- Optional parameters.
IMAGE_ENCODING
: Encoding to be applied to the output
image. When using JSON serialization it is recommended
to specify this as base64
.
Supported values:
BASE64
: Apply base64 encoding to the output image.
NONE
: Do not apply any additional encoding to the
output image.
NONE
.
Map
.GPUdbException
- if an error occurs during the operation.VisualizeImageChartResponse
public VisualizeImageClassbreakResponse visualizeImageClassbreak(VisualizeImageClassbreakRequest request) throws GPUdbException
GPUdbException
public VisualizeImageClassbreakResponse visualizeImageClassbreak(List<String> tableNames, List<String> worldTableNames, String xColumnName, String yColumnName, String geometryColumnName, List<List<String>> trackIds, String cbAttr, List<String> cbVals, String cbPointcolorAttr, List<String> cbPointcolorVals, String cbPointalphaAttr, List<String> cbPointalphaVals, String cbPointsizeAttr, List<String> cbPointsizeVals, String cbPointshapeAttr, List<String> cbPointshapeVals, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, Map<String,List<String>> styleOptions, Map<String,String> options, List<Integer> cbTransparencyVec) throws GPUdbException
GPUdbException
public VisualizeImageContourResponse visualizeImageContour(VisualizeImageContourRequest request) throws GPUdbException
GPUdbException
public VisualizeImageContourResponse visualizeImageContour(List<String> tableNames, String xColumnName, String yColumnName, String valueColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, Map<String,String> styleOptions, Map<String,String> options) throws GPUdbException
GPUdbException
public VisualizeImageHeatmapResponse visualizeImageHeatmap(VisualizeImageHeatmapRequest request) throws GPUdbException
GPUdbException
public VisualizeImageHeatmapResponse visualizeImageHeatmap(List<String> tableNames, String xColumnName, String yColumnName, String valueColumnName, String geometryColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, Map<String,String> styleOptions, Map<String,String> options) throws GPUdbException
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, String filter, double minX, double maxX, double minY, double maxY, int width, int height, String projection, Map<String,String> options) throws GPUdbException
GPUdbException
public VisualizeIsochroneResponse visualizeIsochrone(VisualizeIsochroneRequest request) throws GPUdbException
request
- Request object containing the parameters for the
operation.GPUdbException
- if an error occurs during the operation.VisualizeIsochroneResponse
public VisualizeIsochroneResponse visualizeIsochrone(String graphName, String sourceNode, double maxSolutionRadius, List<String> weightsOnEdges, List<String> restrictions, int numLevels, boolean generateImage, String levelsTable, Map<String,String> styleOptions, Map<String,String> solveOptions, Map<String,String> contourOptions, Map<String,String> options) throws GPUdbException
graphName
- Name of the graph on which the isochrone is to be
computed.sourceNode
- Starting vertex on the underlying graph from/to which
the isochrones are created.maxSolutionRadius
- Extent of the search radius around sourceNode
. Set to '-1.0' for unrestricted
search radius. The default value is -1.0.weightsOnEdges
- Additional weights to apply to the edges of an
existing graph. Weights must be specified using
identifiers; identifiers are
grouped as combinations. Identifiers can
be used with existing column names, e.g.,
'table.column AS WEIGHTS_EDGE_ID', or
expressions, e.g., 'ST_LENGTH(wkt) AS
WEIGHTS_VALUESPECIFIED'. Any provided weights
will be added (in the case of
'WEIGHTS_VALUESPECIFIED') to or multiplied with
(in the case of 'WEIGHTS_FACTORSPECIFIED') the
existing weight(s). The default value is an
empty List
.restrictions
- Additional restrictions to apply to the nodes/edges
of an existing graph. Restrictions must be
specified using identifiers; identifiers are
grouped as combinations. Identifiers can be
used with existing column names, e.g.,
'table.column AS RESTRICTIONS_EDGE_ID', or
expressions, e.g., 'column/2 AS
RESTRICTIONS_VALUECOMPARED'. If remove_previous_restrictions
is set to true
, any provided restrictions will replace the
existing restrictions. If remove_previous_restrictions
is set to false
, any provided restrictions will be added (in
the case of 'RESTRICTIONS_VALUECOMPARED') to or
replaced (in the case of
'RESTRICTIONS_ONOFFCOMPARED'). The default value
is an empty List
.numLevels
- Number of equally-separated isochrones to compute.
The default value is 1.generateImage
- If set to true
, generates a PNG image of
the isochrones in the response.
Supported values:
The default value is TRUE
.levelsTable
- Name of the table to output the isochrones,
containing levels and their corresponding WKT
geometry. If no value is provided, the table is not
generated. The default value is ''.styleOptions
- Various style related options of the isochrone
image.
LINE_SIZE
: The width of the contour lines in
pixels. The default value is '3'.
COLOR
: Color of generated isolines. All color
values must be in the format RRGGBB or AARRGGBB (to
specify the alpha value). If alpha is specified and
flooded contours are enabled, it will be used for
as the transparency of the latter. The default
value is 'FF696969'.
BG_COLOR
: When generateImage
is set to
true
, background color of the generated
image. All color values must be in the format
RRGGBB or AARRGGBB (to specify the alpha value).
The default value is '00000000'.
TEXT_COLOR
: When add_labels
is set to
true
, color for the labels. All color
values must be in the format RRGGBB or AARRGGBB (to
specify the alpha value). The default value is
'FF000000'.
COLORMAP
: Colormap for contours or fill-in regions
when applicable. All color values must be in the
format RRGGBB or AARRGGBB (to specify the alpha
value)
Supported values:
JET
ACCENT
AFMHOT
AUTUMN
BINARY
BLUES
BONE
BRBG
BRG
BUGN
BUPU
BWR
CMRMAP
COOL
COOLWARM
COPPER
CUBEHELIX
DARK2
FLAG
GIST_EARTH
GIST_GRAY
GIST_HEAT
GIST_NCAR
GIST_RAINBOW
GIST_STERN
GIST_YARG
GNBU
GNUPLOT2
GNUPLOT
GRAY
GREENS
GREYS
HOT
HSV
INFERNO
MAGMA
NIPY_SPECTRAL
OCEAN
ORANGES
ORRD
PAIRED
PASTEL1
PASTEL2
PINK
PIYG
PLASMA
PRGN
PRISM
PUBU
PUBUGN
PUOR
PURD
PURPLES
RAINBOW
RDBU
RDGY
RDPU
RDYLBU
RDYLGN
REDS
SEISMIC
SET1
SET2
SET3
SPECTRAL
SPRING
SUMMER
TERRAIN
VIRIDIS
WINTER
WISTIA
YLGN
YLGNBU
YLORBR
YLORRD
JET
.
solveOptions
- Solver specific parameters
REMOVE_PREVIOUS_RESTRICTIONS
: Ignore the
restrictions applied to the graph during the
creation stage and only use the restrictions
specified in this request if set to true
.
Supported values:
The default value is FALSE
.
RESTRICTION_THRESHOLD_VALUE
: Value-based
restriction comparison. Any node or edge with a
'RESTRICTIONS_VALUECOMPARED' value greater than the
restriction_threshold_value
will not be
included in the solution.
UNIFORM_WEIGHTS
: When specified, assigns the given
value to all the edges in the graph. Note that
weights provided in weightsOnEdges
will
override this value.
Map
.contourOptions
- Solver specific parameters
PROJECTION
: Spatial Reference System (i.e. EPSG
Code).
Supported values:
The default value is PLATE_CARREE
.
WIDTH
: When generateImage
is set to
true
, width of the generated image. The
default value is '512'.
HEIGHT
: When generateImage
is set to
true
, height of the generated image. If
the default value is used, the height
is
set to the value resulting from multiplying the
aspect ratio by the width
. The default
value is '-1'.
SEARCH_RADIUS
: When interpolating the graph
solution to generate the isochrone, neighborhood
of influence of sample data (in percent of the
image/grid). The default value is '20'.
GRID_SIZE
: When interpolating the graph solution
to generate the isochrone, number of subdivisions
along the x axis when building the grid (the y is
computed using the aspect ratio of the output
image). The default value is '100'.
COLOR_ISOLINES
: Color each isoline according to
the colormap; otherwise, use the foreground
color.
Supported values:
The default value is TRUE
.
ADD_LABELS
: If set to true
, add labels
to the isolines.
Supported values:
The default value is FALSE
.
LABELS_FONT_SIZE
: When add_labels
is set
to true
, size of the font (in pixels) to
use for labels. The default value is '12'.
LABELS_FONT_FAMILY
: When add_labels
is
set to true
, font name to be used when
adding labels. The default value is 'arial'.
LABELS_SEARCH_WINDOW
: When add_labels
is
set to true
, a search window is used to
rate the local quality of each isoline. Smooth,
continuous, long stretches with relatively flat
angles are favored. The provided value is
multiplied by the labels_font_size
to
calculate the final window size. The default
value is '4'.
LABELS_INTRALEVEL_SEPARATION
: When add_labels
is set to true
, this value
determines the distance (in multiples of the
labels_font_size
) to use when separating
labels of different values. The default value is
'4'.
LABELS_INTERLEVEL_SEPARATION
: When add_labels
is set to true
, this value
determines the distance (in percent of the total
window size) to use when separating labels of the
same value. The default value is '20'.
LABELS_MAX_ANGLE
: When add_labels
is set
to true
, maximum angle (in degrees) from
the vertical to use when adding labels. The
default value is '60'.
Map
.options
- Additional parameters
SOLVE_TABLE
: Name of the table to host intermediate
solve results containing the position and cost for each
vertex in the graph. If the default value is used, a
temporary table is created and deleted once the solution
is calculated. The default value is ''.
IS_REPLICATED
: If set to true
, replicate the
solve_table
.
Supported values:
The default value is TRUE
.
DATA_MIN_X
: Lower bound for the x values. If not
provided, it will be computed from the bounds of the
input data.
DATA_MAX_X
: Upper bound for the x values. If not
provided, it will be computed from the bounds of the
input data.
DATA_MIN_Y
: Lower bound for the y values. If not
provided, it will be computed from the bounds of the
input data.
DATA_MAX_Y
: Upper bound for the y values. If not
provided, it will be computed from the bounds of the
input data.
CONCAVITY_LEVEL
: Factor to qualify the concavity of the
isochrone curves. The lower the value, the more convex
(with '0' being completely convex and '1' being the most
concave). The default value is '0.5'.
USE_PRIORITY_QUEUE_SOLVERS
: sets the solver methods
explicitly if true
Supported values:
TRUE
: uses the solvers scheduled for 'shortest_path'
and 'inverse_shortest_path' based on solve_direction
FALSE
: uses the solvers 'priority_queue' and
'inverse_priority_queue' based on solve_direction
FALSE
.
SOLVE_DIRECTION
: Specify whether we are going to the
source node, or starting from it.
Supported values:
FROM_SOURCE
: Shortest path to get to the source
(inverse Dijkstra)
TO_SOURCE
: Shortest path to source (Dijkstra)
FROM_SOURCE
.
Map
.GPUdbException
- if an error occurs during the operation.VisualizeIsochroneResponse
public VisualizeVideoResponse visualizeVideo(VisualizeVideoRequest request) throws GPUdbException
GPUdbException
public VisualizeVideoResponse visualizeVideo(List<String> tableNames, List<String> worldTableNames, List<List<String>> trackIds, String xColumnName, String yColumnName, String geometryColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, List<List<Double>> timeIntervals, String videoStyle, String sessionKey, Map<String,List<String>> styleOptions, Map<String,String> options) throws GPUdbException
GPUdbException
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 © 2020. All rights reserved.