> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # GPUdb > GPUdb — Kinetica API

Class: GPUdb

GPUdb(url, optionsopt)

GPUdb API object that provides access to GPUdb server functions.

Constructor

new GPUdb(url, optionsopt)

Creates a GPUdb API object for the specified URL using the given options. Once created, all options are immutable; to use a different URL or change options, create a new instance. (Creating a new instance does not communicate with the server and should not cause performance concerns.)
Parameters:
Name Type Attributes Description
url String | Array.\ The URL of the GPUdb server (e.g., [http://hostname:9191](http://hostname:9191)). May also be specified as a list of urls; all urls in the list must be well formed.
options Object \
 A set of configurable options for the GPUdb API.
Properties
Name Type Attributes Description
username String \
 The username to be used for authentication to GPUdb. This username will be sent with every GPUdb request made via the API along with the specified password and may be used for authorization decisions by the server if it is so configured. If neither username nor password is specified, no authentication will be performed.
password String \
 The password to be used for authentication to GPUdb. This password will be sent with every GPUdb request made via the API along with the specified username and may be used for authorization decisions by the server if it is so configured. If neither username nor password is specified, no authentication will be performed.
timeout Number \
 The timeout value, in milliseconds, after which requests to GPUdb will be aborted. A timeout value of zero is interpreted as an infinite timeout. Note that timeout is not suppored for synchronous requests, which will not return until a response is received and cannot be aborted.
client\_name String \
 The client application name to be included in the User-Agent header for HTTP requests. Both client\_name and client\_version must be set for them to be included in the User-Agent header.
client\_version String \
 The client application version to be included in the User-Agent header for HTTP requests. Both client\_name and client\_version must be set for them to be included in the User-Agent header.
Source:
  • ,

Classes

FileHandler

Members

(readonly) END\_OF\_SET :Number

Constant used with certain requests to indicate that the maximum allowed number of results should be returned.
Type:
  • Number
Source:
  • ,

(readonly) api\_version :String

The version number of the GPUdb JavaScript API.
Type:
  • String
Source:
  • ,

(readonly) client\_name :String

The client application name to be included in the User-Agent header for HTTP requests. Will be an empty string if none was provided to the GPUdb constructor.
Type:
  • String
Source:
  • ,

(readonly) client\_version :String

The client application version to be included in the User-Agent header for HTTP requests. Will be an empty string if none was provided to the GPUdb constructor.
Type:
  • String
Source:
  • ,

(readonly) getCookie :function

Function to get request cookie
Type:
  • function
Source:
  • ,

(readonly) hostname :String

The hostname of the current GPUdb server.
Type:
  • String
Source:
  • ,

(readonly) oauth\_token :String

The OAuth2 token used for authentication to GPUdb. Will be an empty string if none was provided to the GPUdb constructor.
Type:
  • String
Source:
  • ,

(readonly) parsedUrls :Array.\

The URLs of the GPUdb servers.
Type:
  • Array.\
Source:
  • ,

(readonly) password :String

The password used for authentication to GPUdb. Will be an empty string if none was provided to the GPUdb constructor.
Type:
  • String
Source:
  • ,

(readonly) pathname :String

The pathname of the current GPUdb server.
Type:
  • String
Source:
  • ,

(readonly) port :String

The port of the current GPUdb server.
Type:
  • String
Source:
  • ,

(readonly) protocol :String

The protocol of the current GPUdb server address.
Type:
  • String
Source:
  • ,

(readonly) setCookie :function

Function to set responce cookie
Type:
  • function
Source:
  • ,

(readonly) timeout :Number

The timeout value, in milliseconds, after which requests to GPUdb will be aborted. A timeout of zero is interpreted as an infinite timeout. Will be zero if none was provided to the GPUdb constructor.
Type:
  • Number
Source:
  • ,

(readonly) url :String

The URL of the current GPUdb server.
Type:
  • String
Source:
  • ,

(readonly) username :String

The username used for authentication to GPUdb. Will be an empty string if none was provided to the GPUdb contructor.
Type:
  • String
Source:
  • ,

Methods

SqlIterator(sql, batchSize, sqlOptions)

A generator function to iterate over the records returned by executing an SQL statement passed as a parameter to the function.
Parameters:
Name Type Description
sql String The SQL statement to execute
batchSize number The number of records to fetch in each batch, defaults to 10,000
sqlOptions Map A Map to pass in the SQL options
Source:
  • ,

add\_http\_header(header, header)

Adds an HTTP header to the map of additional HTTP headers to send to the server with each endpoint request. If the header is already in the map, its value is replaced with the specified value. The user is not allowed to modify the following headers:
  • 'Accept'
  • 'Authorization'
  • 'Content-type'
  • 'X-Kinetica-Group'
Parameters:
Name Type Description
header String The custom header to add.
header String The value for the custom header to add.
Source:
  • ,

admin\_add\_host(host\_address, options, callback) → {"{"}Promise{"}"}

Adds a host to an existing cluster.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
host\_address String IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added.
options Object Optional parameters.
  • 'dry\_run': If set to true, only validation checks will be performed. No host is added. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'accepts\_failover': If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'public\_address': The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
  • 'host\_manager\_public\_url': The publicly-accessible full path URL to the host manager on the host being added, e.g., '[http://172.123.45.67:9300](http://172.123.45.67:9300)'. The default host manager port can be found in the list of ports used by Kinetica.
  • 'ram\_limit': The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if ram\_limit is set to 10M, the resulting RAM limit is 10 million bytes. Set ram\_limit to -1 to have no RAM limit.
  • 'gpus': Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_add\_host\_request(request, callback) → {"{"}Promise{"}"}

Adds a host to an existing cluster.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_add\_ranks(hosts, config\_params, options, callback) → {"{"}Promise{"}"}

Add one or more ranks to an existing Kinetica cluster. The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use GPUdb#admin\_rebalance.

The database must be offline for this operation, see GPUdb#admin\_offline

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)

\* config\_params 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 GPUdb#create\_job.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
hosts Array.\ Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use GPUdb#admin\_add\_host. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, hosts could look like '\["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the config\_params.
config\_params Array.\ Array of maps containing configuration parameters to apply to the new ranks found in hosts. For example, '{"{"}"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"{"}"}'. Currently, the available parameters are rank-specific parameters in the Network, Hardware, Text Search, and RAM Tiered Storage sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by hosts instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in config\_params as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the hosts. This array must either be completely empty or have the same number of elements as the hosts. An empty config\_params array will result in the new ranks being set with default parameters.
options Object Optional parameters.
  • 'dry\_run': If true, only validation checks will be performed. No ranks are added. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_add\_ranks\_request(request, callback) → {"{"}Promise{"}"}

Add one or more ranks to an existing Kinetica cluster. The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use GPUdb#admin\_rebalance.

The database must be offline for this operation, see GPUdb#admin\_offline

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)

\* config\_params 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 GPUdb#create\_job.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_alter\_host(host, options, callback) → {"{"}Promise{"}"}

Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes.
Parameters:
Name Type Description
host String Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf.
options Object Optional parameters.
  • 'accepts\_failover': If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_alter\_host\_request(request, callback) → {"{"}Promise{"}"}

Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_alter\_jobs(job\_ids, action, options, callback) → {"{"}Promise{"}"}

Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
Parameters:
Name Type Description
job\_ids Array.\ Jobs to be modified.
action String Action to be performed on the jobs specified by job\_ids. Supported values:
  • 'cancel'
options Object Optional parameters.
  • 'job\_tag': Job tag returned in call to create the job.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_alter\_jobs\_request(request, callback) → {"{"}Promise{"}"}

Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_backup\_begin(options, callback) → {"{"}Promise{"}"}

Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using GPUdb#admin\_backup\_end.
Parameters:
Name Type Description
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_backup\_begin\_request(request, callback) → {"{"}Promise{"}"}

Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using GPUdb#admin\_backup\_end.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_backup\_end(options, callback) → {"{"}Promise{"}"}

Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete.
Parameters:
Name Type Description
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_backup\_end\_request(request, callback) → {"{"}Promise{"}"}

Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_ha\_offline(offline, options, callback) → {"{"}Promise{"}"}

Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. In-flight queries may fail to replicate to other clusters in the ring when going offline.
Parameters:
Name Type Description
offline Boolean Set to true if desired state is offline. Supported values:
  • true
  • false
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_ha\_offline\_request(request, callback) → {"{"}Promise{"}"}

Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. In-flight queries may fail to replicate to other clusters in the ring when going offline.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_ha\_refresh(options, callback) → {"{"}Promise{"}"}

Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes. Additionally the cluster is put into read-only while HA is restarting.
Parameters:
Name Type Description
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_ha\_refresh\_request(request, callback) → {"{"}Promise{"}"}

Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes. Additionally the cluster is put into read-only while HA is restarting.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_offline(offline, options, callback) → {"{"}Promise{"}"}

Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.
Parameters:
Name Type Description
offline Boolean Set to true if desired state is offline. Supported values:
  • true
  • false
options Object Optional parameters.
  • 'flush\_to\_disk': Flush to disk when going offline. Supported values:
    • 'true'
    • 'false'
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_offline\_request(request, callback) → {"{"}Promise{"}"}

Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_rebalance(options, callback) → {"{"}Promise{"}"}

Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks.

The database must be offline for this operation, see GPUdb#admin\_offline

\* If GPUdb#admin\_rebalance is invoked after a change is made to the cluster, e.g., a host was added or removed, sharded data will be evenly redistributed across the cluster by number of shards per rank while unsharded data will be redistributed across the cluster by data size per rank

\* If GPUdb#admin\_rebalance is invoked at some point when unsharded data (a.k.a. randomly-sharded) in the cluster is unevenly distributed over time, sharded data will not move while unsharded data will be redistributed across the cluster by data size per rank

NOTE: Replicated data will not move as a result of this call

This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb#create\_job.

Parameters:
Name Type Description
options Object Optional parameters.
  • 'rebalance\_sharded\_data': If true, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'rebalance\_unsharded\_data': If true, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'table\_includes': Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table\_excludes. This parameter is ignored if rebalance\_unsharded\_data is false.
  • 'table\_excludes': Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table\_includes. This parameter is ignored if rebalance\_unsharded\_data is false.
  • 'aggressiveness': Influences how much data is moved at a time during rebalance. A higher aggressiveness will complete the rebalance faster. A lower aggressiveness will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
  • '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:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'compact\_only': If set to true, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'repair\_incorrectly\_sharded\_data': Scans for any data sharded incorrectly and re-routes the data to the correct location. Only necessary if GPUdb#admin\_verify\_db reports an error in sharding alignment. 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. If this option is set to true, the time necessary to rebalance and the memory used by the rebalance may increase. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_rebalance\_request(request, callback) → {"{"}Promise{"}"}

Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks.

The database must be offline for this operation, see GPUdb#admin\_offline

\* If GPUdb#admin\_rebalance is invoked after a change is made to the cluster, e.g., a host was added or removed, sharded data will be evenly redistributed across the cluster by number of shards per rank while unsharded data will be redistributed across the cluster by data size per rank

\* If GPUdb#admin\_rebalance is invoked at some point when unsharded data (a.k.a. randomly-sharded) in the cluster is unevenly distributed over time, sharded data will not move while unsharded data will be redistributed across the cluster by data size per rank

NOTE: Replicated data will not move as a result of this call

This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb#create\_job.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_remove\_host(host, options, callback) → {"{"}Promise{"}"}

Removes a host from an existing cluster. If the host to be removed has any ranks running on it, the ranks must be removed using GPUdb#admin\_remove\_ranks or manually switched over to a new host using GPUdb#admin\_switchover prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using GPUdb#admin\_switchover.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
host String Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf.
options Object Optional parameters.
  • 'dry\_run': If set to true, only validation checks will be performed. No host is removed. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_remove\_host\_request(request, callback) → {"{"}Promise{"}"}

Removes a host from an existing cluster. If the host to be removed has any ranks running on it, the ranks must be removed using GPUdb#admin\_remove\_ranks or manually switched over to a new host using GPUdb#admin\_switchover prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using GPUdb#admin\_switchover.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_remove\_ranks(ranks, options, callback) → {"{"}Promise{"}"}

Remove one or more ranks from an existing Kinetica cluster. All data will be rebalanced to other ranks before the rank(s) is removed unless the rebalance\_sharded\_data or rebalance\_unsharded\_data parameters are set to false in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.

The database must be offline for this operation, see GPUdb#admin\_offline

This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb#create\_job.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
ranks Array.\ Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using GPUdb#admin\_switchover). At least one worker rank must be left in the cluster after the operation.
options Object Optional parameters.
  • 'rebalance\_sharded\_data': If true, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'rebalance\_unsharded\_data': If true, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'aggressiveness': Influences how much data is moved at a time during rebalance. A higher aggressiveness will complete the rebalance faster. A lower aggressiveness will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_remove\_ranks\_request(request, callback) → {"{"}Promise{"}"}

Remove one or more ranks from an existing Kinetica cluster. All data will be rebalanced to other ranks before the rank(s) is removed unless the rebalance\_sharded\_data or rebalance\_unsharded\_data parameters are set to false in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.

The database must be offline for this operation, see GPUdb#admin\_offline

This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb#create\_job.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_repair\_table(table\_names, table\_types, options, callback) → {"{"}Promise{"}"}

Manually repair a corrupted table. Returns information about affected tables.
Parameters:
Name Type Description
table\_names Array.\ List of tables to query. An asterisk returns all tables.
table\_types Object ID of the type per table.
options Object Optional parameters.
  • 'repair\_policy': Corrective action to take. Supported values:
    • 'delete\_chunks': Deletes any corrupted chunks.
    • 'shrink\_columns': Shrinks corrupted chunks to the shortest column.
    • 'replay\_wal': Manually invokes write-ahead log (WAL) replay on the table.
    • 'alter\_table': Reset columns modification after incomplete alter column.
  • 'verify\_all': If false only table chunk data already known to be corrupted will be repaired. Otherwise the database will perform a full table scan to check for correctness. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_repair\_table\_request(request, callback) → {"{"}Promise{"}"}

Manually repair a corrupted table. Returns information about affected tables.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_send\_alert(message, label, log\_level, options, callback) → {"{"}Promise{"}"}

Sends a user generated alert to the monitoring system.
Parameters:
Name Type Description
message String Alert message body. The default value is ''.
label String Label to add to alert message. The default value is ''.
log\_level String Alert message logging criteria. Supported values:
  • 'fatal'
  • 'error'
  • 'warn'
  • 'info'
  • 'debug'
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_send\_alert\_request(request, callback) → {"{"}Promise{"}"}

Sends a user generated alert to the monitoring system.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_alerts(num\_alerts, options, callback) → {"{"}Promise{"}"}

Requests a list of the most recent alerts. Returns lists of alert data, including timestamp and type.
Parameters:
Name Type Description
num\_alerts Number Number of most recent alerts to request. The response will include up to num\_alerts depending on how many alerts there are in the system. A value of 0 returns all stored alerts.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_alerts\_request(request, callback) → {"{"}Promise{"}"}

Requests a list of the most recent alerts. Returns lists of alert data, including timestamp and type.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_cluster\_operations(history\_index, options, callback) → {"{"}Promise{"}"}

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by history\_index. Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

Parameters:
Name Type Description
history\_index Number Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_cluster\_operations\_request(request, callback) → {"{"}Promise{"}"}

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by history\_index. Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_jobs(options, callback) → {"{"}Promise{"}"}

Get a list of the current jobs in GPUdb.
Parameters:
Name Type Description
options Object 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'show\_worker\_info': If true, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values:
    • 'true'
    • 'false'
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_jobs\_request(request, callback) → {"{"}Promise{"}"}

Get a list of the current jobs in GPUdb.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_shards(options, callback) → {"{"}Promise{"}"}

Show the mapping of shards to the corresponding rank and tom. The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
Parameters:
Name Type Description
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_show\_shards\_request(request, callback) → {"{"}Promise{"}"}

Show the mapping of shards to the corresponding rank and tom. The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_shutdown(exit\_type, authorization, options, callback) → {"{"}Promise{"}"}

Exits the database server application.
Parameters:
Name Type Description
exit\_type String Reserved for future use. User can pass an empty string.
authorization String No longer used. User can pass an empty string.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_shutdown\_request(request, callback) → {"{"}Promise{"}"}

Exits the database server application.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_switchover(processes, destinations, options, callback) → {"{"}Promise{"}"}

Manually switch over one or more processes to another host. Individual ranks or entire hosts may be moved to another host.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
processes Array.\ Indicates the process identifier to switch over to another host. Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address' or 'rank\[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in destinations.
destinations Array.\ Indicates to which host to switch over each corresponding process given in processes. Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address'. Each entry in this array will receive the corresponding process entry at the same index in processes.
options Object Optional parameters.
  • 'dry\_run': If set to true, only validation checks will be performed. Nothing is switched over. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_switchover\_request(request, callback) → {"{"}Promise{"}"}

Manually switch over one or more processes to another host. Individual ranks or entire hosts may be moved to another host.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_verify\_db(options, callback) → {"{"}Promise{"}"}

Verify database is in a consistent state. When inconsistencies or errors are found, the verified\_ok flag in the response is set to false and the list of errors found is provided in the error\_list.
Parameters:
Name Type Description
options Object Optional parameters.
  • 'rebuild\_on\_error': \[DEPRECATED] Use the Rebuild DB feature of GAdmin instead. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'verify\_nulls': When true, verifies that null values are set to zero. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'verify\_persist': When true, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set concurrent\_safe in options to true or place the database offline. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'concurrent\_safe': When true, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'verify\_rank0': If true, compare rank0 table metadata against workers' metadata. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'delete\_orphaned\_tables': If true, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set concurrent\_safe in options to true. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'verify\_orphaned\_tables\_only': If true, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'table\_includes': Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with table\_excludes.
  • 'table\_excludes': Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with table\_includes.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

admin\_verify\_db\_request(request, callback) → {"{"}Promise{"}"}

Verify database is in a consistent state. When inconsistencies or errors are found, the verified\_ok flag in the response is set to false and the list of errors found is provided in the error\_list.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_convex\_hull(table\_name, x\_column\_name, y\_column\_name, options, callback) → {"{"}Promise{"}"}

Calculates and returns the convex hull for the values in a table specified by table\_name.
Parameters:
Name Type Description
table\_name String Name of table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.
x\_column\_name String Name of the column containing the x coordinates of the points for the operation being performed.
y\_column\_name String Name of the column containing the y coordinates of the points for the operation being performed.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_convex\_hull\_request(request, callback) → {"{"}Promise{"}"}

Calculates and returns the convex hull for the values in a table specified by table\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_group\_by(table\_name, column\_names, offset, limit, options, callback) → {"{"}Promise{"}"}

Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates.

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 column\_names is an unrestricted-length string.

Parameters:
Name Type Description
table\_name String Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_names Array.\ List of one or more column names, expressions, and aggregate expressions.
offset Number 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 Number 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 has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of result\_table. If result\_table\_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_result\_table\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema as part of result\_table and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema which is to contain the table specified in result\_table. If the schema provided is non-existent, it will be automatically created.
  • 'expression': Filter expression to apply to the table prior to computing the aggregate group by.
  • 'pipelined\_expression\_evaluation': Evaluate the group-by during last JoinedSet filter plan step. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'having': Filter expression to apply to the aggregated results.
  • 'sort\_order': \[DEPRECATED--use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:
    • 'ascending': Indicates that the returned values should be sorted in ascending order.
    • 'descending': Indicates that the returned values should be sorted in descending order.
    The default value is 'ascending'.
  • 'sort\_by': \[DEPRECATED--use order\_by instead] String determining how the results are sorted. Supported values:
    • 'key': Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
    • 'value': Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
    The default value is 'value'.
  • '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 ''.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for the result table's columns.
  • 'result\_table': The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
  • 'result\_table\_persist': If true, then the result table specified in result\_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'result\_table\_force\_replicated': Force the result table to be replicated (ignores any sharding). Must be used in combination with the result\_table option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'result\_table\_generate\_pk': If true then set a primary key for the result table. Must be used in combination with the result\_table option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'result\_table\_generate\_soft\_pk': If true then set a soft primary key for the result table. Must be used in combination with the result\_table option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in result\_table.
  • 'chunk\_size': Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a 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.
  • 'partition\_type': Partitioning scheme to use for the result table. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'view\_id': ID of view of which the result table will be a member. The default value is ''.
  • 'pivot': Pivot column.
  • 'pivot\_values': Comma-separated list of the values in the pivot column. The list provided will become the column header prefixes in the output.
  • 'grouping\_sets': Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes.
  • 'rollup': This option is used to specify the multilevel aggregates.
  • 'cube': This option is used to specify the multidimensional aggregates.
  • 'shard\_key': Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in column\_names. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_group\_by\_request(request, callback) → {"{"}Promise{"}"}

Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates.

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 column\_names is an unrestricted-length string.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_histogram(table\_name, column\_name, start, end, interval, options, callback) → {"{"}Promise{"}"}

Performs a histogram calculation given a table, a column, and an interval function. The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive--except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value\_column. In this latter case the sum of the values corresponding to the value\_column is used as the result instead. The total number of bins requested cannot exceed 10,000.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value\_column.

Parameters:
Name Type Description
table\_name String Name of the table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name String Name of a column or an expression of one or more column names over which the histogram will be calculated.
start Number Lower end value of the histogram interval, inclusive.
end Number Upper end value of the histogram interval, inclusive.
interval Number The size of each bin within the start and end parameters.
options Object 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).
  • 'start': The start parameter for char types.
  • 'end': The end parameter for char types.
  • 'interval': The interval parameter for char types.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_histogram\_request(request, callback) → {"{"}Promise{"}"}

Performs a histogram calculation given a table, a column, and an interval function. The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive--except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value\_column. In this latter case the sum of the values corresponding to the value\_column is used as the result instead. The total number of bins requested cannot exceed 10,000.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value\_column.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_k\_means(table\_name, column\_names, k, tolerance, options, callback) → {"{"}Promise{"}"}

This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters:
Name Type Description
table\_name String Name of the table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_names Array.\ 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 Number The number of mean points to be determined by the algorithm.
tolerance Number Stop iterating when the distances between successive points is less than the given tolerance.
options Object 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.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of result\_table. If result\_table\_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_result\_table\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'result\_table': The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If this option is specified, the results are not returned in the response.
  • 'result\_table\_persist': If true, then the result table specified in result\_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in result\_table.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_k\_means\_request(request, callback) → {"{"}Promise{"}"}

This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_min\_max(table\_name, column\_name, options, callback) → {"{"}Promise{"}"}

Calculates and returns the minimum and maximum values of a particular column in a table.
Parameters:
Name Type Description
table\_name String Name of the table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name String Name of a column or an expression of one or more column on which the min-max will be calculated.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_min\_max\_geometry(table\_name, column\_name, options, callback) → {"{"}Promise{"}"}

Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
Parameters:
Name Type Description
table\_name String Name of the table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name String Name of a geospatial geometry column on which the min-max will be calculated.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_min\_max\_geometry\_request(request, callback) → {"{"}Promise{"}"}

Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_min\_max\_request(request, callback) → {"{"}Promise{"}"}

Calculates and returns the minimum and maximum values of a particular column in a table.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_statistics(table\_name, column\_name, stats, options, callback) → {"{"}Promise{"}"}

Calculates the requested statistics of the given column(s) in a given table.

The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted\_average, cardinality (unique count), estimated\_cardinality, percentile, and percentile\_rank.

Estimated cardinality is calculated by using the hyperloglog approximation technique.

Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile\_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile\_rank(1234.56),percentile\_rank(-5)').

A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.

The weighted average statistic requires a weight column to be specified in weight\_column\_name. The weighted average is then defined as the sum of the products of column\_name 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 additional\_column\_names. 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 and mean of column\_name x and additional\_column\_names y and 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, and z values (30), and the single average value across all x, y, and z values (15.5).

The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Parameters:
Name Type Description
table\_name String Name of the table on which the statistics operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name String Name of the primary column for which the statistics are to be calculated.
stats String Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
  • 'count': Number of objects (independent of the given column(s)).
  • 'mean': Arithmetic mean (average), equivalent to sum/count.
  • 'stdv': Sample standard deviation (denominator is count-1).
  • 'variance': Unbiased sample variance (denominator is count-1).
  • 'skew': Skewness (third standardized moment).
  • 'kurtosis': Kurtosis (fourth standardized moment).
  • 'sum': Sum of all values in the column(s).
  • 'min': Minimum value of the column(s).
  • 'max': Maximum value of the column(s).
  • 'weighted\_average': Weighted arithmetic mean (using the option weight\_column\_name as the weighting column).
  • 'cardinality': Number of unique values in the column(s).
  • 'estimated\_cardinality': Estimate (via hyperloglog technique) of the number of unique values in the column(s).
  • 'percentile': Estimate (via t-digest) of the given percentile of the column(s) (percentile(50.0) will be an approximation of the median). Add a second, comma-separated value to calculate percentile resolution, e.g., 'percentile(75,150)'.
  • 'percentile\_rank': Estimate (via t-digest) of the percentile rank of the given value in the column(s) (if the given value is the median of the column(s), percentile\_rank() will return approximately 50.0).
options Object 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 column\_name must be of the same type. Must not include the column specified in column\_name and no column can be listed twice.
  • 'weight\_column\_name': Name of column used as weighting attribute for the weighted average statistic.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_statistics\_by\_range(table\_name, select\_expression, column\_name, value\_column\_name, stats, start, end, interval, options, callback) → {"{"}Promise{"}"}

Divides the given set into bins and calculates statistics of the values of a value-column in each bin. The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in weight\_column\_name. 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, bin\_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin\_values list are placed in the nth bin. When a list is provided, the binning-column must be of type string or int.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters:
Name Type Description
table\_name String Name of the table on which the ranged-statistics operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
select\_expression String For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''.
column\_name String Name of the binning-column used to divide the set samples into bins.
value\_column\_name String Name of the value-column for which statistics are to be computed.
stats String 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 Number The lower bound of the binning-column.
end Number The upper bound of the binning-column.
interval Number 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 Object Optional parameters.
  • 'additional\_column\_names': A list of comma separated value-column names over which statistics can be accumulated along with the primary value\_column.
  • 'bin\_values': A list of comma separated binning-column values. Values that match the nth bin\_values value are placed in the nth bin.
  • 'weight\_column\_name': Name of the column used as weighting column for the weighted\_average statistic.
  • 'order\_column\_name': Name of the column used for candlestick charting techniques.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_statistics\_by\_range\_request(request, callback) → {"{"}Promise{"}"}

Divides the given set into bins and calculates statistics of the values of a value-column in each bin. The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in weight\_column\_name. 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, bin\_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin\_values list are placed in the nth bin. When a list is provided, the binning-column must be of type string or int.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_statistics\_request(request, callback) → {"{"}Promise{"}"}

Calculates the requested statistics of the given column(s) in a given table.

The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted\_average, cardinality (unique count), estimated\_cardinality, percentile, and percentile\_rank.

Estimated cardinality is calculated by using the hyperloglog approximation technique.

Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile\_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile\_rank(1234.56),percentile\_rank(-5)').

A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.

The weighted average statistic requires a weight column to be specified in weight\_column\_name. The weighted average is then defined as the sum of the products of column\_name 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 additional\_column\_names. 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 and mean of column\_name x and additional\_column\_names y and 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, and z values (30), and the single average value across all x, y, and z values (15.5).

The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_unique(table\_name, column\_name, offset, limit, options, callback) → {"{"}Promise{"}"}

Returns all the unique values from a particular column (specified by column\_name) of a particular table or view (specified by table\_name). If column\_name is a numeric column, the values will be in binary\_encoded\_response. Otherwise if column\_name is a string column, the values will be in json\_encoded\_response. The results can be paged via offset and limit parameters.

{"{"}"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 column\_name, 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 column\_name is an unrestricted-length string.

Parameters:
Name Type Description
table\_name String Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name String Name of the column or an expression containing one or more column names on which the unique function would be applied.
offset Number 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 Number 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 has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of result\_table. If result\_table\_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_result\_table\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema as part of result\_table and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema which is to contain the table specified in result\_table. If the schema provided is non-existent, it will be automatically created.
  • 'expression': Filter expression to apply to the table.
  • 'sort\_order': String indicating how the returned values should be sorted. Supported values:
    • 'ascending'
    • 'descending'
    The default value is 'ascending'.
  • '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 ''.
  • 'result\_table': The name of the table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if column\_name is an unrestricted-length string.
  • 'result\_table\_persist': If true, then the result table specified in result\_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'result\_table\_force\_replicated': Force the result table to be replicated (ignores any sharding). Must be used in combination with the result\_table option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'result\_table\_generate\_pk': If true then set a primary key for the result table. Must be used in combination with the result\_table option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in result\_table.
  • 'chunk\_size': Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'compression\_codec': The default compression codec for the result table's columns.
  • 'view\_id': ID of view of which the result table will be a member. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_unique\_request(request, callback) → {"{"}Promise{"}"}

Returns all the unique values from a particular column (specified by column\_name) of a particular table or view (specified by table\_name). If column\_name is a numeric column, the values will be in binary\_encoded\_response. Otherwise if column\_name is a string column, the values will be in json\_encoded\_response. The results can be paged via offset and limit parameters.

{"{"}"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 column\_name, 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 column\_name is an unrestricted-length string.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_unpivot(table\_name, column\_names, variable\_column\_name, value\_column\_name, pivoted\_columns, options, callback) → {"{"}Promise{"}"}

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters:
Name Type Description
table\_name String Name of the table on which the operation will be performed. Must be an existing table/view, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_names Array.\ List of column names or expressions. A wildcard '\*' can be used to include all the non-pivoted columns from the source table.
variable\_column\_name String Specifies the variable/parameter column name. The default value is ''.
value\_column\_name String Specifies the value column name. The default value is ''.
pivoted\_columns Array.\ 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 Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of result\_table. If result\_table\_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_result\_table\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema as part of result\_table and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema which is to contain the table specified in result\_table. If the schema is non-existent, it will be automatically created.
  • 'result\_table': The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
  • 'result\_table\_persist': If true, then the result table specified in result\_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'expression': Filter expression to apply to the table prior to unpivot processing.
  • 'order\_by': Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
  • 'chunk\_size': Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result\_table option.
  • 'compression\_codec': The default compression codec for the result table's columns.
  • '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 ''.
  • 'create\_indexes': Comma-separated list of columns on which to create indexes on the table specified in result\_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
  • 'result\_table\_force\_replicated': Force the result table to be replicated (ignores any sharding). Must be used in combination with the result\_table option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

aggregate\_unpivot\_request(request, callback) → {"{"}Promise{"}"}

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_backup(backup\_name, action, value, datasink\_name, options, callback) → {"{"}Promise{"}"}

Alters an existing database backup, accessible via the data sink specified by datasink\_name.
Parameters:
Name Type Description
backup\_name String Name of the backup to be altered.
action String Operation to be applied. Supported values:
  • 'checksum': Calculate checksum for backed-up files.
  • 'ddl\_only': Whether or not to only save DDL and not back up table data, when taking future snapshots; set value to 'true' or 'false' for DDL only or DDL and table data, respectively.
  • 'max\_incremental\_backups\_to\_keep': Maximum number of incremental snapshots to keep, when taking future snapshots; set value to the number of snapshots to keep.
  • 'merge': Merges all snapshots within a backup and creates a single full snapshot.
  • 'purge': Deletes a snapshot from a backup; set value to the snapshot ID to purge.
value String Value of the modification, depending on action.
datasink\_name String Data sink through which the backup is accessible.
options Object Optional parameters.
  • 'comment': Comments to store with the backup.
  • 'dry\_run': Whether or not to perform a dry run of a backup alteration. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_backup\_request(request, callback) → {"{"}Promise{"}"}

Alters an existing database backup, accessible via the data sink specified by datasink\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_credential(credential\_name, credential\_updates\_map, options, callback) → {"{"}Promise{"}"}

Alter the properties of an existing credential.
Parameters:
Name Type Description
credential\_name String Name of the credential to be altered. Must be an existing credential.
credential\_updates\_map Object Map containing the properties of the credential to be updated. Error if empty.
  • 'type': New type for the credential. Supported values:
    • 'aws\_access\_key'
    • 'aws\_iam\_role'
    • 'azure\_ad'
    • 'azure\_oauth'
    • 'azure\_sas'
    • 'azure\_storage\_key'
    • 'docker'
    • 'gcs\_service\_account\_id'
    • 'gcs\_service\_account\_keys'
    • 'hdfs'
    • 'kafka'
  • 'identity': New user for the credential.
  • 'secret': New password for the credential.
  • 'schema\_name': Updates the schema name. If schema\_name doesn't exist, an error will be thrown. If schema\_name is empty, then the user's default schema will be used.
options Object Optional parameters.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_credential\_request(request, callback) → {"{"}Promise{"}"}

Alter the properties of an existing credential.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_datasink(name, datasink\_updates\_map, options, callback) → {"{"}Promise{"}"}

Alters the properties of an existing data sink.
Parameters:
Name Type Description
name String Name of the data sink to be altered. Must be an existing data sink.
datasink\_updates\_map Object Map containing the properties of the data sink to be updated. Error if empty.
  • 'destination': Destination for the output data in format 'destination\_type://path\[:port]'. Supported destination types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
  • 'connection\_timeout': Timeout in seconds for connecting to this sink.
  • 'wait\_timeout': Timeout in seconds for waiting for a response from this sink.
  • 'credential': Name of the credential object to be used in this data sink.
  • 's3\_bucket\_name': Name of the Amazon S3 bucket to use as the data sink.
  • 's3\_region': Name of the Amazon S3 region where the given bucket is located.
  • 's3\_verify\_ssl': Whether to verify SSL connections. Supported values:
    • 'true': Connect with SSL verification.
    • 'false': Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
    The default value is 'true'.
  • 's3\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 's3\_aws\_role\_arn': Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user.
  • 's3\_encryption\_customer\_algorithm': Customer encryption algorithm used encrypting data.
  • 's3\_encryption\_customer\_key': Customer encryption key to encrypt or decrypt data.
  • 's3\_encryption\_type': Server side encryption type.
  • 's3\_kms\_key\_id': KMS key.
  • 'hdfs\_kerberos\_keytab': Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
  • 'hdfs\_delegation\_token': Delegation token for the given HDFS user.
  • 'hdfs\_use\_kerberos': Use kerberos authentication for the given HDFS cluster. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'azure\_storage\_account\_name': Name of the Azure storage account to use as the data sink, this is valid only if tenant\_id is specified.
  • 'azure\_container\_name': Name of the Azure storage container to use as the data sink.
  • 'azure\_tenant\_id': Active Directory tenant ID (or directory ID).
  • 'azure\_sas\_token': Shared access signature token for Azure storage account to use as the data sink.
  • 'azure\_oauth\_token': OAuth token to access given storage container.
  • 'azure\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Azure source. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 'gcs\_bucket\_name': Name of the Google Cloud Storage bucket to use as the data sink.
  • 'gcs\_project\_id': Name of the Google Cloud project to use as the data sink.
  • 'gcs\_service\_account\_keys': Google Cloud service account keys to use for authenticating the data sink.
  • 'jdbc\_driver\_jar\_path': JDBC driver jar file location. This may be a KIFS file.
  • 'jdbc\_driver\_class\_name': Name of the JDBC driver class.
  • 'kafka\_url': The publicly-accessible full path URL to the kafka broker, e.g., '[http://172.123.45.67:9300](http://172.123.45.67:9300)'.
  • 'kafka\_topic\_name': Name of the Kafka topic to use for this data sink, if it references a Kafka broker.
  • 'anonymous': Create an anonymous connection to the storage provider--DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'use\_managed\_credentials': When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'use\_https': Use HTTPS to connect to datasink if true, otherwise use HTTP. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'max\_batch\_size': Maximum number of records per notification message. The default value is '1'.
  • 'max\_message\_size': Maximum size in bytes of each notification message. The default value is '1000000'.
  • 'json\_format': The desired format of JSON encoded notifications message. Supported values:
    • 'flat': A single record is returned per message.
    • 'nested': Records are returned as an array per message.
    The default value is 'flat'.
  • 'skip\_validation': Bypass validation of connection to this data sink. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'schema\_name': Updates the schema name. If schema\_name doesn't exist, an error will be thrown. If schema\_name is empty, then the user's default schema will be used.
options Object Optional parameters.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_datasink\_request(request, callback) → {"{"}Promise{"}"}

Alters the properties of an existing data sink.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_datasource(name, datasource\_updates\_map, options, callback) → {"{"}Promise{"}"}

Alters the properties of an existing data source.
Parameters:
Name Type Description
name String Name of the data source to be altered. Must be an existing data source.
datasource\_updates\_map Object Map containing the properties of the data source to be updated. Error if empty.
  • 'location': Location of the remote storage in 'storage\_provider\_type://\[storage\_path\[:storage\_port]]' format. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'jdbc', 'kafka', 'confluent', and 's3'.
  • 'user\_name': Name of the remote system user; may be an empty string.
  • 'password': Password for the remote system user; may be an empty string.
  • 'skip\_validation': Bypass validation of connection to remote source. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'connection\_timeout': Timeout in seconds for connecting to this storage provider.
  • 'wait\_timeout': Timeout in seconds for reading from this storage provider.
  • 'credential': Name of the credential object to be used in data source.
  • 's3\_bucket\_name': Name of the Amazon S3 bucket to use as the data source.
  • 's3\_region': Name of the Amazon S3 region where the given bucket is located.
  • 's3\_verify\_ssl': Whether to verify SSL connections. Supported values:
    • 'true': Connect with SSL verification.
    • 'false': Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
    The default value is 'true'.
  • 's3\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 's3\_aws\_role\_arn': Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user.
  • 's3\_encryption\_customer\_algorithm': Customer encryption algorithm used encrypting data.
  • 's3\_encryption\_customer\_key': Customer encryption key to encrypt or decrypt data.
  • 'hdfs\_kerberos\_keytab': Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
  • 'hdfs\_delegation\_token': Delegation token for the given HDFS user.
  • 'hdfs\_use\_kerberos': Use kerberos authentication for the given HDFS cluster. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'azure\_storage\_account\_name': Name of the Azure storage account to use as the data source, this is valid only if tenant\_id is specified.
  • 'azure\_container\_name': Name of the Azure storage container to use as the data source.
  • 'azure\_tenant\_id': Active Directory tenant ID (or directory ID).
  • 'azure\_sas\_token': Shared access signature token for Azure storage account to use as the data source.
  • 'azure\_oauth\_token': OAuth token to access given storage container.
  • 'azure\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Azure source. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 'gcs\_bucket\_name': Name of the Google Cloud Storage bucket to use as the data source.
  • 'gcs\_project\_id': Name of the Google Cloud project to use as the data source.
  • 'gcs\_service\_account\_keys': Google Cloud service account keys to use for authenticating the data source.
  • 'jdbc\_driver\_jar\_path': JDBC driver jar file location. This may be a KIFS file.
  • 'jdbc\_driver\_class\_name': Name of the JDBC driver class.
  • 'kafka\_url': The publicly-accessible full path URL to the Kafka broker, e.g., '[http://172.123.45.67:9300](http://172.123.45.67:9300)'.
  • 'kafka\_topic\_name': Name of the Kafka topic to use as the data source.
  • 'anonymous': Create an anonymous connection to the storage provider--DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'use\_managed\_credentials': When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'use\_https': Use HTTPS to connect to datasource if true, otherwise use HTTP. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'schema\_name': Updates the schema name. If schema\_name doesn't exist, an error will be thrown. If schema\_name is empty, then the user's default schema will be used.
  • 'schema\_registry\_connection\_retries': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_connection\_timeout': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_credential': Confluent Schema Registry credential object name.
  • 'schema\_registry\_location': Location of Confluent Schema Registry in '\[storage\_path\[:storage\_port]]' format.
  • 'schema\_registry\_port': Confluent Schema Registry port (optional).
options Object Optional parameters.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_datasource\_request(request, callback) → {"{"}Promise{"}"}

Alters the properties of an existing data source.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_directory(directory\_name, directory\_updates\_map, options, callback) → {"{"}Promise{"}"}

Alters an existing directory in KiFS.
Parameters:
Name Type Description
directory\_name String Name of the directory in KiFS to be altered.
directory\_updates\_map Object Map containing the properties of the directory to be altered. Error if empty.
  • 'data\_limit': The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_directory\_request(request, callback) → {"{"}Promise{"}"}

Alters an existing directory in KiFS.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_environment(environment\_name, action, value, options, callback) → {"{"}Promise{"}"}

Alters an existing environment which can be referenced by a user-defined function (UDF).
Parameters:
Name Type Description
environment\_name String Name of the environment to be altered.
action String Modification operation to be applied. Supported values:
  • 'install\_package': Install a python package from PyPI, an external data source or KiFS.
  • 'install\_requirements': Install packages from a requirements file.
  • 'uninstall\_package': Uninstall a python package.
  • 'uninstall\_requirements': Uninstall packages from a requirements file.
  • 'reset': Uninstalls all packages in the environment and resets it to the original state at time of creation.
  • 'rebuild': Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.
value String The value of the modification, depending on action. For example, if action is install\_package, this would be the python package name. If action is install\_requirements, this would be the path of a requirements file from which to install packages. If an external data source is specified in datasource\_name, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in KiFS.
options Object Optional parameters.
  • 'datasource\_name': Name of an existing external data source from which packages specified in value can be loaded.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_environment\_request(request, callback) → {"{"}Promise{"}"}

Alters an existing environment which can be referenced by a user-defined function (UDF).
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_resource\_group(name, tier\_attributes, ranking, adjoining\_resource\_group, options, callback) → {"{"}Promise{"}"}

Alters the properties of an existing resource group to facilitate resource management.
Parameters:
Name Type Description
name String Name of the group to be altered. Must be an existing resource group name or an empty string when used in conjunction with is\_default\_group.
tier\_attributes Object 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 and RAM tiers. For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: {"{"}'VRAM':{"{"}'max\_memory':'1000000000'{"}"}, 'RAM':{"{"}'max\_memory':'10000000000'{"}"}{"}"}.
  • 'max\_memory': Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier.
The default value is an empty object ( {"{"}{"}"} ).
ranking String If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be placed. Supported values:
  • '': Don't change the ranking.
  • 'first': Make this resource group the new first one in the ordering.
  • 'last': Make this resource group the new last one in the ordering.
  • 'before': Place this resource group before the one specified by adjoining\_resource\_group in the ordering.
  • 'after': Place this resource group after the one specified by adjoining\_resource\_group in the ordering.
The default value is ''.
adjoining\_resource\_group String 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 Object Optional parameters.
  • 'max\_cpu\_concurrency': Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is '4'.
  • 'max\_data': Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is '-1'.
  • 'max\_scheduling\_priority': Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'.
  • 'max\_tier\_priority': Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'.
  • '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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'persist': If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_resource\_group\_request(request, callback) → {"{"}Promise{"}"}

Alters the properties of an existing resource group to facilitate resource management.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_role(name, action, value, options, callback) → {"{"}Promise{"}"}

Alters a Role.
Parameters:
Name Type Description
name String Name of the role to be altered. Must be an existing role.
action String Modification operation to be applied to the role. Supported values:
  • 'set\_comment': Sets the comment for an internal role.
  • '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 String The value of the modification, depending on action.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_role\_request(request, callback) → {"{"}Promise{"}"}

Alters a Role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_schema(schema\_name, action, value, options, callback) → {"{"}Promise{"}"}

Used to change the name of a SQL-style schema, specified in schema\_name.
Parameters:
Name Type Description
schema\_name String Name of the schema to be altered.
action String Modification operation to be applied. Supported values:
  • 'add\_comment': Adds a comment describing the schema.
  • 'rename\_schema': Renames a schema to value. Has the same naming restrictions as tables.
value String The value of the modification, depending on action. For now the only value of action is rename\_schema. In this case the value is the new name of the schema.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_schema\_request(request, callback) → {"{"}Promise{"}"}

Used to change the name of a SQL-style schema, specified in schema\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_system\_properties(property\_updates\_map, options, callback) → {"{"}Promise{"}"}

The GPUdb#alter\_system\_properties 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 property\_updates\_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
Parameters:
Name Type Description
property\_updates\_map Object Map containing the properties of the system to be updated. Error if empty.
  • 'concurrent\_kernel\_execution': Enables concurrent kernel execution if the value is true and disables it if the value is false. Supported values:
    • 'true'
    • 'false'
  • '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 limited by resource group limits and/or system load.
  • 'chunk\_size': Sets the number of records per chunk to be used for all new tables.
  • 'chunk\_column\_max\_memory': Sets the target maximum data size for each column in a chunk to be used for all new tables.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
  • '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.
  • 'request\_timeout': Number of minutes after which filtering (e.g., GPUdb#filter) and aggregating (e.g., GPUdb#aggregate\_group\_by) queries will timeout. The default value is '20'. The minimum allowed value is '0'. The maximum allowed value is '1440'.
  • 'max\_get\_records\_size': The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'. The minimum allowed value is '0'. The maximum allowed value is '1000000'.
  • '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.
  • 'audit\_response': Enable or disable auditing of response information.
  • 'shadow\_agg\_size': Size of the shadow aggregate chunk cache in bytes. The default value is '10000000'. The minimum allowed value is '0'. The maximum allowed value is '2147483647'.
  • 'shadow\_filter\_size': Size of the shadow filter chunk cache in bytes. The default value is '10000000'. The minimum allowed value is '0'. The maximum allowed value is '2147483647'.
  • 'enable\_overlapped\_equi\_join': Enable overlapped-equi-join filter. The default value is 'true'.
  • 'enable\_one\_step\_compound\_equi\_join': Enable the one\_step compound-equi-join algorithm. The default value is 'true'.
  • 'kafka\_batch\_size': Maximum number of records to be ingested in a single batch. The default value is '1000'. The minimum allowed value is '1'. The maximum allowed value is '10000000'.
  • 'kafka\_poll\_timeout': Maximum time (milliseconds) for each poll to get records from Kafka. The default value is '0'. The minimum allowed value is '0'. The maximum allowed value is '1000'.
  • 'kafka\_wait\_time': Maximum time (seconds) to buffer records received from Kafka before ingestion. The default value is '30'. The minimum allowed value is '1'. The maximum allowed value is '120'.
  • 'egress\_parquet\_compression': Parquet file compression type. Supported values:
    • 'uncompressed'
    • 'snappy'
    • 'gzip'
    The default value is 'snappy'.
  • 'egress\_single\_file\_max\_size': Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is '10000'. The minimum allowed value is '1'. The maximum allowed value is '200000'.
  • 'max\_concurrent\_kernels': Sets the max\_concurrent\_kernels value of the conf. The minimum allowed value is '0'. The maximum allowed value is '256'.
  • 'system\_metadata\_retention\_period': Sets the system\_metadata.retention\_period value of the conf. The minimum allowed value is '1'.
  • 'tcs\_per\_tom': Size of the worker rank data calculation thread pool. This is primarily used for computation-based operations such as aggregates and record retrieval. The minimum allowed value is '2'. The maximum allowed value is '8192'.
  • 'tps\_per\_tom': Size of the worker rank data processing thread pool. This includes operations such as inserts, updates, and deletes on table data. Multi-head inserts are not affected by this limit. The minimum allowed value is '2'. The maximum allowed value is '8192'.
  • 'background\_worker\_threads': Size of the worker rank background thread pool. This includes background operations such as watermark evictions catalog table updates. The minimum allowed value is '1'. The maximum allowed value is '8192'.
  • 'log\_debug\_job\_info': Outputs various job-related information to the rank logs. Used for troubleshooting.
  • 'enable\_thread\_hang\_logging': Log a stack trace for any thread that runs longer than a defined threshold. Used for troubleshooting. The default value is 'true'.
  • 'ai\_enable\_rag': Enable RAG. The default value is 'false'.
  • 'ai\_api\_provider': AI API provider type.
  • 'ai\_api\_url': AI API URL.
  • 'ai\_api\_key': AI API key.
  • 'ai\_api\_connection\_timeout': AI API connection timeout in seconds.
  • 'ai\_api\_embeddings\_model': AI API model name.
  • 'telm\_persist\_query\_metrics': Enable or disable persisting of query metrics.
  • 'telm\_force\_metrics\_duration': Capture metrics for any query exceeding this duration in seconds.
  • 'postgres\_proxy\_idle\_connection\_timeout': Idle connection timeout in seconds.
  • 'postgres\_proxy\_keep\_alive': Enable postgres proxy keep alive. The default value is 'false'.
  • 'kifs\_directory\_data\_limit': The default maximum capacity to apply when creating a KiFS directory (bytes). The minimum allowed value is '-1'.
  • 'compression\_codec': The default compression algorithm applied to any column without a column-level or table-level default compression specified at the time it was created.
  • 'disk\_auto\_optimize\_timeout': Time interval in seconds after which the database will apply optimizations/transformations to persisted data, such as compression. The minimum allowed value is '0'.
  • 'ha\_consumer\_replay\_offset': Initializes HA replay from the given timestamp (as milliseconds since unix epoch). The minimum allowed value is '-1'.
  • 'admin\_access\_only': Restricts access to system admin users only. The default value is 'false'.
options Object Optional parameters.
  • 'evict\_to\_cold': If true and evict\_columns is specified, the given objects will be evicted to cold storage (if such a tier exists). Supported values:
    • 'true'
    • 'false'
  • 'persist': If true the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_system\_properties\_request(request, callback) → {"{"}Promise{"}"}

The GPUdb#alter\_system\_properties 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 property\_updates\_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table(table\_name, action, value, options, callback) → {"{"}Promise{"}"}

Apply various modifications to a table or view. The available modifications include the following:

Manage a table's columns--a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.

External tables cannot be modified except for their refresh method.

Create or delete a column, low-cardinality index, chunk skip, geospatial, CAGRA, or HNSW index. 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 or an external table.

Set the time-to-live (TTL). This can be applied to tables or views.

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.

Parameters:
Name Type Description
table\_name String Table on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view.
action String Modification operation to be applied. Supported values:
  • 'create\_index': Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW 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.
  • 'refresh\_index': Refreshes an index identified by index\_type, on the column name specified in value. Currently applicable only to CAGRA indices.
  • 'delete\_index': Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW 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': \[DEPRECATED--please use move\_to\_schema and use GPUdb#create\_schema to create the schema if non-existent] Moves a table or view into a schema named value. If the schema provided is non-existent, it will be automatically created.
  • 'move\_to\_schema': Moves a table or view into a schema named value. If the schema provided is nonexistent, an error will be thrown. If value is empty, then the table or view will be placed in the user's default schema.
  • 'protected': No longer used. Previously set whether the given table\_name should be protected or not. The value would have been either 'true' or 'false'.
  • 'rename\_table': Renames a table or view to value. Has the same naming restrictions as tables.
  • 'ttl': Sets the time-to-live in minutes of the table or view specified in table\_name.
  • 'add\_comment': Adds the comment specified in value to the table specified in table\_name. Use column\_name to set the comment for a column.
  • 'add\_column': Adds the column specified in value to the table specified in table\_name. 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.
  • 'delete\_column': Deletes the column specified in value from the table specified in table\_name.
  • 'set\_default': Sets or replaces the default value expression for the column specified in value. The new default is taken from add\_column\_expression. Existing properties on the column are preserved.
  • 'delete\_default': Removes the default value expression from the column specified in value. Other column properties are preserved.
  • '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 table\_name. Specify the access mode in value. Valid modes are 'no\_access', 'read\_only', 'write\_only' and 'read\_write'.
  • 'refresh': For a materialized view, replays all the table creation commands required to create the view. For an external table, reloads all data in the table from its associated source files or data source.
  • 'set\_refresh\_method': For a materialized view, sets the method by which the view is refreshed to the method specified in value - one of 'manual', 'periodic', or 'on\_change'. For an external table, sets the method by which the table is refreshed to the method specified in value - either 'manual' or 'on\_start'.
  • '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\_stop\_time': Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in value with format 'YYYY-MM-DD HH:MM:SS'.
  • '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.
  • 'set\_refresh\_span': Sets the future time-offset(in seconds) for the view refresh to stop.
  • 'set\_refresh\_execute\_as': Sets the user name to refresh this materialized view to the value specified in value.
  • 'remove\_text\_search\_attributes': Removes text search attribute from all columns.
  • 'remove\_shard\_keys': Removes the shard key property from all columns, so that the table will be considered randomly sharded. The data is not moved. The value is ignored.
  • '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.
  • 'cancel\_datasource\_subscription': Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure / GCS.
  • 'drop\_datasource\_subscription': Permanently delete a cancelled data source subscription.
  • 'pause\_datasource\_subscription': Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure / GCS.
  • 'resume\_datasource\_subscription': Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure / GCS.
  • 'change\_owner': Change the owner resource group of the table.
  • 'set\_load\_vectors\_policy': Set startup data loading scheme for the table; see description of 'load\_vectors\_policy' in GPUdb#create\_table for possible values for value.
  • 'set\_build\_pk\_index\_policy': Set startup primary key generation scheme for the table; see description of 'build\_pk\_index\_policy' in GPUdb#create\_table for possible values for value.
  • 'set\_build\_materialized\_view\_policy': Set startup rebuilding scheme for the materialized view; see description of 'build\_materialized\_view\_policy' in GPUdb#create\_materialized\_view for possible values for value.
value String 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 Object Optional parameters.
  • 'action'
  • 'column\_name'
  • 'table\_name'
  • 'column\_default\_value': When adding a column, set a literal default value for existing records. For nullable columns, the default value will be null, regardless of data type. Also persisted as the column's default for future inserts that omit the column.
  • 'column\_properties': When adding or changing a column, set the column properties (strings, separated by a comma: data, 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).
  • '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 (or not). Supported values:
    • 'true': Validate all values. A value too large (or too long) for the new type will prevent any change.
    • 'false': When a value is too large or long, it will be truncated.
    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.
    The default value is 'true'.
  • 'add\_column\_expression': When adding a column or setting a new default with action set to set\_default, the new default expression (GPUdb-syntax) for the column. Any valid expression may be used, including one containing references to existing columns in the same table. Persisted as the column's default for future inserts that omit the column; for add\_column, also used to backfill existing rows.
  • 'add\_column\_expression\_sql': Optional SQL-syntax form of add\_column\_expression, used only when the SQL syntax differs from the GPUdb syntax. Persisted alongside the GPUdb form so SHOW CREATE TABLE / information\_schema can reproduce the original SQL.
  • 'strategy\_definition': 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.
  • 'index\_type': Type of index to create, when action is create\_index; to refresh, when action is refresh\_index; or to delete, when action is delete\_index. Supported values: The default value is 'column'.
  • 'index\_options': Options to use when creating an index, in the format "key: value \[, key: value \[, ...]]". Valid options vary by index type.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table\_columns(table\_name, column\_alterations, options, callback) → {"{"}Promise{"}"}

Apply various modifications to columns in a table, view. The available modifications include the following:

Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Manage a table's columns--a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.

Parameters:
Name Type Description
table\_name String Table on which the operation will be performed. Must be an existing table or view, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_alterations Array.\ 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 Object Optional parameters.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table\_columns\_request(request, callback) → {"{"}Promise{"}"}

Apply various modifications to columns in a table, view. The available modifications include the following:

Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Manage a table's columns--a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table\_metadata(table\_names, metadata\_map, options, callback) → {"{"}Promise{"}"}

Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
Parameters:
Name Type Description
table\_names Array.\ Names of the tables whose metadata will be updated, in \[schema\_name.]table\_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned.
metadata\_map Object 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 Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table\_metadata\_request(request, callback) → {"{"}Promise{"}"}

Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table\_monitor(topic\_id, monitor\_updates\_map, options, callback) → {"{"}Promise{"}"}

Alters a table monitor previously created with GPUdb#create\_table\_monitor.
Parameters:
Name Type Description
topic\_id String The topic ID returned by GPUdb#create\_table\_monitor.
monitor\_updates\_map Object Map containing the properties of the table monitor to be updated. Error if empty.
  • 'schema\_name': Updates the schema name. If schema\_name doesn't exist, an error will be thrown. If schema\_name is empty, then the user's default schema will be used.
  • 'max\_consecutive\_failures': Updates the maximum number of consecutive failures before suspending the stream. A value of '-1' to disables auto-suspend. This value is by rank and not overall.
  • 'notifications': Updates the state of the monitor. Supported values:
    • 'resume'
    • 'suspend'
    The default value is an empty object ( {"{"}{"}"} ).
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table\_monitor\_request(request, callback) → {"{"}Promise{"}"}

Alters a table monitor previously created with GPUdb#create\_table\_monitor.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_table\_request(request, callback) → {"{"}Promise{"}"}

Apply various modifications to a table or view. The available modifications include the following:

Manage a table's columns--a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.

External tables cannot be modified except for their refresh method.

Create or delete a column, low-cardinality index, chunk skip, geospatial, CAGRA, or HNSW index. 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 or an external table.

Set the time-to-live (TTL). This can be applied to tables or views.

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.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_tier(name, options, callback) → {"{"}Promise{"}"}

Alters properties of an existing tier to facilitate resource management.

To disable watermark-based eviction, set both high\_watermark and low\_watermark to 100.

Parameters:
Name Type Description
name String Name of the tier to be altered. Must be an existing tier group name: vram, ram, disk\[n], persist, cold\[n].
options Object Optional parameters.
  • 'capacity': Maximum size in bytes this tier may hold at once, per rank.
  • 'high\_watermark': Threshold of usage of this tier's resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'.
  • 'low\_watermark': Threshold of resource usage that once fallen below after crossing the high\_watermark, will cease watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'.
  • 'wait\_timeout': Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.
  • 'persist': If true the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'rank': Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_tier\_request(request, callback) → {"{"}Promise{"}"}

Alters properties of an existing tier to facilitate resource management.

To disable watermark-based eviction, set both high\_watermark and low\_watermark to 100.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_user(name, action, value, options, callback) → {"{"}Promise{"}"}

Alters a user.
Parameters:
Name Type Description
name String Name of the user to be altered. Must be an existing user.
action String Modification operation to be applied to the user. Supported values:
  • 'set\_activated': Is the user allowed to login.
  • 'true': User may login.
  • 'false': User may not login.
  • 'set\_comment': Sets the comment for an internal user.
  • 'set\_default\_schema': Set the default\_schema for an internal user. An empty string means the user will have no default schema.
  • '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 String The value of the modification, depending on action.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_user\_request(request, callback) → {"{"}Promise{"}"}

Alters a user.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_video(path, options, callback) → {"{"}Promise{"}"}

Alters a video.
Parameters:
Name Type Description
path String Fully-qualified KiFS path to the video to be altered.
options Object Optional parameters.
  • 'ttl': Sets the TTL of the video.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_video\_request(request, callback) → {"{"}Promise{"}"}

Alters a video.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_wal(table\_names, options, callback) → {"{"}Promise{"}"}

Alters table write-ahead log (WAL) settings. Returns information about the requested table WAL modifications.
Parameters:
Name Type Description
table\_names Array.\ List of tables to modify. An asterisk changes the system settings.
options Object Optional parameters.
  • 'max\_segment\_size': Maximum size of an individual segment file.
  • 'segment\_count': Approximate number of segment files to split the WAL across. Must be at least two.
  • 'sync\_policy': Maximum size of an individual segment file. Supported values:
    • 'none': Disables the WAL.
    • 'background': WAL entries are periodically written instead of immediately after each operation.
    • 'flush': Protects entries in the event of a database crash.
    • 'fsync': Protects entries in the event of an OS crash.
  • 'flush\_frequency': Specifies how frequently WAL entries are written with background sync. This is a global setting and can only be used with the system {"{"}options.table\_names{"}"} specifier '\*'.
  • 'checksum': If true each entry will be checked against a protective checksum. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'override\_non\_default': If true tables with unique WAL settings will be overridden when applying a system level change. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'restore\_system\_settings': If true tables with unique WAL settings will be reverted to the current global settings. Cannot be used in conjunction with any other option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'persist': If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

alter\_wal\_request(request, callback) → {"{"}Promise{"}"}

Alters table write-ahead log (WAL) settings. Returns information about the requested table WAL modifications.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

append\_records(table\_name, source\_table\_name, field\_map, options, callback) → {"{"}Promise{"}"}

Append (or insert) all records from a source table (specified by source\_table\_name) to a particular target table (specified by table\_name). The field map (specified by field\_map) holds the user specified map of target table column names with their mapped source column names.
Parameters:
Name Type Description
table\_name String The table name for the records to be appended, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
source\_table\_name String The source table name to get records from, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table name.
field\_map Object Contains the mapping of column names from the target table (specified by table\_name) as the keys, and corresponding column names or expressions (e.g., 'col\_name+1') from the source table (specified by source\_table\_name). 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 Object Optional parameters.
  • 'offset': A positive integer indicating the number of initial results to skip from source\_table\_name. Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. The default value is '0'.
  • 'limit': A positive integer indicating the maximum number of results to be returned from source\_table\_name. Or END\_OF\_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
  • 'expression': Filter expression to apply to the source\_table\_name. The default value is ''.
  • 'order\_by': Comma-separated list of the columns to be sorted by from source table (specified by source\_table\_name), e.g., 'timestamp asc, x desc'. The order\_by columns do not have to be present in field\_map. The default value is ''.
  • 'update\_on\_existing\_pk': Specifies the record collision policy for inserting source table records (specified by source\_table\_name) into a target table (specified by table\_name) with a primary key. If set to true, any existing table record with primary key values that match those of a source table record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by ignore\_existing\_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Upsert new records when primary keys match existing records.
    • 'false': Reject new records when primary keys match existing records.
    The default value is 'false'.
  • 'enable\_inplace\_updates': Applies only when upserting (when update\_on\_existing\_pk is true). If set to true, an existing record matched by primary key is modified in place. If set to false, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for inserting source table records (specified by source\_table\_name) into a target table (specified by table\_name) with a primary key, only used when not in upsert mode (upsert mode is disabled when update\_on\_existing\_pk is false). If set to true, any source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If false, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. If the specified table does not have a primary key or if upsert mode is in effect (update\_on\_existing\_pk is true), then this option has no effect. Supported values:
    • 'true': Ignore source table records whose primary key values collide with those of target table records.
    • 'false': Raise an error for any source table record whose primary key values collide with those of a target table record.
    The default value is 'false'.
  • 'pk\_conflict\_predicate\_higher': The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
  • 'pk\_conflict\_predicate\_lower': The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
  • '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:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

append\_records\_request(request, callback) → {"{"}Promise{"}"}

Append (or insert) all records from a source table (specified by source\_table\_name) to a particular target table (specified by table\_name). The field map (specified by field\_map) holds the user specified map of target table column names with their mapped source column names.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

check\_table(table\_names, options, callback) → {"{"}Promise{"}"}

Scans the requested tables as specified in table\_names for integrity. Any table chunks which fail the check will be marked as corrupt. By default the database will automatically repair corrupt tables (via truncating). Note that since this reads every table column from disk it may be a potentially long-running operation. The option local\_only can be used to skip any table files already written to a remote storage. Returns table corruption results.
Parameters:
Name Type Description
table\_names Array.\ List of tables to query. An asterisk returns all tables.
options Object Optional parameters.
  • 'local\_only': If true only locally persisted files will be checked. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'show\_detail': If true reports individual chunk errors. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

check\_table\_request(request, callback) → {"{"}Promise{"}"}

Scans the requested tables as specified in table\_names for integrity. Any table chunks which fail the check will be marked as corrupt. By default the database will automatically repair corrupt tables (via truncating). Note that since this reads every table column from disk it may be a potentially long-running operation. The option local\_only can be used to skip any table files already written to a remote storage. Returns table corruption results.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_statistics(table\_name, column\_name, options, callback) → {"{"}Promise{"}"}

Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
Parameters:
Name Type Description
table\_name String Name of a table, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table. The default value is ''.
column\_name String Name of the column in table\_name 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 Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_statistics\_request(request, callback) → {"{"}Promise{"}"}

Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_table(table\_name, authorization, options, callback) → {"{"}Promise{"}"}

Clears (drops) one or all tables in the database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
Parameters:
Name Type Description
table\_name String Name of the table to be cleared, in \[schema\_name.]table\_name format, using standard name resolution rules. 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 String No longer used. User can pass an empty string. The default value is ''.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If true and if the table specified in table\_name does not exist no error is returned. If false and if the table specified in table\_name does not exist then an error is returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_table\_monitor(topic\_id, options, callback) → {"{"}Promise{"}"}

Deactivates a table monitor previously created with GPUdb#create\_table\_monitor.
Parameters:
Name Type Description
topic\_id String The topic ID returned by GPUdb#create\_table\_monitor.
options Object Optional parameters.
  • 'keep\_autogenerated\_sink': If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If false, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'clear\_all\_references': If true, all references that share the same topic\_id will be cleared. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_table\_monitor\_request(request, callback) → {"{"}Promise{"}"}

Deactivates a table monitor previously created with GPUdb#create\_table\_monitor.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_table\_request(request, callback) → {"{"}Promise{"}"}

Clears (drops) one or all tables in the database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_tables(table\_names, options, callback) → {"{"}Promise{"}"}

Clears (drops) tables in the database cluster. The operation is synchronous meaning that the tables will be cleared before the function returns. The response payload returns the status of the operation for each table requested.
Parameters:
Name Type Description
table\_names Array.\ Names of the tables to be cleared, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable\_clear\_all'. The default value is an empty array ( \[] ).
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If true and if a table specified in table\_names does not exist no error is returned. If false and if a table specified in table\_names does not exist then an error is returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_tables\_request(request, callback) → {"{"}Promise{"}"}

Clears (drops) tables in the database cluster. The operation is synchronous meaning that the tables will be cleared before the function returns. The response payload returns the status of the operation for each table requested.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_trigger(trigger\_id, options, callback) → {"{"}Promise{"}"}

Clears or cancels the trigger identified by the specified handle. The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
Parameters:
Name Type Description
trigger\_id String ID for the trigger to be deactivated.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

clear\_trigger\_request(request, callback) → {"{"}Promise{"}"}

Clears or cancels the trigger identified by the specified handle. The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

collect\_statistics(table\_name, column\_names, options, callback) → {"{"}Promise{"}"}

Collect statistics for a column(s) in a specified table.
Parameters:
Name Type Description
table\_name String Name of a table, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table. A value of '\*' collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, column\_names must be '\*'.
column\_names Array.\ List of one or more column names in table\_name for which to collect statistics (cardinality, mean value, etc.). A single entry of '\*' expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

collect\_statistics\_request(request, callback) → {"{"}Promise{"}"}

Collect statistics for a column(s) in a specified table.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_backup(backup\_name, backup\_type, backup\_objects\_map, datasink\_name, options, callback) → {"{"}Promise{"}"}

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasink\_name.
Parameters:
Name Type Description
backup\_name String Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.
backup\_type String Type of snapshot to create. Supported values:
  • 'differential': Snapshot of changes in the database objects and data since the last full snapshot.
  • 'full': Snapshot of the given database objects and data.
  • 'incremental': Snapshot of changes in the database objects and data since the last snapshot of any kind.
backup\_objects\_map Object Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot. The default value is an empty object ( {"{"}{"}"} ).
datasink\_name String Data sink through which the backup will be stored.
options Object Optional parameters.
  • 'checksum': Whether or not to calculate checksums for backup files. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'comment': Comments to store with this backup.
  • 'ddl\_only': Whether or not, for tables, to only backup DDL and not table data. Supported values:
    • 'true': For tables, only back up DDL, not data.
    • 'false': For tables, back up DDL and data.
    The default value is 'false'.
  • 'delete\_intermediate\_backups': Whether or not to delete any intermediate snapshots when the backup\_type is set to differential. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'dry\_run': Whether or not to perform a dry run of a backup operation. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'max\_incremental\_backups\_to\_keep': Maximum number of incremental snapshots to keep. The default value is '-1'.
  • 'recreate': Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_backup\_request(request, callback) → {"{"}Promise{"}"}

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasink\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_catalog(name, table\_format, location, type, credential, datasource, options, callback) → {"{"}Promise{"}"}

Creates a catalog, which contains the location and connection information for a deltalake catalog that is external to the database.
Parameters:
Name Type Description
name String Name of the catalog to be created.
table\_format String Table format (iceberg, hudi, deltalake).
location String Location of the catalog in 'http\[s]://\[server\[:port]]]' format.
type String Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue).
credential String Name of the credential object to be used in catalog.
datasource String Password for the remote system user; may be an empty string.
options Object Optional parameters.
  • 'access\_delegation': Use access delegation for object store. Supported values:
    • 'datasource\_credentials'
    • 'vended\_credentials'
    The default value is 'datasource\_credentials'.
  • 'skip\_validation': Bypass validation of connection to remote source. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_catalog\_request(request, callback) → {"{"}Promise{"}"}

Creates a catalog, which contains the location and connection information for a deltalake catalog that is external to the database.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_credential(credential\_name, type, identity, secret, options, callback) → {"{"}Promise{"}"}

Create a new credential.
Parameters:
Name Type Description
credential\_name String Name of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.
type String Type of the credential to be created. Supported values:
  • 'aws\_access\_key'
  • 'aws\_iam\_role'
  • 'azure\_ad'
  • 'azure\_oauth'
  • 'azure\_sas'
  • 'azure\_storage\_key'
  • 'confluent'
  • 'docker'
  • 'gcs\_service\_account\_id'
  • 'gcs\_service\_account\_keys'
  • 'hdfs'
  • 'jdbc'
  • 'kafka'
  • 'nvidia\_api\_key'
  • 'openai\_api\_key'
  • 'rest'
identity String User of the credential to be created.
secret String Password of the credential to be created.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_credential\_request(request, callback) → {"{"}Promise{"}"}

Create a new credential.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_datasink(name, destination, options, callback) → {"{"}Promise{"}"}

Creates a data sink, which contains the destination information for a data sink that is external to the database.
Parameters:
Name Type Description
name String Name of the data sink to be created.
destination String Destination for the output data in format 'storage\_provider\_type://path\[:port]'. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
options Object Optional parameters.
  • 'connection\_timeout': Timeout in seconds for connecting to this data sink.
  • 'wait\_timeout': Timeout in seconds for waiting for a response from this data sink.
  • 'credential': Name of the credential object to be used in this data sink.
  • 's3\_bucket\_name': Name of the Amazon S3 bucket to use as the data sink.
  • 's3\_region': Name of the Amazon S3 region where the given bucket is located.
  • 's3\_verify\_ssl': Whether to verify SSL connections. Supported values:
    • 'true': Connect with SSL verification.
    • 'false': Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
    The default value is 'true'.
  • 's3\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 's3\_aws\_role\_arn': Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user.
  • 's3\_encryption\_customer\_algorithm': Customer encryption algorithm used encrypting data.
  • 's3\_encryption\_customer\_key': Customer encryption key to encrypt or decrypt data.
  • 's3\_encryption\_type': Server side encryption type.
  • 's3\_kms\_key\_id': KMS key.
  • 'hdfs\_kerberos\_keytab': Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
  • 'hdfs\_delegation\_token': Delegation token for the given HDFS user.
  • 'hdfs\_use\_kerberos': Use kerberos authentication for the given HDFS cluster. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'azure\_storage\_account\_name': Name of the Azure storage account to use as the data sink, this is valid only if tenant\_id is specified.
  • 'azure\_container\_name': Name of the Azure storage container to use as the data sink.
  • 'azure\_tenant\_id': Active Directory tenant ID (or directory ID).
  • 'azure\_sas\_token': Shared access signature token for Azure storage account to use as the data sink.
  • 'azure\_oauth\_token': Oauth token to access given storage container.
  • 'azure\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Azure source. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 'gcs\_bucket\_name': Name of the Google Cloud Storage bucket to use as the data sink.
  • 'gcs\_project\_id': Name of the Google Cloud project to use as the data sink.
  • 'gcs\_service\_account\_keys': Google Cloud service account keys to use for authenticating the data sink.
  • 'jdbc\_driver\_jar\_path': JDBC driver jar file location.
  • 'jdbc\_driver\_class\_name': Name of the JDBC driver class.
  • 'kafka\_topic\_name': Name of the Kafka topic to publish to if destination is a Kafka broker.
  • 'max\_batch\_size': Maximum number of records per notification message. The default value is '1'.
  • 'max\_message\_size': Maximum size in bytes of each notification message. The default value is '1000000'.
  • 'json\_format': The desired format of JSON encoded notifications message. Supported values:
    • 'flat': A single record is returned per message.
    • 'nested': Records are returned as an array per message.
    The default value is 'flat'.
  • 'use\_managed\_credentials': When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'use\_https': Use HTTPS to connect to datasink if true, otherwise use HTTP. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'skip\_validation': Bypass validation of connection to this data sink. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_datasink\_request(request, callback) → {"{"}Promise{"}"}

Creates a data sink, which contains the destination information for a data sink that is external to the database.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_datasource(name, location, user\_name, password, options, callback) → {"{"}Promise{"}"}

Creates a data source, which contains the location and connection information for a data store that is external to the database.
Parameters:
Name Type Description
name String Name of the data source to be created.
location String Location of the remote storage in 'storage\_provider\_type://\[storage\_path\[:storage\_port]]' format. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'jdbc', 'kafka', 'confluent', and 's3'.
user\_name String Name of the remote system user; may be an empty string.
password String Password for the remote system user; may be an empty string.
options Object Optional parameters.
  • 'skip\_validation': Bypass validation of connection to remote source. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'connection\_timeout': Timeout in seconds for connecting to this storage provider.
  • 'wait\_timeout': Timeout in seconds for reading from this storage provider.
  • 'credential': Name of the credential object to be used in data source.
  • 's3\_bucket\_name': Name of the Amazon S3 bucket to use as the data source.
  • 's3\_region': Name of the Amazon S3 region where the given bucket is located.
  • 's3\_verify\_ssl': Whether to verify SSL connections. Supported values:
    • 'true': Connect with SSL verification.
    • 'false': Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
    The default value is 'true'.
  • 's3\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 's3\_aws\_role\_arn': Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user.
  • 's3\_encryption\_customer\_algorithm': Customer encryption algorithm used encrypting data.
  • 's3\_encryption\_customer\_key': Customer encryption key to encrypt or decrypt data.
  • 'hdfs\_kerberos\_keytab': Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
  • 'hdfs\_delegation\_token': Delegation token for the given HDFS user.
  • 'hdfs\_use\_kerberos': Use kerberos authentication for the given HDFS cluster. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'azure\_storage\_account\_name': Name of the Azure storage account to use as the data source, this is valid only if tenant\_id is specified.
  • 'azure\_container\_name': Name of the Azure storage container to use as the data source.
  • 'azure\_tenant\_id': Active Directory tenant ID (or directory ID).
  • 'azure\_sas\_token': Shared access signature token for Azure storage account to use as the data source.
  • 'azure\_oauth\_token': OAuth token to access given storage container.
  • 'azure\_use\_virtual\_addressing': Whether to use virtual addressing when referencing the Azure source. Supported values:
    • 'true': The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
    • 'false': Use path-style URI for requests.
    The default value is 'true'.
  • 'gcs\_bucket\_name': Name of the Google Cloud Storage bucket to use as the data source.
  • 'gcs\_project\_id': Name of the Google Cloud project to use as the data source.
  • 'gcs\_service\_account\_keys': Google Cloud service account keys to use for authenticating the data source.
  • 'is\_stream': To load from Azure/GCS/S3 as a stream continuously. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'kafka\_topic\_name': Name of the Kafka topic to use as the data source.
  • 'jdbc\_driver\_jar\_path': JDBC driver jar file location. This may be a KIFS file.
  • 'jdbc\_driver\_class\_name': Name of the JDBC driver class.
  • 'anonymous': Use anonymous connection to storage provider--DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'use\_managed\_credentials': When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'use\_https': Use HTTPS to connect to datasource if true, otherwise use HTTP. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'schema\_registry\_location': Location of Confluent Schema Registry in '\[storage\_path\[:storage\_port]]' format.
  • 'schema\_registry\_credential': Confluent Schema Registry credential object name.
  • 'schema\_registry\_port': Confluent Schema Registry port (optional).
  • 'schema\_registry\_connection\_retries': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_connection\_timeout': Confluent Schema registry connection timeout (in secs).
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_datasource\_request(request, callback) → {"{"}Promise{"}"}

Creates a data source, which contains the location and connection information for a data store that is external to the database.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_directory(directory\_name, options, callback) → {"{"}Promise{"}"}

Creates a new directory in KiFS. The new directory serves as a location in which the user can upload files using GPUdb#upload\_files.
Parameters:
Name Type Description
directory\_name String Name of the directory in KiFS to be created.
options Object Optional parameters.
  • 'create\_home\_directory': When set, a home directory is created for the user name provided in the value. The directory\_name must be an empty string in this case. The user must exist.
  • 'data\_limit': The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
  • 'no\_error\_if\_exists': If true, does not return an error if the directory already exists. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_directory\_request(request, callback) → {"{"}Promise{"}"}

Creates a new directory in KiFS. The new directory serves as a location in which the user can upload files using GPUdb#upload\_files.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_environment(environment\_name, options, callback) → {"{"}Promise{"}"}

Creates a new environment which can be used by user-defined functions (UDF).
Parameters:
Name Type Description
environment\_name String Name of the environment to be created.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_environment\_request(request, callback) → {"{"}Promise{"}"}

Creates a new environment which can be used by user-defined functions (UDF).
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_graph(graph\_name, directed\_graph, nodes, edges, weights, restrictions, options, callback) → {"{"}Promise{"}"}

Creates a new graph network using given nodes, edges, weights, and restrictions.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters:
Name Type Description
graph\_name String Name of the graph resource to generate.
directed\_graph Boolean 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:
  • true
  • false
The default value is true.
nodes Array.\ 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 Array.\ 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 Array.\ 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 Array.\ 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 Object Optional parameters.
  • '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-5'.
  • 'recreate': If set to true and the graph (using graph\_name) already exists, the graph is deleted and recreated. Supported values:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    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 GPUdb#create\_table\_monitor. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'graph\_table': If specified, the created graph is also created as a table with the given name, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. The table will have the following identifier columns: 'EDGE\_ID', 'EDGE\_NODE1\_ID', 'EDGE\_NODE2\_ID'. If left blank, no table is created. The default value is ''.
  • '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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'is\_partitioned': Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'server\_id': Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory.
  • 'use\_rtree': Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'label\_delimiter': If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
  • 'allow\_multiple\_edges': Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'embedding\_table': If table exists (should be generated by the match/graph match\_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_graph\_request(request, callback) → {"{"}Promise{"}"}

Creates a new graph network using given nodes, edges, weights, and restrictions.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_job(endpoint, request\_encoding, data, data\_str, options, callback) → {"{"}Promise{"}"}

Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by GPUdb#get\_job.
Parameters:
Name Type Description
endpoint String Indicates which endpoint to execute, e.g. '/alter/table'.
request\_encoding String The encoding of the request payload for the job. Supported values:
  • 'binary'
  • 'json'
  • 'snappy'
The default value is 'binary'.
data String 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 request\_encoding must be binary or snappy.
data\_str String 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 request\_encoding must be json.
options Object Optional parameters.
  • 'job\_tag': Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '\_' and '-'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_job\_request(request, callback) → {"{"}Promise{"}"}

Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by GPUdb#get\_job.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_join\_table(join\_table\_name, table\_names, column\_names, expressions, options, callback) → {"{"}Promise{"}"}

Creates a table that is the result of a SQL JOIN.

For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Parameters:
Name Type Description
join\_table\_name String Name of the join table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.
table\_names Array.\ The list of table names composing the join, each in \[schema\_name.]table\_name format, using standard name resolution rules. Corresponds to a SQL statement FROM clause.
column\_names Array.\ 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 Array.\ 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 array ( \[] ).
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of join\_table\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_join\_table\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the join as part of join\_table\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the join. If the schema is non-existent, it will be automatically created. The default value is ''.
  • 'max\_query\_dimensions': No longer used.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'ttl': Sets the TTL of the join table specified in join\_table\_name.
  • '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 GPUdb#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.
  • 'enable\_virtual\_chunking': Collect chunks with accumulated size less than chunk\_size into a single chunk. The default value is 'false'.
  • 'max\_virtual\_chunk\_size': Maximum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk\_size if virtual chunking otherwise enabled.
  • 'min\_virtual\_chunk\_size': Minimum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk\_size if virtual chunking otherwise enabled.
  • 'enable\_sparse\_virtual\_chunking': Materialize virtual chunks with only non-deleted values. The default value is 'false'.
  • 'enable\_equi\_join\_lazy\_result\_store': Allow using the lazy result store to cache computation of one side of a multichunk equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
  • 'enable\_predicate\_equi\_join\_lazy\_result\_store': Allow using the lazy result store to cache computation of one side of a multichunk predicate-equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
  • 'enable\_pk\_equi\_join': Use equi-join to do primary key joins rather than using primary key index.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_join\_table\_request(request, callback) → {"{"}Promise{"}"}

Creates a table that is the result of a SQL JOIN.

For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_materialized\_view(table\_name, options, callback) → {"{"}Promise{"}"}

Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains view\_id, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Parameters:
Name Type Description
table\_name String Name of the table to be created that is the top-level table of the materialized view, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.
options Object Optional parameters.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the materialized view as part of table\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema provided is non-existent, it will be automatically created.
  • 'execute\_as': User name to use to run the refresh job.
  • 'build\_materialized\_view\_policy': Sets startup materialized view rebuild scheme. Supported values:
    • 'always': Rebuild as many materialized views as possible before accepting requests.
    • 'lazy': Rebuild the necessary materialized views at start, and load the remainder lazily.
    • 'on\_demand': Rebuild materialized views as requests use them.
    • 'system': Rebuild materialized views using the system-configured default.
    The default value is 'system'.
  • 'persist': If true, then the materialized view specified in table\_name will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'enable\_mv\_input\_wrappers': If true, each base table the view reads is accessed through a wrapper view so an in-progress out-of-place update cannot make a record momentarily disappear from the view, and a long refresh does not block updates to the base tables. Overrides the {"{"}gaia.enable\_mv\_input\_wrappers{"}"} configuration default when set. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'refresh\_span': Sets the future time-offset(in seconds) at which periodic refresh stops.
  • 'refresh\_stop\_time': When refresh\_method is periodic, specifies the time at which a periodic refresh is stopped. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
  • '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 GPUdb#alter\_table with an 'action' of 'refresh'.
    • 'on\_query': Refresh any time the view is queried.
    • 'on\_change': If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
    • 'periodic': Refresh table periodically at rate specified by refresh\_period.
    The default value is 'manual'.
  • 'refresh\_period': When refresh\_method is periodic, specifies the period in seconds at which refresh occurs.
  • 'refresh\_start\_time': When refresh\_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
  • 'ttl': Sets the TTL of the table specified in table\_name.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_materialized\_view\_request(request, callback) → {"{"}Promise{"}"}

Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains view\_id, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_proc(proc\_name, execution\_mode, files, command, args, options, callback) → {"{"}Promise{"}"}

Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.
Parameters:
Name Type Description
proc\_name String Name of the proc to be created. Must not be the name of a currently existing proc.
execution\_mode String 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 direct access to any tables named as input or output table parameters in the call to GPUdb#execute\_proc. It will, however, be able to access the database using native API calls.
The default value is 'distributed'.
files Object 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. Files may be loaded from existing files in KiFS. Those file names should be prefixed with the uri kifs\:// and the values in the map should be empty. The default value is an empty object ( {"{"}{"}"} ).
command String 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 Array.\ An array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty array ( \[] ).
options Object 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'.
  • 'set\_environment': A python environment to use when executing the proc. Must be an existing environment, else an error will be returned. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_proc\_request(request, callback) → {"{"}Promise{"}"}

Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_projection(table\_name, projection\_name, column\_names, options, callback) → {"{"}Promise{"}"}

Creates a new projection of an existing table. A projection represents a subset of the columns (potentially including derived columns) of a table.

For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as GPUdb#get\_records\_by\_column.

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 table\_name 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)).

Parameters:
Name Type Description
table\_name String Name of the existing table on which the projection is to be applied, in \[schema\_name.]table\_name format, using standard name resolution rules. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions.
projection\_name String Name of the projection to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.
column\_names Array.\ List of columns from table\_name to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax 'column\_name as alias'.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of projection\_name. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_projection\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the projection as part of projection\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the projection. If the schema is non-existent, it will be automatically created. The default value is ''.
  • 'expression': An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
  • 'is\_replicated': If true then the projection will be replicated even if the source table is not. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'offset': The number of initial results to skip (this can be useful for paging through the results). The default value is '0'.
  • 'limit': The number of records to keep. The default value is '-9999'.
  • '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 column\_names. 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 this projection.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for this projection.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a 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 column\_names. 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 projection\_name.
  • 'shard\_key': Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in column\_names. 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 projection\_name will be persisted and will not expire unless a ttl is specified. If false, then the projection will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'preserve\_dict\_encoding': If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'retain\_partitions': Determines whether the created projection will retain the partitioning scheme from the source table. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'partition\_type': Partitioning scheme to use. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'view\_id': ID of view of which this projection is a member. The default value is ''.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for the projection's columns.
  • 'join\_window\_functions': If set, window functions which require a reshard will be computed separately and joined back together, if the width of the projection is greater than the join\_window\_functions\_threshold. The default value is 'true'.
  • 'join\_window\_functions\_threshold': If the projection is greater than this width (in bytes), then window functions which require a reshard will be computed separately and joined back together. The default value is ''.
  • 'qualify\_filter': An optional filter expression applied to the projection after window function evaluation, equivalent to a SQL QUALIFY clause. May reference window function aliases as well as any other column in the projection. Rows for which the expression evaluates to false (or NULL) are removed from the projection. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_projection\_request(request, callback) → {"{"}Promise{"}"}

Creates a new projection of an existing table. A projection represents a subset of the columns (potentially including derived columns) of a table.

For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as GPUdb#get\_records\_by\_column.

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 table\_name 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)).

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_resource\_group(name, tier\_attributes, ranking, adjoining\_resource\_group, options, callback) → {"{"}Promise{"}"}

Creates a new resource group to facilitate resource management.
Parameters:
Name Type Description
name String 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.
tier\_attributes Object 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 and RAM tiers. For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: {"{"}'VRAM':{"{"}'max\_memory':'1000000000'{"}"}, 'RAM':{"{"}'max\_memory':'10000000000'{"}"}{"}"}.
  • 'max\_memory': Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier.
The default value is an empty object ( {"{"}{"}"} ).
ranking String Indicates the relative ranking among existing resource groups where this new resource group will be placed. Supported values:
  • 'first': Make this resource group the new first one in the ordering.
  • 'last': Make this resource group the new last one in the ordering.
  • 'before': Place this resource group before the one specified by adjoining\_resource\_group in the ordering.
  • 'after': Place this resource group after the one specified by adjoining\_resource\_group in the ordering.
adjoining\_resource\_group String 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 Object Optional parameters.
  • 'max\_cpu\_concurrency': Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is '4'.
  • 'max\_data': Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is '-1'.
  • 'max\_scheduling\_priority': Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'.
  • 'max\_tier\_priority': Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_resource\_group\_request(request, callback) → {"{"}Promise{"}"}

Creates a new resource group to facilitate resource management.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_role(name, options, callback) → {"{"}Promise{"}"}

Creates a new role.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
name String 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 Object Optional parameters.
  • 'resource\_group': Name of an existing resource group to associate with this user.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_role\_request(request, callback) → {"{"}Promise{"}"}

Creates a new role.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_schema(schema\_name, options, callback) → {"{"}Promise{"}"}

Creates a SQL-style schema. Schemas are containers for tables and views. Multiple tables and views can be defined with the same name in different schemas.
Parameters:
Name Type Description
schema\_name String Name of the schema to be created. Has the same naming restrictions as tables.
options Object Optional parameters.
  • 'no\_error\_if\_exists': If true, prevents an error from occurring if the schema already exists. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_schema\_request(request, callback) → {"{"}Promise{"}"}

Creates a SQL-style schema. Schemas are containers for tables and views. Multiple tables and views can be defined with the same name in different schemas.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_table(table\_name, type\_id, options, callback) → {"{"}Promise{"}"}

Creates a new table with the given type (definition of columns). The type is specified in type\_id as either a numerical type ID (as returned by GPUdb#create\_type) or as a list of columns, each specified as a list of the column name, data type, and any column attributes.

Example of a type definition with some parameters: 

    \[
        \["id", "int8", "primary\_key"],
        \["dept\_id", "int8", "primary\_key", "shard\_key"],
        \["manager\_id", "int8", "nullable"],
        \["first\_name", "char32"],
        \["last\_name", "char64"],
        \["salary", "decimal"],
        \["hire\_date", "date"]
    ]
Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the properties map values from GPUdb#create\_type), and any data handling, data key, or data replacement properties.

A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.

Parameters:
Name Type Description
table\_name String Name of the table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the no\_error\_if\_exists option.
type\_id String The type for the table, specified as either an existing table's numerical type ID (as returned by GPUdb#create\_type) or a type definition (as described above).
options Object Optional parameters.
  • 'no\_error\_if\_exists': If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of table\_name. If is\_result\_table is true, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_table\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema as part of table\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.
  • 'is\_collection': \[DEPRECATED--please use GPUdb#create\_schema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'is\_replicated': 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'foreign\_keys': Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  • 'foreign\_shard\_key': Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  • 'partition\_type': Partitioning scheme to use. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in table\_name.
  • 'chunk\_size': Indicates the number of records per chunk to be used for this table.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for this table.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a chunk to be used for this table.
  • 'is\_result\_table': Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for this table's columns.
  • 'load\_vectors\_policy': Set startup data loading scheme for the table. Supported values:
    • 'always': Load as much vector data as possible into memory before accepting requests.
    • 'lazy': Load the necessary vector data at start, and load the remainder lazily.
    • 'on\_demand': Load vector data as requests use it.
    • 'system': Load vector data using the system-configured default.
    The default value is 'system'.
  • 'build\_pk\_index\_policy': Set startup primary-key index generation scheme for the table. Supported values:
    • 'always': Generate as much primary key index data as possible before accepting requests.
    • 'lazy': Generate the necessary primary key index data at start, and load the remainder lazily.
    • 'on\_demand': Generate primary key index data as requests use it.
    • 'system': Generate primary key index data using the system-configured default.
    The default value is 'system'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_table\_external(table\_name, filepaths, modify\_columns, create\_table\_options, options, callback) → {"{"}Promise{"}"}

Creates a new external table, which is a local database object whose source data is located externally to the database. The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.

The external table can have its structure defined explicitly, via create\_table\_options, which contains many of the options from GPUdb#create\_table; or defined implicitly, inferred from the source data.

Parameters:
Name Type Description
table\_name String Name of the table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.
filepaths Array.\ A list of file paths from which data will be sourced; For paths in KiFS, use the URI prefix of kifs\:// followed by the path to a file or directory. File matching by prefix is supported, e.g. kifs\://dir/file would match dir/file\_1 and dir/file\_2. When prefix matching is used, the path must start with a full, valid KiFS directory name. If an external data source is specified in datasource\_name, these file paths must resolve to accessible files at that data source location. Prefix matching is supported. If the data source is hdfs, prefixes must be aligned with directories, i.e. partial file names will not match. If no data source is specified, the files are assumed to be local to the database and must all be accessible to the gpudb user, residing on the path (or relative to the path) specified by the external files directory in the Kinetica configuration file. Wildcards (\*) can be used to specify a group of files. Prefix matching is supported, the prefixes must be aligned with directories. 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 (|).
modify\_columns Object Not implemented yet. The default value is an empty object ( {"{"}{"}"} ).
create\_table\_options Object Options from GPUdb#create\_table, allowing the structure of the table to be defined independently of the data source.
  • 'type\_id': ID of a currently registered type.
  • '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 name but a different type exists, it is still an error. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'is\_replicated': Affects the distribution scheme for the table's data. If true and the given table 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'foreign\_keys': Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  • 'foreign\_shard\_key': Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  • 'partition\_type': Partitioning scheme to use. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in table\_name.
  • 'chunk\_size': Indicates the number of records per chunk to be used for this table.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for this table.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a chunk to be used for this table.
  • 'is\_result\_table': Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for this table's columns.
The default value is an empty object ( {"{"}{"}"} ).
options Object Optional parameters.
  • 'bad\_record\_table\_name': Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string). When error\_handling is abort, bad records table is not populated.
  • 'bad\_record\_table\_limit': A positive integer indicating the maximum number of records that can be written to the bad-record-table. The default value is '10000'.
  • 'bad\_record\_table\_limit\_per\_input': For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be bad\_record\_table\_limit and total size of the table per rank is limited to bad\_record\_table\_limit.
  • 'batch\_size': Number of records to insert per batch when inserting data. The default value is '50000'.
  • '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, and 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': Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns\_to\_skip.
  • 'columns\_to\_skip': Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns\_to\_load.
  • 'compression\_type': Source data compression type. Supported values:
    • 'none': No compression.
    • 'auto': Auto detect compression type.
    • 'gzip': gzip file compression.
    • 'bzip2': bzip2 file compression.
    The default value is 'auto'.
  • 'datasource\_name': Name of an existing external data source from which data file(s) specified in filepaths will be loaded.
  • 'default\_column\_formats': Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and 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".
  • 'datalake\_catalog': Name of an existing datalake(iceberg) catalog used in loading files.
  • 'datalake\_path': Path of datalake(iceberg) object.
  • 'datalake\_snapshot': Snapshot ID of datalake(iceberg) object.
  • '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. Primary key collisions are considered abortable errors in this mode.
    The default value is 'abort'.
  • 'external\_table\_type': Specifies whether the external table holds a local copy of the external data. Supported values:
    • 'materialized': Loads a copy of the external data into the database, refreshed on demand.
    • 'logical': External data will not be loaded into the database; the data will be retrieved from the source upon servicing each query against the external table.
    The default value is 'materialized'.
  • 'file\_type': Specifies the type of the file(s) whose records will be inserted. Supported values:
    • 'avro': Avro file format.
    • 'delimited\_text': Delimited text file format; e.g., CSV, TSV, PSV, etc.
    • 'gdb': Esri/GDB file format.
    • 'json': JSON file format.
    • 'parquet': Apache Parquet file format.
    • 'shapefile': ShapeFile file format.
    The default value is 'delimited\_text'.
  • 'flatten\_columns': Specifies how to handle nested columns. Supported values:
    • 'true': Break up nested columns to multiple columns.
    • 'false': Treat nested columns as JSON columns instead of flattening.
    The default value is 'false'.
  • 'gdal\_configuration\_options': Comma separated list of gdal conf options, for the specific requests: key=value.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update\_on\_existing\_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error\_handling. If the specified table does not have a primary key or if upsert mode is in effect (update\_on\_existing\_pk is true), then this option has no effect. Supported values:
    • 'true': Ignore new records whose primary key values collide with those of existing records.
    • 'false': Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is 'false'.
  • 'ingestion\_mode': Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • 'full': Run a type inference on the source data (if needed) and ingest.
    • 'dry\_run': Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error\_handling.
    • 'type\_inference\_only': Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is 'full'.
  • 'jdbc\_fetch\_size': The JDBC fetch size, which determines how many rows to fetch per round trip. The default value is '50000'.
  • 'kafka\_consumers\_per\_rank': Number of Kafka consumer threads per rank (valid range 1-6). The default value is '1'.
  • 'kafka\_group\_id': The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).
  • 'kafka\_offset\_reset\_policy': Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset. Supported values:
    • 'earliest'
    • 'latest'
    The default value is 'earliest'.
  • 'kafka\_optimistic\_ingest': Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'kafka\_subscription\_cancel\_after': Sets the Kafka subscription lifespan (in minutes). Expired subscription will be cancelled automatically.
  • 'kafka\_type\_inference\_fetch\_timeout': Maximum time to collect Kafka messages before type inferencing on the set of them.
  • 'layer': Geo files layer(s) name(s): comma separated.
  • 'loading\_mode': Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
    • 'head': The head node loads all data. All files must be available to the head node.
    • 'distributed\_shared': The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
    • 'distributed\_local': A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
    The default value is 'head'.
  • 'local\_time\_offset': Apply an offset to Avro local timestamp columns.
  • 'max\_records\_to\_load': Limit the number of records to load in this request: if this number is larger than batch\_size, then the number of records loaded will be limited to the next whole number of batch\_size (per working thread).
  • 'name\_columns\_from\_file': Specifies a comma-delimited list of column names to be used as the source-data column names. If the file has a header row (i.e., text\_has\_header is true), these names override the file's header names. If the file has no header row, these names are used as the source-data column names. Either way, the i-th name in this list applies to the i-th column in the file, enabling name-based matching against the target table's columns (and use with columns\_to\_load / columns\_to\_skip).
  • 'num\_tasks\_per\_rank': Number of tasks for reading file per rank. Default will be system configuration parameter, external\_file\_reader\_num\_tasks.
  • 'poll\_interval': If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is '0'.
  • 'primary\_keys': Comma separated list of column names to set as primary keys, when not specified in the type.
  • 'refresh\_method': Method by which the table can be refreshed from its source data. Supported values:
    • 'manual': Refresh only occurs when manually requested by invoking the refresh action of GPUdb#alter\_table on this table.
    • 'on\_start': Refresh table on database startup and when manually requested by invoking the refresh action of GPUdb#alter\_table on this table.
    The default value is 'manual'.
  • 'schema\_registry\_connection\_retries': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_connection\_timeout': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_max\_consecutive\_connection\_failures': Max records to skip due to SR connection failures, before failing.
  • 'max\_consecutive\_invalid\_schema\_failure': Max records to skip due to schema related errors, before failing.
  • 'schema\_registry\_schema\_name': Name of the Avro schema in the schema registry to use when reading Avro records.
  • 'shard\_keys': Comma separated list of column names to set as shard keys, when not specified in the type.
  • 'skip\_lines': Skip a number of lines from the beginning of the file.
  • 'start\_offsets': Starting offsets by partition to fetch from kafka. A comma separated list of partition:offset pairs.
  • 'subscribe': Continuously poll the data source to check for new data and load it into the table. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'table\_insert\_mode': Insertion scheme to use when inserting records from multiple shapefiles. Supported values:
    • 'single': Insert all records into a single table.
    • 'table\_per\_file': Insert records from each file into a new table corresponding to that file.
    The default value is 'single'.
  • 'text\_comment\_string': Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited\_text file\_type only. The default value is '#'.
  • 'text\_delimiter': Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited\_text file\_type only. The default value is ','.
  • 'text\_escape\_character': Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, and vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited\_text file\_type only.
  • 'text\_has\_header': Indicates whether the source data contains a header row. For delimited\_textfile\_type only. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'text\_header\_property\_delimiter': Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text\_delimiter. For delimited\_text file\_type only. The default value is '|'.
  • 'text\_null\_string': Specifies the character string that should be interpreted as a null value in the source data. For delimited\_text file\_type only. The default value is '\N'.
  • 'text\_quote\_character': Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited\_text file\_type only. The default value is '"'.
  • 'text\_search\_columns': Add 'text\_search' property to internally inferenced string columns. Comma separated list of column names or '\*' for all columns. To add 'text\_search' property only to string columns greater than or equal to a minimum size, also set the text\_search\_min\_column\_length
  • 'text\_search\_min\_column\_length': Set the minimum column size for strings to apply the 'text\_search' property to. Used only when text\_search\_columns has a value.
  • 'transformations': Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column -- the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''.
  • 'trim\_space': If set to true, remove leading or trailing space from fields. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'truncate\_strings': If set to true, truncate string values that are longer than the column's type size. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'truncate\_table': If set to true, truncates the table specified by table\_name prior to loading the file(s). Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'type\_inference\_max\_records\_read'
  • 'type\_inference\_mode': Optimize type inferencing for either speed or accuracy. Supported values:
    • 'accuracy': Scans data to get exactly-typed and sized columns for all data scanned.
    • 'speed': Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned.
    The default value is 'speed'.
  • 'remote\_query': Remote SQL query from which data will be sourced.
  • 'remote\_query\_filter\_column': Name of column to be used for splitting remote\_query into multiple sub-queries using the data distribution of given column.
  • 'remote\_query\_increasing\_column': Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP).
  • 'remote\_query\_partition\_column': Alias name for remote\_query\_filter\_column.
  • 'enable\_inplace\_updates': Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • '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 (the new data will be 'upserted'). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore\_existing\_pk and error\_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Upsert new records when primary keys match existing records.
    • 'false': Reject new records when primary keys match existing records.
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_table\_external\_request(request, callback) → {"{"}Promise{"}"}

Creates a new external table, which is a local database object whose source data is located externally to the database. The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.

The external table can have its structure defined explicitly, via create\_table\_options, which contains many of the options from GPUdb#create\_table; or defined implicitly, inferred from the source data.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_table\_monitor(table\_name, options, callback) → {"{"}Promise{"}"}

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by table\_name) and forwards event notifications to subscribers via ZMQ. After this call completes, subscribe to the returned topic\_id 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 type\_schema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with GPUdb#clear\_table\_monitor.

For more information on table monitors, see Table Monitors.

Parameters:
Name Type Description
table\_name String Name of the table to monitor, in \[schema\_name.]table\_name format, using standard name resolution rules.
options Object 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.
    The default value is 'insert'.
  • 'monitor\_id': ID to use for this monitor instead of a randomly generated one.
  • 'datasink\_name': Name of an existing data sink to send change data notifications to.
  • 'max\_consecutive\_failures': Maximum number of consecutive failed notification attempts before suspending the stream. A value of -1 (default) disables auto-suspend. This value is by rank and not overall.
  • 'failed\_notifications\_table\_name': Name of a table to which failed stream notifications are written when the stream is suspended. The database will attempt to send notifications persisted in this table when the stream is resumed. The table has the following columns: rank (long), job\_id (long), uuid (uuid), timestamp (timestamp), error\_msg (string), payload (bytes). Leave this option empty to disable persisting failed notification events.
  • 'destination': Destination for the output data in format 'destination\_type://path\[:port]'. Supported destination types are 'http', 'https' and 'kafka'.
  • 'kafka\_topic\_name': Name of the Kafka topic to publish to if destination in options is specified and is a Kafka broker.
  • 'increasing\_column': Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
  • 'expression': Filter expression to limit records for notification.
  • 'join\_table\_names': A comma-separated list of tables (optionally with aliases) to include in the join. The monitored table table\_name must be included, representing only the newly inserted rows (deltas) since the last notification. Other tables can be any existing tables or views. Aliases can be used with the 'table\_name as alias' syntax.
  • 'join\_column\_names': A comma-separated list of columns or expressions to include from the joined tables. Column references can use table names or aliases defined in 'join\_table\_names'. Each column can optionally be aliased using 'as'. The selected columns will also appear in the notification output.
  • 'join\_expressions': Filter or join expressions to apply when combining the tables. Expressions are standard SQL-style conditions and can reference any table or alias listed in 'join\_table\_names'. This corresponds to the WHERE clause of the underlying join, and can include conditions to filter the delta rows.
  • 'refresh\_method': Method controlling when the table monitor reports changes to the table\_name. Supported values:
    • 'on\_change': Report changes as they occur.
    • 'periodic': Report changes periodically at rate specified by refresh\_period.
    The default value is 'on\_change'.
  • 'refresh\_period': When refresh\_method is periodic, specifies the period in seconds at which changes are reported.
  • 'refresh\_start\_time': When refresh\_method is periodic, specifies the first time at which changes are reported. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_table\_monitor\_request(request, callback) → {"{"}Promise{"}"}

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by table\_name) and forwards event notifications to subscribers via ZMQ. After this call completes, subscribe to the returned topic\_id 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 type\_schema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with GPUdb#clear\_table\_monitor.

For more information on table monitors, see Table Monitors.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_table\_request(request, callback) → {"{"}Promise{"}"}

Creates a new table with the given type (definition of columns). The type is specified in type\_id as either a numerical type ID (as returned by GPUdb#create\_type) or as a list of columns, each specified as a list of the column name, data type, and any column attributes.

Example of a type definition with some parameters: 

    \[
        \["id", "int8", "primary\_key"],
        \["dept\_id", "int8", "primary\_key", "shard\_key"],
        \["manager\_id", "int8", "nullable"],
        \["first\_name", "char32"],
        \["last\_name", "char64"],
        \["salary", "decimal"],
        \["hire\_date", "date"]
    ]
Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the properties map values from GPUdb#create\_type), and any data handling, data key, or data replacement properties.

A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_trigger\_by\_area(request\_id, table\_names, x\_column\_name, x\_vector, y\_column\_name, y\_vector, options, callback) → {"{"}Promise{"}"}

Sets up an area trigger mechanism for two column\_names for one or more tables. (This function is essentially the two-dimensional version of GPUdb#create\_trigger\_by\_range.) Once the trigger has been activated, any record added to the listed tables(s) via GPUdb#insert\_records 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 GPUdb#show\_system\_status) for any listening client to collect. Active triggers can be cancelled by using the GPUdb#clear\_trigger endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters:
Name Type Description
request\_id String User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
table\_names Array.\ Names of the tables on which the trigger will be activated and maintained, each in \[schema\_name.]table\_name format, using standard name resolution rules.
x\_column\_name String Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
x\_vector Array.\ The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
y\_column\_name String Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
y\_vector Array.\ 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 Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_trigger\_by\_area\_request(request, callback) → {"{"}Promise{"}"}

Sets up an area trigger mechanism for two column\_names for one or more tables. (This function is essentially the two-dimensional version of GPUdb#create\_trigger\_by\_range.) Once the trigger has been activated, any record added to the listed tables(s) via GPUdb#insert\_records 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 GPUdb#show\_system\_status) for any listening client to collect. Active triggers can be cancelled by using the GPUdb#clear\_trigger endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_trigger\_by\_range(request\_id, table\_names, column\_name, min, max, options, callback) → {"{"}Promise{"}"}

Sets up a simple range trigger for a column\_name for one or more tables. Once the trigger has been activated, any record added to the listed tables(s) via GPUdb#insert\_records 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 GPUdb#show\_system\_status) for any listening client to collect. Active triggers can be cancelled by using the GPUdb#clear\_trigger endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters:
Name Type Description
request\_id String User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
table\_names Array.\ Tables on which the trigger will be active, each in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name String Name of a numeric column\_name on which the trigger is activated.
min Number The lower bound (inclusive) for the trigger range.
max Number The upper bound (inclusive) for the trigger range.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_trigger\_by\_range\_request(request, callback) → {"{"}Promise{"}"}

Sets up a simple range trigger for a column\_name for one or more tables. Once the trigger has been activated, any record added to the listed tables(s) via GPUdb#insert\_records 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 GPUdb#show\_system\_status) for any listening client to collect. Active triggers can be cancelled by using the GPUdb#clear\_trigger endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_type(type\_definition, label, properties, options, callback) → {"{"}Promise{"}"}

Creates a new type describing the columns of a table. The type definition is specified as a list of columns, each specified as a list of the column name, data type, and any column attributes.

Example of a type definition with some parameters: 

    \[
        \["id", "int8", "primary\_key"],
        \["dept\_id", "int8", "primary\_key", "shard\_key"],
        \["manager\_id", "int8", "nullable"],
        \["first\_name", "char32"],
        \["last\_name", "char64"],
        \["salary", "decimal"],
        \["hire\_date", "date"]
    ]
Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the possible values for properties), and any data handling, data key, or data replacement properties.

Note that some properties are mutually exclusive--i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are primary\_key and nullable.

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 column value (or set of values for the key columns, if using a composite 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.

Parameters:
Name Type Description
type\_definition String JSON string defining the columns of the type to be registered, as described above.
label String A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
properties Object \[DEPRECATED--please use these property values in the type\_definition directly, as described at the top, instead] 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 select 'string' columns. Enables full text search--see Full Text Search for details and applicable string column types.
  • '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.
  • 'uuid': Valid only for 'string' columns. It represents an uuid data type. Internally, it is stored as a 128-bit integer.
  • '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.
  • 'boolean': This property provides optimized memory and query performance for int columns. Ints with this property must be between 0 and 1(inclusive)
  • '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.
  • 'array': Valid only for 'string' columns. Indicates that this field contains an array. The value type and (optionally) the item count should be specified in parenthesis; e.g., 'array(int, 10)' for a 10-integer array. Both 'array(int)' and 'array(int, -1)' will designate an unlimited-length integer array, though no bounds checking is performed on arrays of any length.
  • 'json': Valid only for 'string' columns. Indicates that this field contains values in JSON format.
  • 'vector': Valid only for 'bytes' columns. Indicates that this field contains a vector of floats. The length should be specified in parenthesis, e.g., 'vector(1000)'.
  • '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.
  • 'soft\_primary\_key': This property indicates that this column will be part of (or the entire) soft 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 type\_definition. 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.
  • 'compress': This property indicates that this column should be compressed with the given codec and optional level; e.g., 'compress(snappy)' for Snappy compression and 'compress(zstd(7))' for zstd level 7 compression. This property is primarily used in order to save disk space.
  • '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.
  • 'init\_with\_uuid': For 'uuid' type, replace empty strings and invalid UUID values with randomly-generated UUIDs upon insert.
  • 'update\_with\_now': For 'date', 'time', 'datetime', or 'timestamp' column types, update the field with 'NOW()' upon any update.
  • 'update\_with\_user': For 'charN' or 'string' column types, update the field with the current user's name upon any update.
  • 'default': Sets a default value expression for this column, e.g. 'default(0)', 'default(''pending'')', or 'default(NOW())'. When the column is omitted from an insert via request\_schema\_str, the expression is evaluated and the result is used as the column value.
  • 'default\_sql': Sets a default value expression for this column with SQL syntax, e.g. 'default(0)', 'default(''pending'')', or 'default(NOW())'. Only used for showing the expression when generating SQL DDL.
The default value is an empty object ( {"{"}{"}"} ).
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_type\_request(request, callback) → {"{"}Promise{"}"}

Creates a new type describing the columns of a table. The type definition is specified as a list of columns, each specified as a list of the column name, data type, and any column attributes.

Example of a type definition with some parameters: 

    \[
        \["id", "int8", "primary\_key"],
        \["dept\_id", "int8", "primary\_key", "shard\_key"],
        \["manager\_id", "int8", "nullable"],
        \["first\_name", "char32"],
        \["last\_name", "char64"],
        \["salary", "decimal"],
        \["hire\_date", "date"]
    ]
Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the possible values for properties), and any data handling, data key, or data replacement properties.

Note that some properties are mutually exclusive--i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are primary\_key and nullable.

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 column value (or set of values for the key columns, if using a composite 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.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_union(table\_name, table\_names, input\_column\_names, output\_column\_names, options, callback) → {"{"}Promise{"}"}

Merges data from one or more tables with comparable data types into a new table.

The following merges are supported:

UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.

INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.

EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.

Parameters:
Name Type Description
table\_name String Name of the table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.
table\_names Array.\ The list of table names to merge, in \[schema\_name.]table\_name format, using standard name resolution rules. Must contain the names of one or more existing tables.
input\_column\_names Array.\> The list of columns from each of the corresponding input tables.
output\_column\_names Array.\ The list of names of the columns to be stored in the output table.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of table\_name. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_table\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the projection as part of table\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of the schema for the output table. If the schema provided is non-existent, it will be automatically created. The default value is ''.
  • 'mode': The mode describes what rows of the tables being unioned will be retained. 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).
    The default value is 'union\_all'.
  • 'chunk\_size': Indicates the number of records per chunk to be used for this output table.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for this output table.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a 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 output\_column\_names.
  • 'partition\_type': Partitioning scheme to use for the output table. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the output table specified in table\_name.
  • 'persist': If true, then the output table specified in table\_name 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:
    • 'true'
    • 'false'
    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 table\_name will be replicated even if the source tables are not. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for this table's columns.
  • 'no\_count': Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual unions. The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_union\_request(request, callback) → {"{"}Promise{"}"}

Merges data from one or more tables with comparable data types into a new table.

The following merges are supported:

UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.

INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.

EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_user\_external(name, options, callback) → {"{"}Promise{"}"}

Creates a new external user (a user whose credentials are managed by an external LDAP).

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
name String 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 Object Optional parameters.
  • 'activated': Is the user allowed to login. Supported values:
    • 'true': User may login.
    • 'false': User may not login.
    The default value is 'true'.
  • 'create\_home\_directory': When true, a home directory in KiFS is created for this user. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'default\_schema': Default schema to associate with this user.
  • 'directory\_data\_limit': The maximum capacity to apply to the created directory if create\_home\_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
  • 'resource\_group': Name of an existing resource group to associate with this user.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_user\_external\_request(request, callback) → {"{"}Promise{"}"}

Creates a new external user (a user whose credentials are managed by an external LDAP).

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_user\_internal(name, password, options, callback) → {"{"}Promise{"}"}

Creates a new internal user (a user whose credentials are managed by the database system).
Parameters:
Name Type Description
name String 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 String Initial password of the user to be created. May be an empty string for no password.
options Object Optional parameters.
  • 'activated': Is the user allowed to login. Supported values:
    • 'true': User may login.
    • 'false': User may not login.
    The default value is 'true'.
  • 'create\_home\_directory': When true, a home directory in KiFS is created for this user. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'default\_schema': Default schema to associate with this user.
  • 'directory\_data\_limit': The maximum capacity to apply to the created directory if create\_home\_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
  • 'resource\_group': Name of an existing resource group to associate with this user.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_user\_internal\_request(request, callback) → {"{"}Promise{"}"}

Creates a new internal user (a user whose credentials are managed by the database system).
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_video(attribute, begin, duration\_seconds, end, frames\_per\_second, style, path, style\_parameters, options, callback) → {"{"}Promise{"}"}

Creates a job to generate a sequence of raster images that visualize data over a specified time.
Parameters:
Name Type Description
attribute String The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.
begin String The start point for the video. Accepts an expression evaluable over the attribute.
duration\_seconds Number Seconds of video to produce.
end String The end point for the video. Accepts an expression evaluable over the attribute.
frames\_per\_second Number The presentation frame rate of the encoded video in frames per second.
style String The name of the visualize mode; should correspond to the schema used for the style\_parameters field. Supported values:
  • 'chart'
  • 'raster'
  • 'classbreak'
  • 'contour'
  • 'heatmap'
  • 'labels'
path String Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace\_if\_exists is true.
style\_parameters String A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
options Object Optional parameters.
  • 'ttl': Sets the TTL of the video.
  • 'window': Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval \[t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
  • 'no\_error\_if\_exists': If true, does not return an error if the video already exists. Ignored if replace\_if\_exists is true. Supported values:
    • 'false'
    • 'true'
    The default value is 'false'.
  • 'replace\_if\_exists': If true, deletes any existing video with the same path before creating a new video. Supported values:
    • 'false'
    • 'true'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

create\_video\_request(request, callback) → {"{"}Promise{"}"}

Creates a job to generate a sequence of raster images that visualize data over a specified time.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

decode(o) → {"{"}Object|Array.\{"}"}
Decodes a JSON string, or array of JSON strings, returned from GPUdb into JSON object(s).
Parameters:
Name Type Description
o String | Array.\ The JSON string(s) to decode.
Source:
  • ,
Returns:
The decoded JSON object(s).
Type
Object | Array.\

delete\_directory(directory\_name, options, callback) → {"{"}Promise{"}"}

Deletes a directory from KiFS.
Parameters:
Name Type Description
directory\_name String Name of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true.
options Object Optional parameters.
  • 'recursive': If true, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'no\_error\_if\_not\_exists': If true, no error is returned if specified directory does not exist. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_directory\_request(request, callback) → {"{"}Promise{"}"}

Deletes a directory from KiFS.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_files(file\_names, options, callback) → {"{"}Promise{"}"}

Deletes one or more files from KiFS.
Parameters:
Name Type Description
file\_names Array.\ An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimiter. Accepted wildcard characters are asterisk (\*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If true, no error is returned if a specified file does not exist. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_files\_request(request, callback) → {"{"}Promise{"}"}

Deletes one or more files from KiFS.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_graph(graph\_name, options, callback) → {"{"}Promise{"}"}

Deletes an existing graph from the graph server and/or persist.
Parameters:
Name Type Description
graph\_name String Name of the graph to be deleted.
options Object 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:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'server\_id': Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_graph\_request(request, callback) → {"{"}Promise{"}"}

Deletes an existing graph from the graph server and/or persist.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_proc(proc\_name, options, callback) → {"{"}Promise{"}"}

Deletes a proc. Any currently running instances of the proc will be killed.
Parameters:
Name Type Description
proc\_name String Name of the proc to be deleted. Must be the name of a currently existing proc.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_proc\_request(request, callback) → {"{"}Promise{"}"}

Deletes a proc. Any currently running instances of the proc will be killed.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_records(table\_name, expressions, options, callback) → {"{"}Promise{"}"}

Deletes record(s) matching the provided criteria from the given table. The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record\_id options, or all records when using delete\_all\_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
Parameters:
Name Type Description
table\_name String Name of the table from which to delete records, in \[schema\_name.]table\_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views.
expressions Array.\ 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 Object 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 GPUdb#get\_records\_from\_collection with the \*return\_record\_ids\* option. This option cannot be used to delete records from replicated tables.
  • 'delete\_all\_records': If set to true, all records in the table will be deleted. If set to false, then the option is effectively ignored. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_records\_request(request, callback) → {"{"}Promise{"}"}

Deletes record(s) matching the provided criteria from the given table. The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record\_id options, or all records when using delete\_all\_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_resource\_group(name, options, callback) → {"{"}Promise{"}"}

Deletes a resource group.
Parameters:
Name Type Description
name String Name of the resource group to be deleted.
options Object Optional parameters.
  • 'cascade\_delete': If true, delete any existing entities owned by this group. Otherwise this request will return an error of any such entities exist. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_resource\_group\_request(request, callback) → {"{"}Promise{"}"}

Deletes a resource group.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_role(name, options, callback) → {"{"}Promise{"}"}

Deletes an existing role.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
name String Name of the role to be deleted. Must be an existing role.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_role\_request(request, callback) → {"{"}Promise{"}"}

Deletes an existing role.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_user(name, options, callback) → {"{"}Promise{"}"}

Deletes an existing user.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
name String Name of the user to be deleted. Must be an existing user.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

delete\_user\_request(request, callback) → {"{"}Promise{"}"}

Deletes an existing user.

Note: This method should be used for on-premise deployments only.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

download\_files(file\_names, read\_offsets, read\_lengths, options, callback) → {"{"}Promise{"}"}

Downloads one or more files from KiFS.
Parameters:
Name Type Description
file\_names Array.\ An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimiter. Accepted wildcard characters are asterisk (\*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
read\_offsets Array.\ An array of starting byte offsets from which to read each respective file in file\_names. Must either be empty or the same length as file\_names. If empty, files are downloaded in their entirety. If not empty, read\_lengths must also not be empty.
read\_lengths Array.\ Array of number of bytes to read from each respective file in file\_names. Must either be empty or the same length as file\_names. If empty, files are downloaded in their entirety. If not empty, read\_offsets must also not be empty.
options Object Optional parameters.
  • 'file\_encoding': Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
    • 'base64': Apply base64 encoding to the output file data.
    • 'none': Do not apply any encoding to the output file data.
    The default value is 'none'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

download\_files\_request(request, callback) → {"{"}Promise{"}"}

Downloads one or more files from KiFS.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_backup(backup\_name, datasink\_name, options, callback) → {"{"}Promise{"}"}

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasink\_name.
Parameters:
Name Type Description
backup\_name String Name of the backup to be deleted. An empty string or '\*' will delete all existing backups. Any text followed by a '\*' will delete backups whose name starts with that text. When deleting multiple backups, delete\_all\_backups must be set to true.
datasink\_name String Data sink through which the backup is accessible.
options Object Optional parameters.
  • 'dry\_run': Whether or not to perform a dry run of a backup deletion. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'delete\_all\_backups': Allow multiple backups to be deleted if true and multiple backup names are found matching backup\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'no\_error\_if\_not\_exists': Whether or not to suppress the error if the specified backup does not exist. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_backup\_request(request, callback) → {"{"}Promise{"}"}

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasink\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_catalog(name, options, callback) → {"{"}Promise{"}"}

Drops an existing catalog. Any external tables that depend on the catalog must be dropped before it can be dropped.
Parameters:
Name Type Description
name String Name of the catalog to be dropped. Must be an existing catalog.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_catalog\_request(request, callback) → {"{"}Promise{"}"}

Drops an existing catalog. Any external tables that depend on the catalog must be dropped before it can be dropped.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_credential(credential\_name, options, callback) → {"{"}Promise{"}"}

Drop an existing credential.
Parameters:
Name Type Description
credential\_name String Name of the credential to be dropped. Must be an existing credential.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_credential\_request(request, callback) → {"{"}Promise{"}"}

Drop an existing credential.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_datasink(name, options, callback) → {"{"}Promise{"}"}

Drops an existing data sink.

By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear\_table\_monitors is true.

Parameters:
Name Type Description
name String Name of the data sink to be dropped. Must be an existing data sink.
options Object Optional parameters.
  • 'clear\_table\_monitors': If true, any table monitors that use this data sink will be cleared. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_datasink\_request(request, callback) → {"{"}Promise{"}"}

Drops an existing data sink.

By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear\_table\_monitors is true.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_datasource(name, options, callback) → {"{"}Promise{"}"}

Drops an existing data source. Any external tables that depend on the data source must be dropped before it can be dropped.
Parameters:
Name Type Description
name String Name of the data source to be dropped. Must be an existing data source.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_datasource\_request(request, callback) → {"{"}Promise{"}"}

Drops an existing data source. Any external tables that depend on the data source must be dropped before it can be dropped.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_environment(environment\_name, options, callback) → {"{"}Promise{"}"}

Drop an existing user-defined function (UDF) environment.
Parameters:
Name Type Description
environment\_name String Name of the environment to be dropped. Must be an existing environment.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If true and if the environment specified in environment\_name does not exist, no error is returned. If false and if the environment specified in environment\_name does not exist, then an error is returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_environment\_request(request, callback) → {"{"}Promise{"}"}

Drop an existing user-defined function (UDF) environment.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_schema(schema\_name, options, callback) → {"{"}Promise{"}"}

Drops an existing SQL-style schema, specified in schema\_name.
Parameters:
Name Type Description
schema\_name String Name of the schema to be dropped. Must be an existing schema.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If true and if the schema specified in schema\_name does not exist, no error is returned. If false and if the schema specified in schema\_name does not exist, then an error is returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'cascade': If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

drop\_schema\_request(request, callback) → {"{"}Promise{"}"}

Drops an existing SQL-style schema, specified in schema\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

execute\_proc(proc\_name, params, bin\_params, input\_table\_names, input\_column\_names, output\_table\_names, options, callback) → {"{"}Promise{"}"}

Executes a proc. This endpoint is asynchronous and does not wait for the proc to complete before returning.

If the proc being executed is distributed, input\_table\_names and input\_column\_names may be passed to the proc to use for reading data, and output\_table\_names may be passed to the proc to use for writing data.

If the proc being executed is non-distributed, these table parameters will be ignored.

Parameters:
Name Type Description
proc\_name String Name of the proc to execute. Must be the name of a currently existing proc.
params Object 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 object ( {"{"}{"}"} ).
bin\_params Object 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 object ( {"{"}{"}"} ).
input\_table\_names Array.\ Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table, in \[schema\_name.]table\_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty array ( \[] ).
input\_column\_names Object Map of table names from input\_table\_names 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 input\_table\_names is not included, all columns from that table will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty object ( {"{"}{"}"} ).
output\_table\_names Array.\ Names of the tables to which output data from the proc will be written, each in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from input\_table\_names, 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. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty array ( \[] ).
options Object Optional parameters.
  • 'cache\_input': No longer supported; option will be ignored. The default value is ''.
  • 'use\_cached\_input': No longer supported; option will be ignored. The default value is ''.
  • 'run\_tag': A string that, if not empty, can be used in subsequent calls to GPUdb#show\_proc\_status or GPUdb#kill\_proc to identify the proc instance. The default value is ''.
  • 'max\_output\_lines': The maximum number of lines of output from stdout and stderr to return via GPUdb#show\_proc\_status. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is '100'.
  • 'execute\_at\_startup': If true, an instance of the proc will run when the database is started instead of running immediately. The run\_id can be retrieved using GPUdb#show\_proc and used in GPUdb#show\_proc\_status. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'execute\_at\_startup\_as': Sets the alternate user name to execute this proc instance as when execute\_at\_startup is true. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

execute\_proc\_request(request, callback) → {"{"}Promise{"}"}

Executes a proc. This endpoint is asynchronous and does not wait for the proc to complete before returning.

If the proc being executed is distributed, input\_table\_names and input\_column\_names may be passed to the proc to use for reading data, and output\_table\_names may be passed to the proc to use for writing data.

If the proc being executed is non-distributed, these table parameters will be ignored.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

execute\_sql(statement, offset, limit, request\_schema\_str, data, options, callback) → {"{"}Promise{"}"}

Execute a SQL statement (query, DML, or DDL).

See SQL Support for the complete set of supported SQL commands.

When a caller wants all the results from a large query (e.g., more than max\_get\_records\_size records), they can make multiple calls to this endpoint using the offset and limit parameters to page through the results. Normally, this will execute the statement query each time. To avoid re-executing the query each time and to keep the results in the same order, the caller should specify a paging\_table name to hold the results of the query between calls and specify the paging\_table on subsequent calls. When this is done, the caller should clear the paging table and any other tables in the result\_table\_list (both returned in the response) when they are done paging through the results. paging\_table (and result\_table\_list) will be empty if no paging table was created (e.g., when all the query results were returned in the first call).

Parameters:
Name Type Description
statement String SQL statement (query, DML, or DDL) to be executed.
offset Number 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 Number 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 has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
request\_schema\_str String Avro schema of data. The default value is ''.
data Array.\ An array of binary-encoded data for the records to be binded to the SQL query. Or use query\_parameters to pass the data in JSON format. The default value is an empty array ( \[] ).
options Object Optional parameters.
  • 'cost\_based\_optimization': If false, disables the cost-based optimization of the given query. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • '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:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for inserting into or updating a table with a primary key, only used when primary key record collisions are rejected (update\_on\_existing\_pk is false). If set to true, any record insert/update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any insert/update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update\_on\_existing\_pk is true, then this option has no effect. Supported values:
    • 'true': Ignore inserts/updates that result in primary key collisions with existing records.
    • 'false': Treat as errors any inserts/updates that result in primary key collisions with existing records.
    The default value is 'false'.
  • 'late\_materialization': If true, Joins/Filters results will always be materialized ( saved to result tables format). Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'paging\_table': When specified (or paging\_table\_ttl is set), the system will create a paging table to hold the results of the query, when the output has more records than are in the response (i.e., when has\_more\_records is true). If the specified paging table exists, the records from the paging table are returned without re-evaluating the query. It is the caller's responsibility to clear the paging\_table and other tables in the result\_table\_list (both returned in the response) when they are done with this query.
  • 'paging\_table\_ttl': Sets the TTL of the paging table. -1 indicates no timeout. Setting this option will cause a paging table to be generated when needed. The paging\_table and other tables in the result\_table\_list (both returned in the response) will be automatically cleared after the TTL expires, if set to a positive number. However, it is still recommended that the caller clear these tables when they are done with this query.
  • 'parallel\_execution': If false, disables the parallel step execution of the given query. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'plan\_cache': If false, disables plan caching for the given query. Supported values:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'preserve\_dict\_encoding': If true, then columns that were dict encoded in the source table will be dict encoded in the projection table. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'query\_parameters': Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and request\_schema\_str.
  • 'results\_caching': If false, disables caching of the results of the given query. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'rule\_based\_optimization': If false, disables rule-based rewrite optimizations for the given query. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'ssq\_optimization': If false, scalar subqueries will be translated into joins. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'ttl': Sets the TTL of the intermediate result tables used in query execution.
  • 'update\_on\_existing\_pk': Specifies the record collision policy for inserting into or updating 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 or updated will be replaced by that record. If set to false, any such primary key collision will result in the insert/update being rejected and the error handled as determined by ignore\_existing\_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Replace the collided-into record with the record inserted or updated when a new/modified record causes a primary key collision with an existing record.
    • 'false': Reject the insert or update when it results in a primary key collision with an existing record.
    The default value is 'false'.
  • '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:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'current\_schema': Use the supplied value as the default schema when processing this SQL command.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

execute\_sql\_request(request, callback) → {"{"}Promise{"}"}

Execute a SQL statement (query, DML, or DDL).

See SQL Support for the complete set of supported SQL commands.

When a caller wants all the results from a large query (e.g., more than max\_get\_records\_size records), they can make multiple calls to this endpoint using the offset and limit parameters to page through the results. Normally, this will execute the statement query each time. To avoid re-executing the query each time and to keep the results in the same order, the caller should specify a paging\_table name to hold the results of the query between calls and specify the paging\_table on subsequent calls. When this is done, the caller should clear the paging table and any other tables in the result\_table\_list (both returned in the response) when they are done paging through the results. paging\_table (and result\_table\_list) will be empty if no paging table was created (e.g., when all the query results were returned in the first call).

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

export\_query\_metrics(options, callback) → {"{"}Promise{"}"}

Export query metrics to a given destination. Returns query metrics.
Parameters:
Name Type Description
options Object Optional parameters.
  • 'expression': Filter for multi query export.
  • 'filepath': Path to export target specified as a filename or existing directory.
  • 'format': Specifies which format to export the metrics. Supported values:
    • 'json': Generic JSON output.
    • 'json\_trace\_event': Chromium/Perfetto trace event format.
    The default value is 'json'.
  • 'job\_id': Export query metrics for the currently running job.
  • 'limit': Record limit per file for multi query export.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

export\_query\_metrics\_request(request, callback) → {"{"}Promise{"}"}

Export query metrics to a given destination. Returns query metrics.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

export\_records\_to\_files(table\_name, filepath, options, callback) → {"{"}Promise{"}"}

Export records from a table to files. All tables can be exported, in full or partial (see columns\_to\_export and columns\_to\_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink\_name; see GPUdb#create\_datasink.

Server's local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.

All filenames created are returned in the response.

Parameters:
Name Type Description
table\_name String The name of the table whose records are to be exported.
filepath String Path to data export target. If filepath has a file extension, it is read as the name of a file. If filepath is a directory, then the source table name with a random UUID appended will be used as the name of each exported file, all written to that directory. If filepath is a filename, then all exported files will have a random UUID appended to the given name. In either case, the target directory specified or implied must exist. The names of all exported files are returned in the response.
options Object Optional parameters.
  • 'batch\_size': Number of records to be exported as a batch. The default value is '1000000'.
  • 'column\_formats': For each source column specified, applies the column-property-bound format. Currently supported column properties include date, time, and 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\_export': Specifies a comma-delimited list of columns from the source table to export, written to the output file in the order they are given. Column names can be provided, in which case the target file will use those names as the column headers as well. Alternatively, column numbers can be specified--discretely or as a range. For example, a value of '5,7,1..3' will write values from the fifth column in the source table into the first column in the target file, from the seventh column in the source table into the second column in the target file, and from the first through third columns in the source table into the third through fifth columns in the target file. Mutually exclusive with columns\_to\_skip.
  • 'columns\_to\_skip': Comma-separated list of column names or column numbers to not export. All columns in the source table not specified will be written to the target file in the order they appear in the table definition. Mutually exclusive with columns\_to\_export.
  • 'datasink\_name': Datasink name, created using GPUdb#create\_datasink.
  • 'default\_column\_formats': Specifies the default format to use to write data. Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and format for a given source column in column\_formats. For each specified annotation, the format will apply to all columns with that annotation unless custom column\_formats for that annotation are 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 write text as "05/04/2000 12:12:11"
  • 'export\_ddl': Save DDL to a separate file. The default value is 'false'.
  • 'file\_extension': Extension to give the export file. The default value is '.csv'.
  • 'file\_type': Specifies the file format to use when exporting data. Supported values:
    • 'delimited\_text': Delimited text file format; e.g., CSV, TSV, PSV, etc.
    • 'parquet'
    The default value is 'delimited\_text'.
  • 'kinetica\_header': Whether to include a Kinetica proprietary header. Will not be written if text\_has\_header is false. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'kinetica\_header\_delimiter': If a Kinetica proprietary header is included, then specify a property separator. Different from column delimiter. The default value is '|'.
  • 'compression\_type': File compression type. GZip can be applied to text and Parquet files. Snappy can only be applied to Parquet files, and is the default compression for them. Supported values:
    • 'uncompressed'
    • 'snappy'
    • 'gzip'
  • 'single\_file': Save records to a single file. This option may be ignored if file size exceeds internal file size limits (this limit will differ on different targets). Supported values:
    • 'true'
    • 'false'
    • 'overwrite'
    The default value is 'true'.
  • 'single\_file\_max\_size': Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is ''.
  • 'text\_delimiter': Specifies the character to write out to delimit field values and field names in the header (if present). For delimited\_text file\_type only. The default value is ','.
  • 'text\_has\_header': Indicates whether to write out a header row. For delimited\_textfile\_type only. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'text\_null\_string': Specifies the character string that should be written out for the null value in the data. For delimited\_text file\_type only. The default value is '\N'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

export\_records\_to\_files\_request(request, callback) → {"{"}Promise{"}"}

Export records from a table to files. All tables can be exported, in full or partial (see columns\_to\_export and columns\_to\_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink\_name; see GPUdb#create\_datasink.

Server's local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.

All filenames created are returned in the response.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

export\_records\_to\_table(table\_name, remote\_query, options, callback) → {"{"}Promise{"}"}

Exports records from source table to the specified target table in an external database.
Parameters:
Name Type Description
table\_name String Name of the table from which the data will be exported to remote database, in \[schema\_name.]table\_name format, using standard name resolution rules.
remote\_query String Parameterized insert query to export gpudb table data into remote database. The default value is ''.
options Object Optional parameters.
  • 'batch\_size': Batch size, which determines how many rows to export per round trip. The default value is '200000'.
  • 'datasink\_name': Name of an existing external data sink to which table name specified in table\_name will be exported.
  • 'jdbc\_session\_init\_statement': Executes the statement per each JDBC session before doing actual load. The default value is ''.
  • 'jdbc\_connection\_init\_statement': Executes the statement once before doing actual load. The default value is ''.
  • 'remote\_table': Name of the target table to which source table is exported. When this option is specified remote\_query cannot be specified. The default value is ''.
  • 'use\_st\_geomfrom\_casts': Wraps parameterized variables with st\_geomfromtext or st\_geomfromwkb based on source column type. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'use\_indexed\_parameters': Uses \$n style syntax when generating insert query for remote\_table option. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

export\_records\_to\_table\_request(request, callback) → {"{"}Promise{"}"}

Exports records from source table to the specified target table in an external database.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter(table\_name, view\_name, expression, options, callback) → {"{"}Promise{"}"}

Filters data based on the specified expression. The results are stored in a result set with the given view\_name.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters:
Name Type Description
table\_name String Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
expression String The select expression to filter the specified table. For details see Expressions.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • 'view\_id': View this filtered-view is part of. The default value is ''.
  • 'ttl': Sets the TTL of the view specified in view\_name.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_area(table\_name, view\_name, x\_column\_name, x\_vector, y\_column\_name, y\_vector, options, callback) → {"{"}Promise{"}"}

Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view\_name passed in as part of the input.
Parameters:
Name Type Description
table\_name String Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
x\_column\_name String Name of the column containing the x values to be filtered.
x\_vector Array.\ List of x coordinates of the vertices of the polygon representing the area to be filtered.
y\_column\_name String Name of the column containing the y values to be filtered.
y\_vector Array.\ List of y coordinates of the vertices of the polygon representing the area to be filtered.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_area\_geometry(table\_name, view\_name, column\_name, x\_vector, y\_vector, options, callback) → {"{"}Promise{"}"}

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view\_name passed in as part of the input.
Parameters:
Name Type Description
table\_name String Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name String Name of the geospatial geometry column to be filtered.
x\_vector Array.\ List of x coordinates of the vertices of the polygon representing the area to be filtered.
y\_vector Array.\ List of y coordinates of the vertices of the polygon representing the area to be filtered.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_area\_geometry\_request(request, callback) → {"{"}Promise{"}"}

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view\_name passed in as part of the input.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_area\_request(request, callback) → {"{"}Promise{"}"}

Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view\_name passed in as part of the input.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_box(table\_name, view\_name, x\_column\_name, min\_x, max\_x, y\_column\_name, min\_y, max\_y, options, callback) → {"{"}Promise{"}"}

Calculates how many objects within the given table lie in a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view\_name is passed in as part of the input payload.
Parameters:
Name Type Description
table\_name String Name of the table on which the bounding box operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
x\_column\_name String Name of the column on which to perform the bounding box query. Must be a valid numeric column.
min\_x Number Lower bound for the column chosen by x\_column\_name. Must be less than or equal to max\_x.
max\_x Number Upper bound for x\_column\_name. Must be greater than or equal to min\_x.
y\_column\_name String Name of a column on which to perform the bounding box query. Must be a valid numeric column.
min\_y Number Lower bound for y\_column\_name. Must be less than or equal to max\_y.
max\_y Number Upper bound for y\_column\_name. Must be greater than or equal to min\_y.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_box\_geometry(table\_name, view\_name, column\_name, min\_x, max\_x, min\_y, max\_y, options, callback) → {"{"}Promise{"}"}

Calculates which geospatial geometry objects from a table intersect a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view\_name is passed in as part of the input payload.
Parameters:
Name Type Description
table\_name String Name of the table on which the bounding box operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name String Name of the geospatial geometry column to be filtered.
min\_x Number Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to max\_x.
max\_x Number Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min\_x.
min\_y Number Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to max\_y.
max\_y Number Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to min\_y.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_box\_geometry\_request(request, callback) → {"{"}Promise{"}"}

Calculates which geospatial geometry objects from a table intersect a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view\_name is passed in as part of the input payload.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_box\_request(request, callback) → {"{"}Promise{"}"}

Calculates how many objects within the given table lie in a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view\_name is passed in as part of the input payload.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_geometry(table\_name, view\_name, column\_name, input\_wkt, operation, options, callback) → {"{"}Promise{"}"}

Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by input\_wkt.
Parameters:
Name Type Description
table\_name String Name of the table on which the filter by geometry will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name String Name of the column to be used in the filter. Must be a geospatial geometry column.
input\_wkt String A geometry in WKT format that will be used to filter the objects in table\_name. The default value is ''.
operation String The geometric filtering operation to perform. Supported values:
  • 'contains': Matches records that contain the given WKT in input\_wkt, 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 Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_geometry\_request(request, callback) → {"{"}Promise{"}"}

Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by input\_wkt.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_list(table\_name, view\_name, column\_values\_map, options, callback) → {"{"}Promise{"}"}

Calculates which records from a table have values in the given list for the corresponding column. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a view\_name is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"{"}"x":\["10.1", "2.3"], "y":\["0.0", "-31.5", "42.0"]{"}"} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Parameters:
Name Type Description
table\_name String Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_values\_map Object List of values for the corresponding column in the table.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
  • 'filter\_mode': String indicating the filter mode, either 'in\_list' or 'not\_in\_list'. Supported values:
    • 'in\_list': The filter will match all items that are in the provided list(s).
    • 'not\_in\_list': The filter will match all items that are not in the provided list(s).
    The default value is 'in\_list'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_list\_request(request, callback) → {"{"}Promise{"}"}

Calculates which records from a table have values in the given list for the corresponding column. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a view\_name is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"{"}"x":\["10.1", "2.3"], "y":\["0.0", "-31.5", "42.0"]{"}"} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_radius(table\_name, view\_name, x\_column\_name, x\_center, y\_column\_name, y\_center, radius, options, callback) → {"{"}Promise{"}"}

Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view\_name is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Parameters:
Name Type Description
table\_name String Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
x\_column\_name String Name of the column to be used for the x-coordinate (the longitude) of the center.
x\_center Number 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.
y\_column\_name String Name of the column to be used for the y-coordinate-the latitude-of the center.
y\_center Number 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 Number 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 Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_radius\_geometry(table\_name, view\_name, column\_name, x\_center, y\_center, radius, options, callback) → {"{"}Promise{"}"}

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view\_name is passed in as part of the request.
Parameters:
Name Type Description
table\_name String Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name String Name of the geospatial geometry column to be filtered.
x\_center Number 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.
y\_center Number 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 Number 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 Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_radius\_geometry\_request(request, callback) → {"{"}Promise{"}"}

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view\_name is passed in as part of the request.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_radius\_request(request, callback) → {"{"}Promise{"}"}

Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view\_name is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_range(table\_name, view\_name, column\_name, lower\_bound, upper\_bound, options, callback) → {"{"}Promise{"}"}

Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by table\_name is added to the view view\_name if its column is within \[lower\_bound, upper\_bound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters:
Name Type Description
table\_name String Name of the table on which the filter by range operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name String Name of a column on which the operation would be applied.
lower\_bound Number Value of the lower bound (inclusive).
upper\_bound Number Value of the upper bound (inclusive).
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_range\_request(request, callback) → {"{"}Promise{"}"}

Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by table\_name is added to the view view\_name if its column is within \[lower\_bound, upper\_bound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_series(table\_name, view\_name, track\_id, target\_track\_ids, options, callback) → {"{"}Promise{"}"}

Filters objects matching all points of the given track (works only on track type data). It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Parameters:
Name Type Description
table\_name String Name of the table on which the filter by track operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table with a track present.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
track\_id String The ID of the track which will act as the filtering points. Must be an existing track within the given table.
target\_track\_ids Array.\ 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 Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • '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. The minimum allowed value is '0'.
  • '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. The minimum allowed value is '0'.
  • 'spatial\_distance\_metric': A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great\_circle'. Optional parameter; default is 'euclidean'. Supported values:
    • 'euclidean'
    • 'great\_circle'
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_series\_request(request, callback) → {"{"}Promise{"}"}

Filters objects matching all points of the given track (works only on track type data). It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_string(table\_name, view\_name, expression, mode, column\_names, options, callback) → {"{"}Promise{"}"}

Calculates which objects from a table or view match a string expression for the given string columns. Setting case\_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.
Parameters:
Name Type Description
table\_name String Name of the table on which the filter operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
expression String The expression with which to filter the table.
mode String 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 column\_names; 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.
column\_names Array.\ List of columns on which to apply the filter. Ignored for search mode.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • 'case\_sensitive': If false then string filtering will ignore case. Does not apply to search mode. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_string\_request(request, callback) → {"{"}Promise{"}"}

Calculates which objects from a table or view match a string expression for the given string columns. Setting case\_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_table(table\_name, view\_name, column\_name, source\_table\_name, source\_table\_column\_name, options, callback) → {"{"}Promise{"}"}

Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a view\_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
Parameters:
Name Type Description
table\_name String Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name String Name of the column by whose value the data will be filtered from the table designated by table\_name.
source\_table\_name String Name of the table whose data will be compared against in the table called table\_name, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
source\_table\_column\_name String Name of the column in the source\_table\_name whose values will be used as the filter for table table\_name. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the column\_name.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • 'filter\_mode': String indicating the filter mode, either in\_table or not\_in\_table. Supported values:
    • 'in\_table'
    • 'not\_in\_table'
    The default value is 'in\_table'.
  • 'mode': Mode - should be either spatial or normal. Supported values:
    • 'normal'
    • 'spatial'
    The default value is 'normal'.
  • 'buffer': Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
  • 'buffer\_method': Method used to buffer polygons. Only relevant for spatial mode. Supported values:
    • 'normal'
    • 'geos': Use geos 1 edge per corner algorithm.
    The default value is 'normal'.
  • 'max\_partition\_size': Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
  • 'max\_partition\_score': Maximum number of points \* edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
  • 'x\_column\_name': Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
  • 'y\_column\_name': Name of column containing y value of point being filtered in spatial mode. The default value is 'y'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_table\_request(request, callback) → {"{"}Promise{"}"}

Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a view\_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_value(table\_name, view\_name, is\_string, value, value\_str, column\_name, options, callback) → {"{"}Promise{"}"}

Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
Parameters:
Name Type Description
table\_name String Name of an existing table on which to perform the calculation, in \[schema\_name.]table\_name format, using standard name resolution rules.
view\_name String If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
is\_string Boolean Indicates whether the value being searched for is string or numeric.
value Number The value to search for. The default value is 0.
value\_str String The string value to search for. The default value is ''.
column\_name String Name of a column on which the filter by value would be applied.
options Object Optional parameters.
  • 'create\_temp\_table': If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified\_view\_name. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'collection\_name': \[DEPRECATED--please specify the containing schema for the view as part of view\_name and use GPUdb#create\_schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_by\_value\_request(request, callback) → {"{"}Promise{"}"}

Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

filter\_request(request, callback) → {"{"}Promise{"}"}

Filters data based on the specified expression. The results are stored in a result set with the given view\_name.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_geo\_json(table\_name, offset, limit, options, callback) → {"{"}Promise{"}"}

Retrieves records from a given table as a GeoJSON, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters:
Name Type Description
table\_name String Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offset Number A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
limit Number A positive integer indicating the maximum number of results to be returned. Or END\_OF\_SET (-9999) to indicate that the max number of results should be returned.
options Object
  • 'expression': Optional filter expression to apply to the table.
  • 'fast\_index\_lookup': Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from \[0 to END\_OF\_SET]. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'sort\_by': Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
  • 'sort\_order': String indicating how the returned values should be sorted - ascending or descending. If sort\_order is provided, sort\_by has to be provided. Supported values:
    • 'ascending'
    • 'descending'
    The default value is 'ascending'.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the GeoJSON object, if no callback function is provided.
Type
Promise

get\_graph\_entities(graph\_name, offset, limit, options, callback) → {"{"}Promise{"}"}

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use GPUdb#show\_graph to obtain the total number of nodes and edges.
Parameters:
Name Type Description
graph\_name String Name of the graph from which to retrieve entities.
offset Number Starting index of the entities to retrieve (0-based). The default value is 0.
limit Number Number of entities to retrieve starting from offset. A value of -1 returns all entities from the offset to the end. Note: the entities\_int or entities\_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.
options Object Optional parameters.
  • 'entity\_type': The type of entity to retrieve. Supported values:
    • 'edge': Retrieve edge entities (default).
    • 'node': Retrieve node entities.
    The default value is 'edge'.
  • 'server\_id': Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'.
  • 'concise\_edge\_connectivity': When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: entities\_int contains stride-4 records \[edge\_id, node1\_index, node2\_index, edge\_label\_index] where node1\_index/node2\_index are 0-based positions into the node array (obtained from a node-entity call on the same graph). When requesting nodes with this option, the response includes tombstoned (deleted) slots in order to keep position indices stable so edge indices resolve correctly; deleted slots carry id=0 for integer graphs or an empty identifier for string/WKT graphs. For paginated node calls, subtract offset from an edge endpoint index to locate it within the returned page. Supported values:
    • 'true': Compact integer connectivity for edges; deleted node slots included in node output.
    • 'false': Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.
    The default value is 'false'.
  • 'include\_weights': When true and options entity\_type is 'edge', the response entities\_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities\_int or entities\_string). Empty when the graph has no weights component or when requesting nodes. Supported values:
    • 'true': Populate entities\_weight with per-edge weights (edge requests only).
    • 'false': Default: entities\_weight is empty.
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_graph\_entities\_request(request, callback) → {"{"}Promise{"}"}

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use GPUdb#show\_graph to obtain the total number of nodes and edges.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_http\_headers() → {"{"}Object{"}"}

Returns an object containing all the custom headers used currently by the API. Returns a deep copy so that the user does not accidentally change the actual headers. Note that the API may use other headers as appropriate; the ones returned here are the custom ones set up by the user.
Source:
  • ,
Returns:
The object containing all the custom headers the user has set up so far.
Type
Object

get\_job(job\_id, options, callback) → {"{"}Promise{"}"}

Get the status and result of asynchronously running job. See the GPUdb#create\_job for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
Parameters:
Name Type Description
job\_id Number A unique identifier for the job whose status and result is to be fetched.
options Object Optional parameters.
  • 'job\_tag': Job tag returned in call to create the job.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_job\_request(request, callback) → {"{"}Promise{"}"}

Get the status and result of asynchronously running job. See the GPUdb#create\_job for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records(table\_name, offset, limit, options, callback) → {"{"}Promise{"}"}

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters:
Name Type Description
table\_name String Name of the table or view from which the records will be fetched, in \[schema\_name.]table\_name format, using standard name resolution rules.
offset Number 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 Number 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 has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options Object
  • 'expression': Filter expression to apply to the table.
  • 'fast\_index\_lookup': Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from \[0 to END\_OF\_SET]. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'sort\_by': Column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
  • 'sort\_order': String indicating how the returned values should be sorted - ascending or descending. If sort\_order is provided, sort\_by has to be provided. Supported values:
    • 'ascending'
    • 'descending'
    The default value is 'ascending'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records\_by\_column(table\_name, column\_names, offset, limit, options, callback) → {"{"}Promise{"}"}

For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as GPUdb#create\_projection.

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 table\_name 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.

Parameters:
Name Type Description
table\_name String Name of the table or view on which this operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
column\_names Array.\ The list of column values to retrieve.
offset Number 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 Number 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 has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options Object
  • 'expression': Filter expression to apply to the table.
  • 'sort\_by': 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:
    • 'ascending'
    • 'descending'
    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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'route\_to\_tom': For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records\_by\_column\_request(request, callback) → {"{"}Promise{"}"}

For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as GPUdb#create\_projection.

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 table\_name 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.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records\_by\_series(table\_name, world\_table\_name, offset, limit, options, callback) → {"{"}Promise{"}"}

Retrieves the complete series/track records from the given world\_table\_name based on the partial track information contained in the table\_name.

This operation supports paging through the data via the offset and limit parameters.

In contrast to GPUdb#get\_records 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 table\_name. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters:
Name Type Description
table\_name String Name of the table or view for which series/tracks will be fetched, in \[schema\_name.]table\_name format, using standard name resolution rules.
world\_table\_name String Name of the table containing the complete series/track information to be returned for the tracks present in the table\_name, in \[schema\_name.]table\_name format, using standard name resolution rules. 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 Number 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 Number 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 Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records\_by\_series\_request(request, callback) → {"{"}Promise{"}"}

Retrieves the complete series/track records from the given world\_table\_name based on the partial track information contained in the table\_name.

This operation supports paging through the data via the offset and limit parameters.

In contrast to GPUdb#get\_records 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 table\_name. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records\_from\_collection(table\_name, offset, limit, options, callback) → {"{"}Promise{"}"}

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as GPUdb#delete\_records.

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 views using this operation. (DEPRECATED)

Parameters:
Name Type Description
table\_name String Name of the collection or table from which records are to be retrieved, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing collection or table.
offset Number 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 Number 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 offset and limit to request subsequent pages of results. The default value is -9999.
options Object
  • 'return\_record\_ids': If true then return the internal record ID along with each returned record. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'expression': Filter expression to apply to the table. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records\_from\_collection\_request(request, callback) → {"{"}Promise{"}"}

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as GPUdb#delete\_records.

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 views using this operation. (DEPRECATED)

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

get\_records\_json(table\_name, column\_names, offset, limit, expression, orderby\_columns, having\_clause, callback)

This method is used to retrieve records from a Kinetica table in the form of a JSON array (stringified). The only mandatory parameter is the 'tableName'. The rest are all optional with suitable defaults wherever applicable.
Parameters:
Name Type Description
table\_name string
column\_names array
offset int
limit int
expression string
orderby\_columns array
having\_clause string
callback object
Source:
  • ,

get\_records\_request(request, callback) → {"{"}Promise{"}"}

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission(principal, object, object\_type, permission, options, callback) → {"{"}Promise{"}"}

Grant user or role the specified permission on the specified object.
Parameters:
Name Type Description
principal String Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''.
object String Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible.
object\_type String The type of object being granted to. Supported values:
  • 'catalog': Catalog
  • 'context': Context
  • 'credential': Credential
  • 'datasink': Data Sink
  • 'datasource': Data Source
  • 'directory': KIFS File Directory
  • 'graph': A Graph object
  • 'proc': UDF Procedure
  • 'schema': Schema
  • 'sql\_proc': SQL Procedure
  • 'system': System-level access
  • 'table': Database Table
  • 'table\_monitor': Table monitor
permission String Permission being granted. Supported values:
  • 'admin': Full read/write and administrative access on the object.
  • 'connect': Connect access on the given data source or data sink.
  • 'create': Ability to create new objects of this type.
  • 'delete': Delete rows from tables.
  • 'execute': Ability to Execute the Procedure object.
  • 'insert': Insert access to tables.
  • 'monitor': Monitor logs and statistics.
  • 'read': Ability to read, list and use the object.
  • 'send\_alert': Ability to send system alerts.
  • 'update': Update access to the table.
  • 'user\_admin': Access to administer users and roles that do not have system\_admin permission.
  • 'write': Access to write, change and delete objects.
options Object Optional parameters.
  • 'columns': Apply table security to these columns, comma-separated. The default value is ''.
  • 'filter\_expression': Filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
  • 'with\_grant\_option': Allow the recipient to grant the same permission (or subset) to others. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_credential(name, permission, credential\_name, options, callback) → {"{"}Promise{"}"}

Grants a credential-level permission to a user or role.
Parameters:
Name Type Description
name String Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission String Permission to grant to the user or role. Supported values:
  • 'credential\_admin': Full read/write and administrative access on the credential.
  • 'credential\_read': Ability to read and use the credential.
credential\_name String Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_credential\_request(request, callback) → {"{"}Promise{"}"}

Grants a credential-level permission to a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_datasource(name, permission, datasource\_name, options, callback) → {"{"}Promise{"}"}

Grants a data source permission to a user or role.
Parameters:
Name Type Description
name String Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission String Permission to grant to the user or role. Supported values:
  • 'admin': Admin access on the given data source.
  • 'connect': Connect access on the given data source.
datasource\_name String Name of the data source on which the permission will be granted. Must be an existing data source, or an empty string to grant permission on all data sources.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_datasource\_request(request, callback) → {"{"}Promise{"}"}

Grants a data source permission to a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_directory(name, permission, directory\_name, options, callback) → {"{"}Promise{"}"}

Grants a KiFS directory-level permission to a user or role.
Parameters:
Name Type Description
name String Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission String Permission to grant to the user or role. Supported values:
  • 'directory\_read': For files in the directory, access to list files, download files, or use files in server side functions.
  • 'directory\_write': Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access.
directory\_name String Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_directory\_request(request, callback) → {"{"}Promise{"}"}

Grants a KiFS directory-level permission to a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_proc(name, permission, proc\_name, options, callback) → {"{"}Promise{"}"}

Grants a proc-level permission to a user or role.
Parameters:
Name Type Description
name String Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission String Permission to grant to the user or role. Supported values:
  • 'proc\_admin': Admin access to the proc.
  • 'proc\_execute': Execute access to the proc.
proc\_name String 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 Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_proc\_request(request, callback) → {"{"}Promise{"}"}

Grants a proc-level permission to a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_request(request, callback) → {"{"}Promise{"}"}

Grant user or role the specified permission on the specified object.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_system(name, permission, options, callback) → {"{"}Promise{"}"}

Grants a system-level permission to a user or role.
Parameters:
Name Type Description
name String Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission String 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.
  • 'system\_send\_alert': Send system alerts.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_system\_request(request, callback) → {"{"}Promise{"}"}

Grants a system-level permission to a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_table(name, permission, table\_name, filter\_expression, options, callback) → {"{"}Promise{"}"}

Grants a table-level permission to a user or role.
Parameters:
Name Type Description
name String Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission String 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.
table\_name String Name of the table to which the permission grants access, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table, view, or schema. If a schema, the permission also applies to tables and views in the schema.
filter\_expression String Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
options Object Optional parameters.
  • 'columns': Apply security to these columns, comma-separated. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_permission\_table\_request(request, callback) → {"{"}Promise{"}"}

Grants a table-level permission to a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_role(role, member, options, callback) → {"{"}Promise{"}"}

Grants membership in a role to a user or role.
Parameters:
Name Type Description
role String Name of the role in which membership will be granted. Must be an existing role.
member String Name of the user or role that will be granted membership in role. Must be an existing user or role.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

grant\_role\_request(request, callback) → {"{"}Promise{"}"}

Grants membership in a role to a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_permission(principal, object, object\_type, permission, options, callback) → {"{"}Promise{"}"}

Checks if the specified user has the specified permission on the specified object.
Parameters:
Name Type Description
principal String Name of the user for which the permission is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.
object String Name of object to check for the requested permission. It is recommended to use a fully-qualified name when possible.
object\_type String The type of object being checked. Supported values:
  • 'catalog': External Catalog
  • 'context': Context
  • 'credential': Credential
  • 'datasink': Data Sink
  • 'datasource': Data Source
  • 'directory': KiFS File Directory
  • 'graph': A Graph object
  • 'proc': UDF Procedure
  • 'schema': Schema
  • 'sql\_proc': SQL Procedure
  • 'system': System-level access
  • 'table': Database Table
  • 'table\_monitor': Table monitor
permission String Permission to check for. Supported values:
  • 'admin': Full read/write and administrative access on the object.
  • 'connect': Connect access on the given data source or data sink.
  • 'create': Ability to create new objects of this type.
  • 'delete': Delete rows from tables.
  • 'execute': Ability to Execute the Procedure object.
  • 'insert': Insert access to tables.
  • 'monitor': Monitor logs and statistics.
  • 'read': Ability to read, list and use the object.
  • 'send\_alert': Ability to send system alerts.
  • 'update': Update access to the table.
  • 'user\_admin': Access to administer users and roles that do not have system\_admin permission.
  • 'write': Access to write, change and delete objects.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If false will return an error if the provided object does not exist or is blank. If true then it will return false for has\_permission. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_permission\_request(request, callback) → {"{"}Promise{"}"}

Checks if the specified user has the specified permission on the specified object.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_proc(proc\_name, options, callback) → {"{"}Promise{"}"}

Checks the existence of a proc with the given name.
Parameters:
Name Type Description
proc\_name String Name of the proc to check for existence.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_proc\_request(request, callback) → {"{"}Promise{"}"}

Checks the existence of a proc with the given name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_role(principal, role, options, callback) → {"{"}Promise{"}"}

Checks if the specified user has the specified role.
Parameters:
Name Type Description
principal String Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.
role String Name of role to check for membership.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If false will return an error if the provided role does not exist or is blank. If true then it will return false for has\_role. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'only\_direct': If false will search recursively if the principal is a member of role. If true then principal must directly be a member of role. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_role\_request(request, callback) → {"{"}Promise{"}"}

Checks if the specified user has the specified role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_schema(schema\_name, options, callback) → {"{"}Promise{"}"}

Checks for the existence of a schema with the given name.
Parameters:
Name Type Description
schema\_name String Name of the schema to check for existence, in root, using standard name resolution rules.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_schema\_request(request, callback) → {"{"}Promise{"}"}

Checks for the existence of a schema with the given name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_table(table\_name, options, callback) → {"{"}Promise{"}"}

Checks for the existence of a table with the given name.
Parameters:
Name Type Description
table\_name String Name of the table to check for existence, in \[schema\_name.]table\_name format, using standard name resolution rules.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_table\_request(request, callback) → {"{"}Promise{"}"}

Checks for the existence of a table with the given name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_type(type\_id, options, callback) → {"{"}Promise{"}"}

Check for the existence of a type.
Parameters:
Name Type Description
type\_id String Id of the type returned in response to GPUdb#create\_type request.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

has\_type\_request(request, callback) → {"{"}Promise{"}"}

Check for the existence of a type.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records(table\_name, data, options, callback) → {"{"}Promise{"}"}

Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update\_on\_existing\_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return\_record\_ids option indicates that the database should return the unique identifiers of inserted records.

Parameters:
Name Type Description
table\_name String Name of table to which the records are to be added, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
data Array.\ An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if list\_encoding is binary.
options Object 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 (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore\_existing\_pk, allow\_partial\_batch, and return\_individual\_errors. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Upsert new records when primary keys match existing records.
    • 'false': Reject new records when primary keys match existing records.
    The default value is 'false'.
  • 'enable\_inplace\_updates': Applies only when upserting (when update\_on\_existing\_pk is true). If set to true, an existing record matched by primary key is modified in place. If set to false, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update\_on\_existing\_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by allow\_partial\_batch and return\_individual\_errors. If the specified table does not have a primary key or if upsert mode is in effect (update\_on\_existing\_pk is true), then this option has no effect. Supported values:
    • 'true': Ignore new records whose primary key values collide with those of existing records.
    • 'false': Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is 'false'.
  • 'pk\_conflict\_predicate\_higher': The record with higher value for the column resolves the primary-key insert conflict. The default value is ''.
  • 'pk\_conflict\_predicate\_lower': The record with lower value for the column resolves the primary-key insert conflict. The default value is ''.
  • 'return\_record\_ids': If true then return the internal record id along for each inserted record. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • '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:
    • 'true'
    • 'false'
    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). 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:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'dry\_run': If set to true, no data will be saved and any errors will be returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'request\_schema\_str': Type schema of list (when list\_encoding is binary), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.
  • 'transformations': Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column -- the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_from\_files(table\_name, filepaths, modify\_columns, create\_table\_options, options, callback) → {"{"}Promise{"}"}

Reads from one or more files and inserts the data into a new or existing table. The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.

For delimited text 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.

Note: Due to data being loaded in parallel, there is no insertion order guaranteed. For tables with primary keys, in the case of a primary key collision, this means it is indeterminate which record will be inserted first and remain, while the rest of the colliding key records are discarded.

Returns once all files are processed.

Parameters:
Name Type Description
table\_name String Name of the table into which the data will be inserted, in \[schema\_name.]table\_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type\_id or the type inferred from the file, and the new table name will have to meet standard table naming criteria.
filepaths Array.\ A list of file paths from which data will be sourced; For paths in KiFS, use the URI prefix of kifs\:// followed by the path to a file or directory. File matching by prefix is supported, e.g. kifs\://dir/file would match dir/file\_1 and dir/file\_2. When prefix matching is used, the path must start with a full, valid KiFS directory name. If an external data source is specified in datasource\_name, these file paths must resolve to accessible files at that data source location. Prefix matching is supported. If the data source is hdfs, prefixes must be aligned with directories, i.e. partial file names will not match. If no data source is specified, the files are assumed to be local to the database and must all be accessible to the gpudb user, residing on the path (or relative to the path) specified by the external files directory in the Kinetica configuration file. Wildcards (\*) can be used to specify a group of files. Prefix matching is supported, the prefixes must be aligned with directories. 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 (|).
modify\_columns Object Not implemented yet. The default value is an empty object ( {"{"}{"}"} ).
create\_table\_options Object Options from GPUdb#create\_table, allowing the structure of the table to be defined independently of the data source, when creating the target table.
  • 'type\_id': ID of a currently registered type.
  • '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 name but a different type exists, it is still an error. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'is\_replicated': Affects the distribution scheme for the table's data. If true and the given table 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'foreign\_keys': Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  • 'foreign\_shard\_key': Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  • 'partition\_type': Partitioning scheme to use. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in table\_name.
  • 'chunk\_size': Indicates the number of records per chunk to be used for this table.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for this table.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a chunk to be used for this table.
  • 'is\_result\_table': Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for this table's columns.
The default value is an empty object ( {"{"}{"}"} ).
options Object Optional parameters.
  • 'bad\_record\_table\_name': Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string). When error\_handling is abort, bad records table is not populated.
  • 'bad\_record\_table\_limit': A positive integer indicating the maximum number of records that can be written to the bad-record-table. The default value is '10000'.
  • 'bad\_record\_table\_limit\_per\_input': For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be bad\_record\_table\_limit and total size of the table per rank is limited to bad\_record\_table\_limit.
  • 'batch\_size': Number of records to insert per batch when inserting data. The default value is '50000'.
  • '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, and 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': Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns\_to\_skip.
  • 'columns\_to\_skip': Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns\_to\_load.
  • 'compression\_type': Source data compression type. Supported values:
    • 'none': No compression.
    • 'auto': Auto detect compression type.
    • 'gzip': gzip file compression.
    • 'bzip2': bzip2 file compression.
    The default value is 'auto'.
  • 'datasource\_name': Name of an existing external data source from which data file(s) specified in filepaths will be loaded.
  • 'default\_column\_formats': Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and 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"
  • '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. Primary key collisions are considered abortable errors in this mode.
    The default value is 'abort'.
  • 'file\_type': Specifies the type of the file(s) whose records will be inserted. Supported values:
    • 'avro': Avro file format.
    • 'delimited\_text': Delimited text file format; e.g., CSV, TSV, PSV, etc.
    • 'gdb': Esri/GDB file format.
    • 'json': JSON file format.
    • 'parquet': Apache Parquet file format.
    • 'shapefile': ShapeFile file format.
    The default value is 'delimited\_text'.
  • 'flatten\_columns': Specifies how to handle nested columns. Supported values:
    • 'true': Break up nested columns to multiple columns.
    • 'false': Treat nested columns as JSON columns instead of flattening.
    The default value is 'false'.
  • 'gdal\_configuration\_options': Comma separated list of gdal conf options, for the specific requests: key=value.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update\_on\_existing\_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error\_handling. If the specified table does not have a primary key or if upsert mode is in effect (update\_on\_existing\_pk is true), then this option has no effect. Supported values:
    • 'true': Ignore new records whose primary key values collide with those of existing records.
    • 'false': Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is 'false'.
  • 'ingestion\_mode': Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • 'full': Run a type inference on the source data (if needed) and ingest.
    • 'dry\_run': Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error\_handling.
    • 'type\_inference\_only': Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is 'full'.
  • 'kafka\_consumers\_per\_rank': Number of Kafka consumer threads per rank (valid range 1-6). The default value is '1'.
  • 'kafka\_group\_id': The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).
  • 'kafka\_offset\_reset\_policy': Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset. Supported values:
    • 'earliest'
    • 'latest'
    The default value is 'earliest'.
  • 'kafka\_optimistic\_ingest': Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'kafka\_subscription\_cancel\_after': Sets the Kafka subscription lifespan (in minutes). Expired subscription will be cancelled automatically.
  • 'kafka\_type\_inference\_fetch\_timeout': Maximum time to collect Kafka messages before type inferencing on the set of them.
  • 'layer': Geo files layer(s) name(s): comma separated.
  • 'loading\_mode': Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
    • 'head': The head node loads all data. All files must be available to the head node.
    • 'distributed\_shared': The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
    • 'distributed\_local': A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
    The default value is 'head'.
  • 'local\_time\_offset': Apply an offset to Avro local timestamp columns.
  • 'max\_records\_to\_load': Limit the number of records to load in this request: if this number is larger than batch\_size, then the number of records loaded will be limited to the next whole number of batch\_size (per working thread).
  • 'name\_columns\_from\_file': Specifies a comma-delimited list of column names to be used as the source-data column names. If the file has a header row (i.e., text\_has\_header is true), these names override the file's header names. If the file has no header row, these names are used as the source-data column names. Either way, the i-th name in this list applies to the i-th column in the file, enabling name-based matching against the target table's columns (and use with columns\_to\_load / columns\_to\_skip).
  • 'num\_tasks\_per\_rank': Number of tasks for reading file per rank. Default will be system configuration parameter, external\_file\_reader\_num\_tasks.
  • 'poll\_interval': If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is '0'.
  • 'primary\_keys': Comma separated list of column names to set as primary keys, when not specified in the type.
  • 'schema\_registry\_connection\_retries': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_connection\_timeout': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_max\_consecutive\_connection\_failures': Max records to skip due to SR connection failures, before failing.
  • 'max\_consecutive\_invalid\_schema\_failure': Max records to skip due to schema related errors, before failing.
  • 'schema\_registry\_schema\_name': Name of the Avro schema in the schema registry to use when reading Avro records.
  • 'shard\_keys': Comma separated list of column names to set as shard keys, when not specified in the type.
  • 'skip\_lines': Skip a number of lines from the beginning of the file.
  • 'start\_offsets': Starting offsets by partition to fetch from kafka. A comma separated list of partition:offset pairs.
  • 'subscribe': Continuously poll the data source to check for new data and load it into the table. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'table\_insert\_mode': Insertion scheme to use when inserting records from multiple shapefiles. Supported values:
    • 'single': Insert all records into a single table.
    • 'table\_per\_file': Insert records from each file into a new table corresponding to that file.
    The default value is 'single'.
  • 'text\_comment\_string': Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited\_text file\_type only. The default value is '#'.
  • 'text\_delimiter': Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited\_text file\_type only. The default value is ','.
  • 'text\_escape\_character': Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, and vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited\_text file\_type only.
  • 'text\_has\_header': Indicates whether the source data contains a header row. For delimited\_textfile\_type only. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'text\_header\_property\_delimiter': Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text\_delimiter. For delimited\_text file\_type only. The default value is '|'.
  • 'text\_null\_string': Specifies the character string that should be interpreted as a null value in the source data. For delimited\_text file\_type only. The default value is '\N'.
  • 'text\_quote\_character': Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited\_text file\_type only. The default value is '"'.
  • 'text\_search\_columns': Add 'text\_search' property to internally inferenced string columns. Comma separated list of column names or '\*' for all columns. To add 'text\_search' property only to string columns greater than or equal to a minimum size, also set the text\_search\_min\_column\_length
  • 'text\_search\_min\_column\_length': Set the minimum column size for strings to apply the 'text\_search' property to. Used only when text\_search\_columns has a value.
  • 'trim\_space': If set to true, remove leading or trailing space from fields. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'truncate\_strings': If set to true, truncate string values that are longer than the column's type size. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'truncate\_table': If set to true, truncates the table specified by table\_name prior to loading the file(s). Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'type\_inference\_max\_records\_read'
  • 'type\_inference\_mode': Optimize type inferencing for either speed or accuracy. Supported values:
    • 'accuracy': Scans data to get exactly-typed and sized columns for all data scanned.
    • 'speed': Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned.
    The default value is 'accuracy'.
  • 'enable\_inplace\_updates': Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • '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 (the new data will be 'upserted'). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore\_existing\_pk and error\_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Upsert new records when primary keys match existing records.
    • 'false': Reject new records when primary keys match existing records.
    The default value is 'false'.
  • 'transformations': Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column -- the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_from\_files\_request(request, callback) → {"{"}Promise{"}"}

Reads from one or more files and inserts the data into a new or existing table. The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.

For delimited text 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.

Note: Due to data being loaded in parallel, there is no insertion order guaranteed. For tables with primary keys, in the case of a primary key collision, this means it is indeterminate which record will be inserted first and remain, while the rest of the colliding key records are discarded.

Returns once all files are processed.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_from\_json(records, table\_name, create\_table\_options, options, callback) → {"{"}Promise{"}"}

Parameters:
Name Type Description
records Object Either a single JSON record or an array of JSON records, as either a JSON string or a native map/array type
table\_name string The name of the table to insert into
create\_table\_options Object the same 'create\_table\_options' that apply to the '/insert/records/frompayload' endpoint
options Object the 'options' that apply to the '/insert/records/frompayload' endpoint
callback function an optional callback method that receives the results
Source:
  • ,
Returns:
A promise that will be fulfilled with the 'data' (containing insertion results like counts etc) object, if no callback function is provided.
Type
Promise

insert\_records\_from\_payload(table\_name, data\_text, data\_bytes, modify\_columns, create\_table\_options, options, callback) → {"{"}Promise{"}"}

Reads from the given text-based or binary payload and inserts the data into a new or existing table. The table will be created if it doesn't already exist.

Returns once all records are processed.

Parameters:
Name Type Description
table\_name String Name of the table into which the data will be inserted, in \[schema\_name.]table\_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type\_id or the type inferred from the payload, and the new table name will have to meet standard table naming criteria.
data\_text String Records formatted as delimited text.
data\_bytes String Records formatted as binary data.
modify\_columns Object Not implemented yet. The default value is an empty object ( {"{"}{"}"} ).
create\_table\_options Object Options used when creating the target table. Includes type to use. The other options match those in GPUdb#create\_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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'is\_replicated': 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'foreign\_keys': Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  • 'foreign\_shard\_key': Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  • 'partition\_type': Partitioning scheme to use. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in table\_name.
  • 'chunk\_size': Indicates the number of records per chunk to be used for this table.
  • 'chunk\_column\_max\_memory': Indicates the target maximum data size for each column in a chunk to be used for this table.
  • 'chunk\_max\_memory': Indicates the target maximum data size for all columns in a chunk to be used for this table.
  • 'is\_result\_table': Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for this table's columns.
The default value is an empty object ( {"{"}{"}"} ).
options Object Optional parameters.
  • 'bad\_record\_table\_name': Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string).
  • 'bad\_record\_table\_limit': A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
  • 'bad\_record\_table\_limit\_per\_input': For subscriptions: A positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be 'bad\_record\_table\_limit' and total size of the table per rank is limited to 'bad\_record\_table\_limit'.
  • 'batch\_size': Internal tuning parameter--number of records per batch when inserting data.
  • '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, and 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': Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns\_to\_skip.
  • 'columns\_to\_skip': Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns\_to\_load.
  • 'compression\_type': Payload compression type. Supported values:
    • 'none': Uncompressed.
    • 'auto': Default. Auto detect compression type.
    • 'gzip': gzip file compression.
    • 'bzip2': bzip2 file compression.
    The default value is 'auto'.
  • 'default\_column\_formats': Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and 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"
  • '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. Primary key collisions are considered abortable errors in this mode.
    The default value is 'abort'.
  • 'file\_type': Specifies the type of the file(s) whose records will be inserted. Supported values:
    • 'avro': Avro file format.
    • 'delimited\_text': Delimited text file format; e.g., CSV, TSV, PSV, etc.
    • 'gdb': Esri/GDB file format.
    • 'json': JSON file format.
    • 'parquet': Apache Parquet file format.
    • 'shapefile': ShapeFile file format.
    The default value is 'delimited\_text'.
  • 'flatten\_columns': Specifies how to handle nested columns. Supported values:
    • 'true': Break up nested columns to multiple columns.
    • 'false': Treat nested columns as JSON columns instead of flattening.
    The default value is 'false'.
  • 'gdal\_configuration\_options': Comma separated list of gdal conf options, for the specific requests: key=value. The default value is ''.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update\_on\_existing\_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error\_handling. If the specified table does not have a primary key or if upsert mode is in effect (update\_on\_existing\_pk is true), then this option has no effect. Supported values:
    • 'true': Ignore new records whose primary key values collide with those of existing records.
    • 'false': Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is 'false'.
  • 'ingestion\_mode': Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • 'full': Run a type inference on the source data (if needed) and ingest.
    • 'dry\_run': Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error\_handling.
    • 'type\_inference\_only': Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is 'full'.
  • 'layer': Geo files layer(s) name(s): comma separated. The default value is ''.
  • 'loading\_mode': Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
    • 'head': The head node loads all data. All files must be available to the head node.
    • 'distributed\_shared': The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
    • 'distributed\_local': A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
    The default value is 'head'.
  • 'local\_time\_offset': For Avro local timestamp columns.
  • 'max\_records\_to\_load': Limit the number of records to load in this request: If this number is larger than a batch\_size, then the number of records loaded will be limited to the next whole number of batch\_size (per working thread). The default value is ''.
  • 'name\_columns\_from\_file': Specifies a comma-delimited list of column names to be used as the source-data column names. If the payload has a header row (i.e., text\_has\_header is true), these names override the payload's header names. If the payload has no header row, these names are used as the source-data column names. Either way, the i-th name in this list applies to the i-th column in the payload, enabling name-based matching against the target table's columns (and use with columns\_to\_load / columns\_to\_skip).
  • 'num\_tasks\_per\_rank': Number of tasks for reading file per rank. Default will be external\_file\_reader\_num\_tasks.
  • 'poll\_interval': If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds.
  • 'primary\_keys': Comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
  • 'schema\_registry\_connection\_retries': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_connection\_timeout': Confluent Schema registry connection timeout (in secs).
  • 'schema\_registry\_max\_consecutive\_connection\_failures': Max records to skip due to SR connection failures, before failing.
  • 'max\_consecutive\_invalid\_schema\_failure': Max records to skip due to schema related errors, before failing.
  • 'schema\_registry\_schema\_name': Name of the Avro schema in the schema registry to use when reading Avro records.
  • 'shard\_keys': Comma separated list of column names, to set as shard keys, when not specified in the type. The default value is ''.
  • 'skip\_lines': Skip a number of lines from the beginning of the file.
  • 'subscribe': Continuously poll the data source to check for new data and load it into the table. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'table\_insert\_mode': When inserting records from multiple files: if table\_per\_file, then insert from each file into a new table. Currently supported only for shapefiles. Supported values:
    • 'single'
    • 'table\_per\_file'
    The default value is 'single'.
  • 'text\_comment\_string': Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited\_text file\_type only. The default value is '#'.
  • 'text\_delimiter': Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited\_text file\_type only. The default value is ','.
  • 'text\_escape\_character': Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, and vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited\_text file\_type only.
  • 'text\_has\_header': Indicates whether the source data contains a header row. For delimited\_textfile\_type only. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'text\_header\_property\_delimiter': Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text\_delimiter. For delimited\_text file\_type only. The default value is '|'.
  • 'text\_null\_string': Specifies the character string that should be interpreted as a null value in the source data. For delimited\_text file\_type only. The default value is '\N'.
  • 'text\_quote\_character': Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited\_text file\_type only. The default value is '"'.
  • 'text\_search\_columns': Add 'text\_search' property to internally inferenced string columns. Comma separated list of column names or '\*' for all columns. To add text\_search property only to string columns of minimum size, set also the option 'text\_search\_min\_column\_length'.
  • 'text\_search\_min\_column\_length': Set minimum column size. Used only when 'text\_search\_columns' has a value.
  • 'trim\_space': If set to true, remove leading or trailing space from fields. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'truncate\_strings': If set to true, truncate string values that are longer than the column's type size. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'truncate\_table': If set to true, truncates the table specified by table\_name prior to loading the file(s). Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'type\_inference\_max\_records\_read': The default value is ''.
  • 'type\_inference\_mode': Optimize type inference mode. Supported values:
    • 'accuracy': Scans data to get exactly-typed and sized columns for all data scanned.
    • 'speed': Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned.
    The default value is 'accuracy'.
  • 'enable\_inplace\_updates': Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • '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 (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore\_existing\_pk and error\_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Upsert new records when primary keys match existing records.
    • 'false': Reject new records when primary keys match existing records.
    The default value is 'false'.
  • 'transformations': Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column -- the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_from\_payload\_request(request, callback) → {"{"}Promise{"}"}

Reads from the given text-based or binary payload and inserts the data into a new or existing table. The table will be created if it doesn't already exist.

Returns once all records are processed.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_from\_query(table\_name, remote\_query, modify\_columns, create\_table\_options, options, callback) → {"{"}Promise{"}"}

Computes remote query result and inserts the result data into a new or existing table.
Parameters:
Name Type Description
table\_name String Name of the table into which the data will be inserted, in \[schema\_name.]table\_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type\_id or the type inferred from the remote query, and the new table name will have to meet standard table naming criteria.
remote\_query String Query for which result data needs to be imported.
modify\_columns Object Not implemented yet. The default value is an empty object ( {"{"}{"}"} ).
create\_table\_options Object Options used when creating the target 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'is\_replicated': 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'foreign\_keys': Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  • 'foreign\_shard\_key': Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  • 'partition\_type': Partitioning scheme to use. Supported values:
  • '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, hash partitioning, or series 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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'ttl': Sets the TTL of the table specified in table\_name.
  • 'chunk\_size': Indicates the number of records per chunk to be used for this table.
  • 'is\_result\_table': Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'strategy\_definition': The tier strategy for the table and its columns.
  • 'compression\_codec': The default compression codec for this table's columns.
The default value is an empty object ( {"{"}{"}"} ).
options Object Optional parameters.
  • 'bad\_record\_table\_name': Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line\_number (long), line\_rejected (string), error\_message (string). When error handling is Abort, bad records table is not populated.
  • 'bad\_record\_table\_limit': A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
  • 'batch\_size': Number of records per batch when inserting data.
  • 'datasource\_name': Name of an existing external data source from which table will be loaded.
  • '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. Primary key collisions are considered abortable errors in this mode.
    The default value is 'abort'.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update\_on\_existing\_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error\_handling. If the specified table does not have a primary key or if upsert mode is in effect (update\_on\_existing\_pk is true), then this option has no effect. Supported values:
    • 'true': Ignore new records whose primary key values collide with those of existing records.
    • 'false': Treat as errors any new records whose primary key values collide with those of existing records.
    The default value is 'false'.
  • 'ingestion\_mode': Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
    • 'full': Run a type inference on the source data (if needed) and ingest.
    • 'dry\_run': Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error\_handling.
    • 'type\_inference\_only': Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
    The default value is 'full'.
  • 'jdbc\_fetch\_size': The JDBC fetch size, which determines how many rows to fetch per round trip.
  • 'jdbc\_session\_init\_statement': Executes the statement per each JDBC session before doing actual load. The default value is ''.
  • 'num\_splits\_per\_rank': Number of splits for reading data per rank. Default will be external\_file\_reader\_num\_tasks. The default value is ''.
  • 'num\_tasks\_per\_rank': Number of tasks for reading data per rank. Default will be external\_file\_reader\_num\_tasks.
  • 'primary\_keys': Comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
  • 'shard\_keys': Comma separated list of column names, to set as shard keys, when not specified in the type. The default value is ''.
  • 'subscribe': Continuously poll the data source to check for new data and load it into the table. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'truncate\_table': If set to true, truncates the table specified by table\_name prior to loading the data. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'remote\_query': Remote SQL query from which data will be sourced.
  • 'remote\_query\_order\_by': Name of column to be used for splitting the query into multiple sub-queries using ordering of given column. The default value is ''.
  • 'remote\_query\_filter\_column': Name of column to be used for splitting the query into multiple sub-queries using the data distribution of given column. The default value is ''.
  • 'remote\_query\_increasing\_column': Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP). The default value is ''.
  • 'remote\_query\_partition\_column': Alias name for remote\_query\_filter\_column. The default value is ''.
  • 'truncate\_strings': If set to true, truncate string values that are longer than the column's type size. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'enable\_inplace\_updates': Applies only when upserting (when update\_on\_existing\_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • '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 (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore\_existing\_pk and error\_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Upsert new records when primary keys match existing records.
    • 'false': Reject new records when primary keys match existing records.
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_from\_query\_request(request, callback) → {"{"}Promise{"}"}

Computes remote query result and inserts the result data into a new or existing table.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_random(table\_name, count, options, callback) → {"{"}Promise{"}"}

Generates a specified number of random records and adds them to the given table. There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that a response will not be returned until all random records are fully available.

Parameters:
Name Type Description
table\_name String Table to which random records will be added, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table, not a view.
count Number Number of records to generate.
options Object 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.
  • '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': The seed value to use.
  • '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. 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. If both minimum and maximum are provided, \*max\* must be greater than or equal to \*min\*. 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 linearly 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 (e.g. 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. 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. If both minimum and maximum are provided, \*max\* must be greater than or equal to \*min\*. 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 linearly 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 (e.g. 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. The minimum allowed value is 1. The maximum allowed value is 500.
    • 'max': Maximum possible length for generated series; default is 500 records per series. Must be an integral value within the range \[1, 500]. If both min and max are specified, max must be greater than or equal to min. The minimum allowed value is 1. The maximum allowed value is 500.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_random\_request(request, callback) → {"{"}Promise{"}"}

Generates a specified number of random records and adds them to the given table. There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that a response will not be returned until all random records are fully available.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_records\_request(request, callback) → {"{"}Promise{"}"}

Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update\_on\_existing\_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return\_record\_ids option indicates that the database should return the unique identifiers of inserted records.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_symbol(symbol\_id, symbol\_format, symbol\_data, options, callback) → {"{"}Promise{"}"}

Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg\_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
Parameters:
Name Type Description
symbol\_id String The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol.
symbol\_format String Specifies the symbol format. Must be either 'svg' or 'svg\_path'. Supported values:
  • 'svg'
  • 'svg\_path'
symbol\_data String The actual symbol data. If symbol\_format is 'svg' then this should be the raw bytes representing an svg file. If symbol\_format 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 Object Optional parameters.
  • 'color': If symbol\_format is 'svg' this is ignored. If symbol\_format is 'svg\_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

insert\_symbol\_request(request, callback) → {"{"}Promise{"}"}

Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg\_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

kill\_proc(run\_id, options, callback) → {"{"}Promise{"}"}

Kills a running proc instance.
Parameters:
Name Type Description
run\_id String 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 Object Optional parameters.
  • 'run\_tag': If run\_id is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to GPUdb#execute\_proc. If run\_id is not specified, kill the proc instance(s) where a matching run tag was provided to GPUdb#execute\_proc. The default value is ''.
  • 'clear\_execute\_at\_startup': If true, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from GPUdb#execute\_proc and can be retrieved using GPUdb#show\_proc. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

kill\_proc\_request(request, callback) → {"{"}Promise{"}"}

Kills a running proc instance.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

lock\_table(table\_name, lock\_type, options, callback) → {"{"}Promise{"}"}

Manages global access to a table's data. By default a table has a lock\_type 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 lock\_type is no\_access then no operations are permitted on the table. The lock status can be queried by setting lock\_type to status.
Parameters:
Name Type Description
table\_name String Name of the table to be locked, in \[schema\_name.]table\_name format, using standard name resolution rules. It must be a currently existing table or view.
lock\_type String The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. Supported values:
  • 'status': Show locked status.
  • 'no\_access': Allow no read/write operations.
  • 'read\_only': Allow only read operations.
  • 'write\_only': Allow only write operations.
  • 'read\_write': Allow all read/write operations.
The default value is 'status'.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

lock\_table\_request(request, callback) → {"{"}Promise{"}"}

Manages global access to a table's data. By default a table has a lock\_type 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 lock\_type is no\_access then no operations are permitted on the table. The lock status can be queried by setting lock\_type to status.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

match\_graph(graph\_name, sample\_points, solve\_method, solution\_table, options, callback) → {"{"}Promise{"}"}

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.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Parameters:
Name Type Description
graph\_name String Name of the underlying geospatial graph resource to match to using sample\_points.
sample\_points Array.\ 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'.
solve\_method String The type of solver to use for graph matching. Supported values:
  • 'markov\_chain': Matches sample\_points 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 sample\_points to find the most probable path between origin and destination pairs with cost constraints.
  • 'match\_supply\_demand': Matches sample\_points 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 sample\_points source and destination pairs for the shortest path solves in batch mode.
  • 'match\_loops': Matches closed loops (Eulerian paths) originating and ending at each graph node within min and max hops (levels).
  • 'match\_charging\_stations': Matches an optimal path across a number of ev-charging stations between source and target locations.
  • 'match\_similarity': Matches the intersection set(s) by computing the Jaccard similarity score between node pairs.
  • 'match\_pickup\_dropoff': Matches the pickups and dropoffs by optimizing the total trip costs.
  • 'match\_clusters': Matches the graph nodes with a cluster index using Louvain clustering algorithm.
  • 'match\_pattern': Matches a pattern in the graph.
  • 'match\_embedding': Creates vector node embeddings.
  • 'match\_isochrone': Solves for isochrones for a set of input sources.
  • 'match\_route\_detour': Computes detour costs for nearby stations at a mark point along each source-target route.
The default value is 'markov\_chain'.
solution\_table String The name of the table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. 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. Must not be an existing table of the same name. The default value is ''.
options Object 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': WKT starting point from sample\_points 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': WKT ending point from sample\_points 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.
    The default value is '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'.
  • 'max\_supply\_combinations': For the match\_supply\_demand solver only. This is the cutoff for the number of generated combinations for sequencing the supply locations if/when 'permute\_supplies' is true. The default value is '10000'.
  • 'left\_turn\_penalty': This will add an additional weight over the edges labeled as 'left turn' if the 'add\_turn' option parameter of the GPUdb#create\_graph was invoked at graph creation. The default value is '0.0'.
  • 'right\_turn\_penalty': This will add an additional weight over the edges labeled as' right turn' if the 'add\_turn' option parameter of the GPUdb#create\_graph was invoked at graph creation. The default value is '0.0'.
  • 'intersection\_penalty': This will add an additional weight over the edges labeled as 'intersection' if the 'add\_turn' option parameter of the GPUdb#create\_graph was invoked at graph creation. The default value is '0.0'.
  • 'sharp\_turn\_penalty': This will add an additional weight over the edges labeled as 'sharp turn' or 'u-turn' if the 'add\_turn' option parameter of the GPUdb#create\_graph 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'.
  • 'output\_tracks': For the match\_supply\_demand solver only. When it is true (non-default), the output will be in tracks format for all the round trips of each truck in which the timestamps are populated directly from the edge weights starting from their originating depots. The default value is 'false'.
  • 'max\_trip\_cost': For the match\_supply\_demand and match\_pickup\_dropoff solvers only. If this constraint is greater than zero (default) then the trucks/rides will skip traveling from one demand/pick 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:
    • 'true': Filter out the folded paths.
    • 'false': Do not filter out the folded paths.
    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'.
  • 'service\_limit': For the match\_supply\_demand solver only. If specified (greater than zero), any supply actor'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\_reuse': For the match\_supply\_demand solver only. If specified (true), all supply actors can be scheduled for second rounds from their originating depots. Supported values:
    • 'true': Allows reusing supply actors (trucks, e.g.) for scheduling again.
    • 'false': Supply actors are scheduled only once from their depots.
    The default value is 'false'.
  • 'max\_stops': For the match\_supply\_demand solver only. If specified (greater than zero), a supply actor (truck) can at most have this many stops (demand locations) in one round trip. Otherwise, it is unlimited. If 'enable\_truck\_reuse' is on, this condition will be applied separately at each round trip use of the same truck. The default value is '0'.
  • 'service\_radius': For the match\_supply\_demand and match\_pickup\_dropoff solvers only. If specified (greater than zero), it filters the demands/picks outside this radius centered around the supply actor/ride's originating location (distance or time). The default value is '0.0'.
  • 'permute\_supplies': For the match\_supply\_demand solver only. If specified (true), supply side actors are permuted for the demand combinations during MSDO optimization - note that this option increases optimization time significantly - use of 'max\_combinations' option is recommended to prevent prohibitively long runs. Supported values:
    • 'true': Generates sequences over supply side permutations if total supply is less than twice the total demand.
    • 'false': Permutations are not performed, rather a specific order of supplies based on capacity is computed.
    The default value is 'true'.
  • 'batch\_tsm\_mode': For the match\_supply\_demand solver only. When enabled, it sets the number of visits on each demand location by a single salesman at each trip is considered to be (one) 1, otherwise there is no bound. Supported values:
    • 'true': Sets only one visit per demand location by a salesman (TSM mode).
    • 'false': No preset limit (usual MSDO mode).
    The default value is 'false'.
  • 'round\_trip': For the match\_supply\_demand solver only. When enabled, the supply will have to return back to the origination location. Supported values:
    • 'true': The optimization is done for trips in round trip manner always returning to originating locations.
    • 'false': Supplies do not have to come back to their originating locations in their routes. The routes are considered finished at the final dropoff.
    The default value is 'true'.
  • 'num\_cycles': For the match\_clusters solver only. Terminates the cluster exchange iterations across 2-step-cycles (outer loop) when quality does not improve during iterations. The default value is '10'.
  • 'num\_loops\_per\_cycle': For the match\_clusters and match\_embedding solvers only. Terminates the cluster exchanges within the first step iterations of a cycle (inner loop) unless convergence is reached. The default value is '10'.
  • 'num\_output\_clusters': For the match\_clusters solver only. Limits the output to the top 'num\_output\_clusters' clusters based on density. Default value of zero outputs all clusters. The default value is '0'.
  • 'max\_num\_clusters': For the match\_clusters and match\_embedding solvers only. If set (value greater than zero), it terminates when the number of clusters goes below than this number. For embedding solver the default is 8. The default value is '0'.
  • 'cluster\_quality\_metric': For the match\_clusters solver only. The quality metric for Louvain modularity optimization solver. Supported values:
    • 'girvan': Uses the Newman Girvan quality metric for cluster solver.
    • 'spectral': Applies recursive spectral bisection (RSB) partitioning solver.
    The default value is 'girvan'.
  • 'restricted\_type': For the match\_supply\_demand solver only. Optimization is performed by restricting routes labeled by 'MSDO\_ODDEVEN\_RESTRICTED' only for this supply actor (truck) type. Supported values:
    • 'odd': Applies odd/even rule restrictions to odd tagged vehicles.
    • 'even': Applies odd/even rule restrictions to even tagged vehicles.
    • 'none': Does not apply odd/even rule restrictions to any vehicles.
    The default value is 'none'.
  • 'server\_id': Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. The default value is ''.
  • 'inverse\_solve': For the match\_batch\_solves solver only. Solves source-destination pairs using inverse shortest path solver. Supported values:
    • 'true': Solves using inverse shortest path solver.
    • 'false': Solves using direct shortest path solver.
    The default value is 'false'.
  • 'min\_loop\_level': For the match\_loops solver only. Finds closed loops around each node deducible not less than this minimal hop (level) deep. The default value is '0'.
  • 'max\_loop\_level': For the match\_loops solver only. Finds closed loops around each node deducible not more than this maximal hop (level) deep. The default value is '5'.
  • 'search\_limit': For the match\_loops solver only. Searches within this limit of nodes per vertex to detect loops. The value zero means there is no limit. The default value is '10000'.
  • 'output\_batch\_size': For the match\_loops solver only. Uses this value as the batch size of the number of loops in flushing(inserting) to the output table. The default value is '1000'.
  • 'multi\_step': For the match\_supply\_demand solver only. Runs multiple supply demand solver repeatedly in a multi step cycle by switching supplies to demands until it reaches the main hub supply. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'charging\_capacity': For the match\_charging\_stations solver only. This is the maximum ev-charging capacity of a vehicle (distance in meters or time in seconds depending on the unit of the graph weights). The default value is '300000.0'.
  • 'charging\_candidates': For the match\_charging\_stations solver only. Solver searches for this many number of stations closest around each base charging location found by capacity. The default value is '10'.
  • 'charging\_penalty': For the match\_charging\_stations solver only. This is the penalty for full charging. The default value is '30000.0'.
  • 'detour\_mark\_cost': For the match\_route\_detour solver only. Cost along the route at which to search for nearby stations If zero, it solves along the trip sliding the 3 SSSP cycle kernel by radius amount. The default value is '3600.0'.
  • 'detour\_reentry\_factor': For the match\_route\_detour solver only. Multiplier on detour\_mark\_cost to determine the reentry point on the route (default 1.2 means 20% further along). The default value is '1.2'.
  • 'detour\_search\_radius': For the match\_route\_detour solver only. Search radius around the mark point for finding nearby prospective stations (e.g. cafes, pit stops, EV charging stations). The default value is '600.0'.
  • 'detour\_search\_limit': For the match\_route\_detour solver only. Maximum number of nearby stations to consider within the search radius around the mark point. The default value is '10'.
  • 'max\_hops': For the match\_similarity and match\_embedding solvers only. Searches within this maximum hops for source and target node pairs to compute the Jaccard scores. The default value is '3'.
  • 'traversal\_node\_limit': For the match\_similarity solver only. Limits the traversal depth if it reaches this many number of nodes. The default value is '1000'.
  • 'paired\_similarity': For the match\_similarity solver only. If true, it computes Jaccard score between each pair, otherwise it will compute Jaccard from the intersection set between the source and target nodes. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'force\_undirected': For the match\_pattern and match\_embedding solvers only. Pattern matching will be using both pattern and graph as undirected if set to true. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'max\_vector\_dimension': For the match\_embedding solver only. Limits the number of dimensions in node vector embeddings. The default value is '1000'.
  • 'optimize\_embedding\_weights': For the match\_embedding solvers only. Solves to find the optimal weights per sub feature in vector embeddings. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'embedding\_weights': For the match\_embedding solver only. User specified weights per sub feature in vector embeddings. The string contains the comma separated float values for each sub-feature in the vector space. These values will ONLY be used if 'optimize\_embedding\_weights' is false. The default value is '1.0,1.0,1.0,1.0'.
  • 'optimization\_sampling\_size': For the match\_embedding solver only. Sets the number of random nodes from the graph for solving the weights using stochastic gradient descent. The default value is '1000'.
  • 'optimization\_max\_iterations': For the match\_embedding solver only. When the iterations (epochs) for the convergence of the stochastic gradient descent algorithm reaches this number it bails out unless relative error between consecutive iterations is below the 'optimization\_error\_tolerance' option. The default value is '1000'.
  • 'optimization\_error\_tolerance': For the match\_embedding solver only. When the relative error between all of the weights' consecutive iterations falls below this threshold the optimization cycle is interrupted unless the number of iterations reaches the limit set by the option 'max\_optimization\_iterations'. The default value is '0.001'.
  • 'optimization\_iteration\_rate': For the match\_embedding solver only. It is otherwise known as the learning rate, which is the proportionality constant in front of the gradient term in successive iterations. The default value is '0.3'.
  • 'max\_radius': For the match\_isochrone solver only. Sets the maximal reachability limit for computing isochrones. Zero means no limit. The default value is '0.0'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

match\_graph\_request(request, callback) → {"{"}Promise{"}"}

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.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

modify\_graph(graph\_name, nodes, edges, weights, restrictions, options, callback) → {"{"}Promise{"}"}

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.

Parameters:
Name Type Description
graph\_name String Name of the graph resource to modify.
nodes Array.\ Nodes with which to update existing nodes in graph specified by graph\_name. 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 Array.\ Edges with which to update existing edges in graph specified by graph\_name. 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 Array.\ Weights with which to update existing weights in graph specified by graph\_name. 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 Array.\ Restrictions with which to update existing restrictions in graph specified by graph\_name. 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 Object 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:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    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 GPUdb#create\_table\_monitor. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'graph\_table': If specified, the created graph is also created as a table with the given name, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. This table will have the 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:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    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'.
  • 'use\_rtree': Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'label\_delimiter': If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
  • 'allow\_multiple\_edges': Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'embedding\_table': If table exists (should be generated by the match/graph match\_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

modify\_graph\_request(request, callback) → {"{"}Promise{"}"}

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

query\_graph(graph\_name, queries, restrictions, adjacency\_table, rings, options, callback) → {"{"}Promise{"}"}

Employs a topological query on a graph generated a-priori by GPUdb#create\_graph 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 adjacency\_table empty.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Parameters:
Name Type Description
graph\_name String Name of the graph resource to query.
queries Array.\ 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 Array.\ 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 array ( \[] ).
adjacency\_table String Name of the table to store the resulting adjacencies, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If left blank, the query results are instead returned in the response. 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 Number 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 Object 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 graph\_name is directed and when querying nodes. Consult Directed Graphs for more details. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'limit': When specified (>0), limits the number of query results. The size of the nodes table will be limited by the limit value. The default value is '0'.
  • 'output\_wkt\_path': If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'server\_id': Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth.
  • 'output\_charn\_length': When specified (>0 and \<=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'.
  • 'find\_common\_labels': If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

query\_graph\_request(request, callback) → {"{"}Promise{"}"}

Employs a topological query on a graph generated a-priori by GPUdb#create\_graph 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 adjacency\_table empty.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

remove\_http\_header(header)

Removes the given HTTP header from the map of additional HTTP headers to send to GPUdb with each request. The user is not allowed to remove the following protected headers:
  • 'Accept'
  • 'Authorization'
  • 'Content-type'
  • 'X-Kinetica-Group'
Parameters:
Name Type Description
header String The header to remove.
Source:
  • ,

repartition\_graph(graph\_name, options, callback) → {"{"}Promise{"}"}

Rebalances an existing partitioned graph.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters:
Name Type Description
graph\_name String Name of the graph resource to rebalance.
options Object Optional parameters.
  • 'new\_graph\_name': If a non-empty value is specified, the original graph will be kept (non-default behavior) and a new balanced graph will be created under this given name. When the value is empty (default), the generated 'balanced' graph will replace the original 'unbalanced' graph under the same graph name. The default value is ''.
  • 'source\_node': The distributed shortest path solve is run from this source node to all the nodes in the graph to create balanced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

repartition\_graph\_request(request, callback) → {"{"}Promise{"}"}

Rebalances an existing partitioned graph.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

restore\_backup(backup\_name, restore\_objects\_map, datasource\_name, options, callback) → {"{"}Promise{"}"}

Restores database objects from a backup accessible via the data source specified by datasource\_name.
Parameters:
Name Type Description
backup\_name String Name of the backup to restore from, which must refer to an existing backup. The default value is ''.
restore\_objects\_map Object Map of database objects to be restored from the backup.
datasource\_name String Data source through which the backup will be restored.
options Object Optional parameters.
  • 'backup\_id': ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ''.
  • 'checksum': Whether or not to verify checksums for backup files when restoring. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'create\_schema\_if\_not\_exist': Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:
    • 'true': If the schema containing any restored object does not exist, create it automatically.
    • 'false': If the schema containing any restored object does not exist, return an error.
    The default value is 'true'.
  • 'ddl\_only': Behavior to apply when restoring tables. Supported values:
    • 'true': Restore table DDL, but do not restore data.
    • 'false': Restore tables and their data.
    The default value is 'false'.
  • 'dry\_run': Whether or not to perform a dry run of the restoration operation. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'restore\_subscriptions': Behavior to apply when restoring datasource subscriptions on tables. Supported values:
    • 'resume': Resume subscriptions that were active when the backup was made.
    • 'pause': Pause subscriptions that were active when the backup was made.
    • 'cancel': Cancel active subscriptions.
    The default value is 'resume'.
  • 'reingest': Behavior to apply when restoring table data. Supported values:
    • 'true': Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.
    • 'false': Restore the persisted data files directly.
    The default value is 'false'.
  • 'renamed\_objects\_schema': If the restore\_policy is rename, use this schema for relocated existing objects instead of the default generated one. The default value is ''.
  • 'restore\_policy': Behavior to apply when any database object to restore already exists. Supported values:
    • 'none': If an object to be restored already exists with the same name, abort and return error.
    • 'replace': If an object to be restored already exists with the same name, replace it with the backup version.
    • 'rename': If an object to be restored already exists with the same name, move that existing one to the schema specified by renamed\_objects\_schema. This policy does not apply to non-schema objects.
    The default value is 'none'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

restore\_backup\_request(request, callback) → {"{"}Promise{"}"}

Restores database objects from a backup accessible via the data source specified by datasource\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission(principal, object, object\_type, permission, options, callback) → {"{"}Promise{"}"}

Revoke user or role the specified permission on the specified object.
Parameters:
Name Type Description
principal String Name of the user or role for which the permission is being revoked. Must be an existing user or role. The default value is ''.
object String Name of object permission is being revoked from. It is recommended to use a fully-qualified name when possible.
object\_type String The type of object being revoked. Supported values:
  • 'catalog': Catalog
  • 'context': Context
  • 'credential': Credential
  • 'datasink': Data Sink
  • 'datasource': Data Source
  • 'directory': KIFS File Directory
  • 'graph': A Graph object
  • 'proc': UDF Procedure
  • 'schema': Schema
  • 'sql\_proc': SQL Procedure
  • 'system': System-level access
  • 'table': Database Table
  • 'table\_monitor': Table monitor
permission String Permission being revoked. Supported values:
  • 'admin': Full read/write and administrative access on the object.
  • 'connect': Connect access on the given data source or data sink.
  • 'create': Ability to create new objects of this type.
  • 'delete': Delete rows from tables.
  • 'execute': Ability to Execute the Procedure object.
  • 'insert': Insert access to tables.
  • 'monitor': Monitor logs and statistics.
  • 'read': Ability to read, list and use the object.
  • 'send\_alert': Ability to send system alerts.
  • 'update': Update access to the table.
  • 'user\_admin': Access to administer users and roles that do not have system\_admin permission.
  • 'write': Access to write, change and delete objects.
options Object Optional parameters.
  • 'columns': Revoke table security from these columns, comma-separated. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_credential(name, permission, credential\_name, options, callback) → {"{"}Promise{"}"}

Revokes a credential-level permission from a user or role.
Parameters:
Name Type Description
name String Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission String Permission to revoke from the user or role. Supported values:
  • 'credential\_admin': Full read/write and administrative access on the credential.
  • 'credential\_read': Ability to read and use the credential.
credential\_name String Name of the credential on which the permission will be revoked. Must be an existing credential, or an empty string to revoke access on all credentials.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_credential\_request(request, callback) → {"{"}Promise{"}"}

Revokes a credential-level permission from a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_datasource(name, permission, datasource\_name, options, callback) → {"{"}Promise{"}"}

Revokes a data source permission from a user or role.
Parameters:
Name Type Description
name String Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission String Permission to revoke from the user or role. Supported values:
  • 'admin': Admin access on the given data source.
  • 'connect': Connect access on the given data source.
datasource\_name String Name of the data source on which the permission will be revoked. Must be an existing data source, or an empty string to revoke permission from all data sources.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_datasource\_request(request, callback) → {"{"}Promise{"}"}

Revokes a data source permission from a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_directory(name, permission, directory\_name, options, callback) → {"{"}Promise{"}"}

Revokes a KiFS directory-level permission from a user or role.
Parameters:
Name Type Description
name String Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission String Permission to revoke from the user or role. Supported values:
  • 'directory\_read': For files in the directory, access to list files, download files, or use files in server side functions.
  • 'directory\_write': Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access.
directory\_name String Name of the KiFS directory to which the permission revokes access.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_directory\_request(request, callback) → {"{"}Promise{"}"}

Revokes a KiFS directory-level permission from a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_proc(name, permission, proc\_name, options, callback) → {"{"}Promise{"}"}

Revokes a proc-level permission from a user or role.
Parameters:
Name Type Description
name String Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission String Permission to revoke from the user or role. Supported values:
  • 'proc\_admin': Admin access to the proc.
  • 'proc\_execute': Execute access to the proc.
proc\_name String 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 Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_proc\_request(request, callback) → {"{"}Promise{"}"}

Revokes a proc-level permission from a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_request(request, callback) → {"{"}Promise{"}"}

Revoke user or role the specified permission on the specified object.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_system(name, permission, options, callback) → {"{"}Promise{"}"}

Revokes a system-level permission from a user or role.
Parameters:
Name Type Description
name String Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission String 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.
  • 'system\_send\_alert': Send system alerts.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_system\_request(request, callback) → {"{"}Promise{"}"}

Revokes a system-level permission from a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_table(name, permission, table\_name, options, callback) → {"{"}Promise{"}"}

Revokes a table-level permission from a user or role.
Parameters:
Name Type Description
name String Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission String 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.
table\_name String Name of the table to which the permission grants access, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table, view or schema.
options Object Optional parameters.
  • 'columns': Apply security to these columns, comma-separated. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_permission\_table\_request(request, callback) → {"{"}Promise{"}"}

Revokes a table-level permission from a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_role(role, member, options, callback) → {"{"}Promise{"}"}

Revokes membership in a role from a user or role.
Parameters:
Name Type Description
role String Name of the role in which membership will be revoked. Must be an existing role.
member String Name of the user or role that will be revoked membership in role. Must be an existing user or role.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

revoke\_role\_request(request, callback) → {"{"}Promise{"}"}

Revokes membership in a role from a user or role.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_backup(backup\_name, datasource\_name, options, callback) → {"{"}Promise{"}"}

Shows information about one or more backups accessible via the data source specified by datasource\_name.
Parameters:
Name Type Description
backup\_name String Name of the backup. An empty string or '\*' will show all existing backups. Any text followed by a '\*' will show backups whose name starts with that text. The default value is ''.
datasource\_name String Data source through which the backup is accessible.
options Object Optional parameters.
  • 'backup\_id': ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ''.
  • 'backup\_type': Show backups by type. This option is ignored if backup\_id is non-empty. Supported values:
    • 'all': Show all backup types.
    • 'full': Show full backups only.
    • 'incremental': Show incremental backups only.
    • 'differential': Show differential backups only.
    The default value is 'all'.
  • 'show\_contents': Show the contents of the backed-up snapshots. Supported values:
    • 'none': Don't show snapshot contents.
    • 'object\_names': Show backed-up object names, and for tables, sizing detail.
    • 'object\_files': Show backed-up object names, and for tables, sizing detail and associated files.
    The default value is 'none'.
  • 'no\_error\_if\_not\_exists': Whether or not to suppress the error if the specified backup does not exist. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_backup\_request(request, callback) → {"{"}Promise{"}"}

Shows information about one or more backups accessible via the data source specified by datasource\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_credential(credential\_name, options, callback) → {"{"}Promise{"}"}

Shows information about a specified credential or all credentials.
Parameters:
Name Type Description
credential\_name String Name of the credential on which to retrieve information. The name must refer to a currently existing credential. If '\*' is specified, information about all credentials will be returned.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_credential\_request(request, callback) → {"{"}Promise{"}"}

Shows information about a specified credential or all credentials.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_datasink(name, options, callback) → {"{"}Promise{"}"}

Shows information about a specified data sink or all data sinks.
Parameters:
Name Type Description
name String Name of the data sink for which to retrieve information. The name must refer to a currently existing data sink. If '\*' is specified, information about all data sinks will be returned.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_datasink\_request(request, callback) → {"{"}Promise{"}"}

Shows information about a specified data sink or all data sinks.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_datasource(name, options, callback) → {"{"}Promise{"}"}

Shows information about a specified data source or all data sources.
Parameters:
Name Type Description
name String Name of the data source for which to retrieve information. The name must refer to a currently existing data source. If '\*' is specified, information about all data sources will be returned.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_datasource\_request(request, callback) → {"{"}Promise{"}"}

Shows information about a specified data source or all data sources.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_directories(directory\_name, options, callback) → {"{"}Promise{"}"}

Shows information about directories in KiFS. Can be used to show a single directory, or all directories.
Parameters:
Name Type Description
directory\_name String The KiFS directory name to show. If empty, shows all directories. The default value is ''.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_directories\_request(request, callback) → {"{"}Promise{"}"}

Shows information about directories in KiFS. Can be used to show a single directory, or all directories.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_environment(environment\_name, options, callback) → {"{"}Promise{"}"}

Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.
Parameters:
Name Type Description
environment\_name String Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If '\*' or an empty value is specified, information about all environments will be returned. The default value is ''.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If true and if the environment specified in environment\_name does not exist, no error is returned. If false and if the environment specified in environment\_name does not exist, then an error is returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'show\_names\_only': If true only return the names of the installed environments and omit package listing. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_environment\_request(request, callback) → {"{"}Promise{"}"}

Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_files(paths, options, callback) → {"{"}Promise{"}"}

Shows information about files in KiFS. Can be used for individual files, or to show all files in a given directory.
Parameters:
Name Type Description
paths Array.\ File paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. File paths may contain wildcard characters after the KiFS directory delimiter. Accepted wildcard characters are asterisk (\*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_files\_request(request, callback) → {"{"}Promise{"}"}

Shows information about files in KiFS. Can be used for individual files, or to show all files in a given directory.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_graph(graph\_name, options, callback) → {"{"}Promise{"}"}

Shows information and characteristics of graphs that exist on the graph server.
Parameters:
Name Type Description
graph\_name String 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 Object 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:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'server\_id': Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
  • 'export\_graph\_schema': If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key 'dot'. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_graph\_request(request, callback) → {"{"}Promise{"}"}

Shows information and characteristics of graphs that exist on the graph server.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_proc(proc\_name, options, callback) → {"{"}Promise{"}"}

Shows information about a proc.
Parameters:
Name Type Description
proc\_name String 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 Object Optional parameters.
  • 'include\_files': If set to true, the files that make up the proc will be returned. If set to false, the files will not be returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_proc\_request(request, callback) → {"{"}Promise{"}"}

Shows information about a proc.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_proc\_status(run\_id, options, callback) → {"{"}Promise{"}"}

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from GPUdb#execute\_proc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
Parameters:
Name Type Description
run\_id String 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 Object Optional parameters.
  • 'clear\_complete': If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'run\_tag': If run\_id is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to GPUdb#execute\_proc. If run\_id is not specified, return statuses for all proc instances where a matching run tag was provided to GPUdb#execute\_proc. The default value is ''.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_proc\_status\_request(request, callback) → {"{"}Promise{"}"}

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from GPUdb#execute\_proc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_resource\_groups(names, options, callback) → {"{"}Promise{"}"}

Requests resource group properties. Returns detailed information about the requested resource groups.
Parameters:
Name Type Description
names Array.\ List of names of groups to be shown. A single entry with an empty string returns all groups.
options Object Optional parameters.
  • 'show\_default\_values': If true include values of fields that are based on the default resource group. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'show\_default\_group': If true include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'show\_tier\_usage': If true include the resource group usage on the worker ranks in the response. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_resource\_groups\_request(request, callback) → {"{"}Promise{"}"}

Requests resource group properties. Returns detailed information about the requested resource groups.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_resource\_objects(options, callback) → {"{"}Promise{"}"}

Returns information about the internal sub-components (tiered objects) which use resources of the system. The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.
Parameters:
Name Type Description
options Object Optional parameters.
  • 'tiers': Comma-separated list of tiers to query, leave blank for all tiers.
  • 'expression': An expression to filter the returned objects. Expression is limited to the following operators: =,!=,\<,\<=,>,>=,+,-,\*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki\_catalog.ki\_tiered\_objects table directly.
  • 'order\_by': Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
    • 'size'
    • 'id'
    • 'priority'
    • 'tier'
    • 'evictable'
    • 'locked'
    • 'pin\_count'
    • 'ram\_evictions'
    • 'persist\_evictions'
    • 'owner\_resource\_group'
  • 'limit': An integer indicating the maximum number of results to be returned, per rank, or (-1) 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. The default value is '100'.
  • 'table\_names': Comma-separated list of tables to restrict the results to. Use '\*' to show all tables.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_resource\_objects\_request(request, callback) → {"{"}Promise{"}"}

Returns information about the internal sub-components (tiered objects) which use resources of the system. The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_resource\_statistics(options, callback) → {"{"}Promise{"}"}

Requests various statistics for storage/memory tiers and resource groups. Returns statistics on a per-rank basis.
Parameters:
Name Type Description
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_resource\_statistics\_request(request, callback) → {"{"}Promise{"}"}

Requests various statistics for storage/memory tiers and resource groups. Returns statistics on a per-rank basis.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_schema(schema\_name, options, callback) → {"{"}Promise{"}"}

Retrieves information about a schema (or all schemas), as specified in schema\_name.
Parameters:
Name Type Description
schema\_name String Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If false will return an error if the provided schema\_name does not exist. If true then it will return an empty result if the provided schema\_name does not exist. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_schema\_request(request, callback) → {"{"}Promise{"}"}

Retrieves information about a schema (or all schemas), as specified in schema\_name.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_security(names, options, callback) → {"{"}Promise{"}"}

Shows security information relating to users and/or roles. If the caller is not a system administrator, only information relating to the caller and their roles is returned.
Parameters:
Name Type Description
names Array.\ 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 Object Optional parameters.
  • 'show\_current\_user': If true, returns only security information for the current user. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_security\_request(request, callback) → {"{"}Promise{"}"}

Shows security information relating to users and/or roles. If the caller is not a system administrator, only information relating to the caller and their roles is returned.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_sql\_proc(procedure\_name, options, callback) → {"{"}Promise{"}"}

Shows information about SQL procedures, including the full definition of each requested procedure.
Parameters:
Name Type Description
procedure\_name String Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''.
options Object 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:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_sql\_proc\_request(request, callback) → {"{"}Promise{"}"}

Shows information about SQL procedures, including the full definition of each requested procedure.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_statistics(table\_names, options, callback) → {"{"}Promise{"}"}

Retrieves the collected column statistics for the specified table(s).
Parameters:
Name Type Description
table\_names Array.\ Names of tables whose metadata will be fetched, each in \[schema\_name.]table\_name format, using standard name resolution rules. All provided tables must exist, or an error is returned. A single entry of '\*' expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.
options Object Optional parameters.
  • 'no\_error\_if\_not\_exists': If true and if the table names specified in table\_names does not exist, no error is returned. If false and if the table names specified in table\_names does not exist, then an error is returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'column\_names': Columns, per table in table\_names, to collect statistics for when @{"{"}input.key options.collect\_now{"}"} is true; ignored otherwise. Encoded as a ';'-separated parallel array aligned with table\_names (e.g. 'x,y;z' requests columns x,y for the first table and z for the second). A value of '\*' expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a '\*' table\_names wildcard. The default value is ''.
  • 'collect\_now': If true, the columns named by @{"{"}input.key options.column\_names{"}"} are collected synchronously during this request and reflected in the response. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_statistics\_request(request, callback) → {"{"}Promise{"}"}

Retrieves the collected column statistics for the specified table(s).
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_system\_properties(options, callback) → {"{"}Promise{"}"}

Returns server configuration and version related information to the caller. The admin tool uses it to present server related information to the user.
Parameters:
Name Type Description
options Object Optional parameters.
  • 'properties': A list of comma separated names of properties requested. If not specified, all properties will be returned.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_system\_properties\_request(request, callback) → {"{"}Promise{"}"}

Returns server configuration and version related information to the caller. The admin tool uses it to present server related information to the user.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_system\_status(options, callback) → {"{"}Promise{"}"}

Provides server configuration and health related status to the caller. The admin tool uses it to present server related information to the user.
Parameters:
Name Type Description
options Object Optional parameters, currently unused. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_system\_status\_request(request, callback) → {"{"}Promise{"}"}

Provides server configuration and health related status to the caller. The admin tool uses it to present server related information to the user.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_system\_timing(options, callback) → {"{"}Promise{"}"}

Returns the last 100 database requests along with the request timing and internal job ID. The admin tool uses it to present request timing information to the user.
Parameters:
Name Type Description
options Object Optional parameters, currently unused. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_system\_timing\_request(request, callback) → {"{"}Promise{"}"}

Returns the last 100 database requests along with the request timing and internal job ID. The admin tool uses it to present request timing information to the user.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_table(table\_name, options, callback) → {"{"}Promise{"}"}

Retrieves detailed information about a table, view, or schema, specified in table\_name. If the supplied table\_name is a schema the call can return information about either the schema itself or the tables and views it contains. If table\_name is empty, information about all schemas will be returned.

If the option get\_sizes is set to true, then the number of records in each table is returned (in sizes and full\_sizes), along with the total number of objects across all requested tables (in total\_size and total\_full\_size).

For a schema, setting the show\_children option to false returns only information about the schema itself; setting show\_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.

To retrieve a list of every table, view, and schema in the database, set table\_name to '\*' and show\_children to true. When doing this, the returned total\_size and total\_full\_size will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Parameters:
Name Type Description
table\_name String Name of the table for which to retrieve the information, in \[schema\_name.]table\_name format, using standard name resolution rules. If blank, then returns information about all tables and views.
options Object Optional parameters.
  • 'dependencies': Include view dependencies in the output. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'force\_synchronous': If true then the table sizes will wait for read lock before returning. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'get\_access\_data': If true then data about the last read, write, alter and create will be returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'get\_cached\_sizes': If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occurring. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'get\_sizes': If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'referencing\_materialized\_views': Include materialized views using this table as a source in the output. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'skip\_additional\_info': If true then the response will not populate the additional\_info field. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'no\_error\_if\_not\_exists': If false will return an error if the provided table\_name does not exist. If true then it will return an empty result. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'skip\_temp\_schemas': If true then the table list will not include tables from SYS\_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'show\_children': If table\_name is a schema, then true will return information about the tables and views in the schema, and false will return information about the schema itself. If table\_name is a table or view, show\_children must be false. If table\_name is empty, then show\_children must be true. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'get\_column\_info': If true then column info (memory usage, etc) will be returned. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_table\_metadata(table\_names, options, callback) → {"{"}Promise{"}"}

Retrieves the user provided metadata for the specified tables.
Parameters:
Name Type Description
table\_names Array.\ Names of tables whose metadata will be fetched, in \[schema\_name.]table\_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_table\_metadata\_request(request, callback) → {"{"}Promise{"}"}

Retrieves the user provided metadata for the specified tables.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_table\_monitors(monitor\_ids, options, callback) → {"{"}Promise{"}"}

Show table monitors and their properties. Table monitors are created using GPUdb#create\_table\_monitor. Returns detailed information about existing table monitors.
Parameters:
Name Type Description
monitor\_ids Array.\ List of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_table\_monitors\_request(request, callback) → {"{"}Promise{"}"}

Show table monitors and their properties. Table monitors are created using GPUdb#create\_table\_monitor. Returns detailed information about existing table monitors.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_table\_request(request, callback) → {"{"}Promise{"}"}

Retrieves detailed information about a table, view, or schema, specified in table\_name. If the supplied table\_name is a schema the call can return information about either the schema itself or the tables and views it contains. If table\_name is empty, information about all schemas will be returned.

If the option get\_sizes is set to true, then the number of records in each table is returned (in sizes and full\_sizes), along with the total number of objects across all requested tables (in total\_size and total\_full\_size).

For a schema, setting the show\_children option to false returns only information about the schema itself; setting show\_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.

To retrieve a list of every table, view, and schema in the database, set table\_name to '\*' and show\_children to true. When doing this, the returned total\_size and total\_full\_size will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_tables\_by\_type(type\_id, label, options, callback) → {"{"}Promise{"}"}

Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
Parameters:
Name Type Description
type\_id String Type id returned by a call to GPUdb#create\_type.
label String Optional user supplied label which can be used instead of the type\_id to retrieve all tables with the given label.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_tables\_by\_type\_request(request, callback) → {"{"}Promise{"}"}

Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_triggers(trigger\_ids, options, callback) → {"{"}Promise{"}"}

Retrieves information regarding the specified triggers or all existing triggers currently active.
Parameters:
Name Type Description
trigger\_ids Array.\ 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 Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_triggers\_request(request, callback) → {"{"}Promise{"}"}

Retrieves information regarding the specified triggers or all existing triggers currently active.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_types(type\_id, label, options, callback) → {"{"}Promise{"}"}

Retrieves information for the specified data type ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
Parameters:
Name Type Description
type\_id String Type Id returned in response to a call to GPUdb#create\_type.
label String Option string that was supplied by user in a call to GPUdb#create\_type.
options Object Optional parameters.
  • 'no\_join\_types': When set to 'true', no join types will be included. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_types\_request(request, callback) → {"{"}Promise{"}"}

Retrieves information for the specified data type ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_video(paths, options, callback) → {"{"}Promise{"}"}

Retrieves information about rendered videos.
Parameters:
Name Type Description
paths Array.\ The fully-qualified KiFS paths for the videos to show. If empty, shows all videos.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_video\_request(request, callback) → {"{"}Promise{"}"}

Retrieves information about rendered videos.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_wal(table\_names, options, callback) → {"{"}Promise{"}"}

Requests table write-ahead log (WAL) properties. Returns information about the requested table WAL entries.
Parameters:
Name Type Description
table\_names Array.\ List of tables to query. An asterisk returns all tables.
options Object Optional parameters.
  • 'show\_settings': If true include a map of the WAL settings for the requested tables. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

show\_wal\_request(request, callback) → {"{"}Promise{"}"}

Requests table write-ahead log (WAL) properties. Returns information about the requested table WAL entries.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

solve\_graph(graph\_name, weights\_on\_edges, restrictions, solver\_type, source\_nodes, destination\_nodes, solution\_table, options, callback) → {"{"}Promise{"}"}

Solves an existing graph for a type of problem (e.g., shortest path, page rank, traveling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.

Parameters:
Name Type Description
graph\_name String Name of the graph resource to solve.
weights\_on\_edges Array.\ 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 array ( \[] ).
restrictions Array.\ 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 option is set to true, any provided restrictions will replace the existing restrictions. Otherwise, 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 array ( \[] ).
solver\_type String 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 traveling 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 should be >= shortest\_path cost.
  • 'STATS\_ALL': Solves for graph statistics such as graph diameter, longest pairs, vertex valences, topology numbers, average and max cluster sizes, etc.
  • 'CLOSENESS': Solves for the centrality closeness score per node as the sum of the inverse shortest path costs to all nodes in the graph.
The default value is 'SHORTEST\_PATH'.
source\_nodes Array.\ 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 array ( \[] ).
destination\_nodes Array.\ 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 array ( \[] ).
solution\_table String Name of the table to store the solution, in \[schema\_name.]table\_name format, using standard name resolution rules. The default value is 'graph\_solutions'.
options Object Additional parameters.
  • 'max\_solution\_radius': For ALLPATHS, SHORTEST\_PATH and INVERSE\_SHORTEST\_PATH solvers only. Sets the maximum solution cost radius, which ignores the destination\_nodes 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 ALLPATHS, 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 destination\_nodes 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 ALLPATHS, SHORTEST\_PATH and INVERSE\_SHORTEST\_PATH solvers only. Sets the maximum number of solution targets, which ignores the destination\_nodes 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 '1000'.
  • 'uniform\_weights': When specified, assigns the given value to all the edges in the graph. Note that weights provided in weights\_on\_edges will override this value.
  • 'left\_turn\_penalty': This will add an additional weight over the edges labeled as 'left turn' if the 'add\_turn' option parameter of the GPUdb#create\_graph was invoked at graph creation. The default value is '0.0'.
  • 'right\_turn\_penalty': This will add an additional weight over the edges labeled as' right turn' if the 'add\_turn' option parameter of the GPUdb#create\_graph was invoked at graph creation. The default value is '0.0'.
  • 'intersection\_penalty': This will add an additional weight over the edges labeled as 'intersection' if the 'add\_turn' option parameter of the GPUdb#create\_graph was invoked at graph creation. The default value is '0.0'.
  • 'sharp\_turn\_penalty': This will add an additional weight over the edges labeled as 'sharp turn' or 'u-turn' if the 'add\_turn' option parameter of the GPUdb#create\_graph 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'.
  • '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:
    • 'true'
    • 'false'
    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:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'server\_id': Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. For SHORTEST\_PATH solver type, the input is split amongst the server containing the corresponding graph.
  • 'convergence\_limit': For PAGE\_RANK solvers only; Maximum percent relative threshold on the page rank scores of each node between consecutive iterations to satisfy convergence. Default value is 1 (one) percent. The default value is '1.0'.
  • 'max\_iterations': For PAGE\_RANK solvers only; Maximum number of page rank iterations for satisfying convergence. Default value is 100. The default value is '100'.
  • 'max\_runs': For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph. Default value of 0 enables this value to be auto computed by the solver. The default value is '0'.
  • 'output\_clusters': For STATS\_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output. Supported values:
    • 'true': An additional column 'CLUSTER' will be added for each node.
    • 'false': No extra cluster info per node will be available in the output.
    The default value is 'false'.
  • 'solve\_heuristic': Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target. Supported values:
    • 'astar': Employs A-STAR heuristics to speed up the shortest path traversal.
    • 'none': No heuristics are applied.
    The default value is 'none'.
  • 'astar\_radius': For path solvers only when 'solve\_heuristic' option is 'astar'. The shortest path traversal front includes nodes only within this radius (kilometers) as it moves towards the target location. The default value is '70'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

solve\_graph\_request(request, callback) → {"{"}Promise{"}"}

Solves an existing graph for a type of problem (e.g., shortest path, page rank, traveling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

submit\_request(endpoint, request, callbackopt) → {"{"}Promise{"}"}

Submits an arbitrary request to GPUdb. The response will be returned via the specified callback function, or via a promise if no callback function is provided.
Parameters:
Name Type Attributes Description
endpoint String The endpoint to which to submit the request.
request Object The request object to submit.
callback GPUdbCallback \
 The callback function.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

update\_records(table\_name, expressions, new\_values\_maps, data, options, callback) → {"{"}Promise{"}"}

Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record's column values will be updated as provided in new\_values\_maps. 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 result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

The update\_on\_existing\_pk option specifies the record primary key collision policy for tables with a primary key, while ignore\_existing\_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.

Parameters:
Name Type Description
table\_name String Name of table to be updated, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table and not a view.
expressions Array.\ A list of the actual predicates, one for each update; format should follow the guidelines here.
new\_values\_maps Array.\ 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 Array.\ An optional list of JSON encoded objects to insert, one for each update, to be added if the particular update did not match any objects. The default value is an empty array ( \[] ).
options Object Optional parameters.
  • 'global\_expression': An optional global expression to reduce the search space of the predicates listed in expressions. The default value is ''.
  • 'bypass\_safety\_checks': When set to true, all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'update\_on\_existing\_pk': Specifies the record collision policy for updating a table with a primary key. There are two ways that a record collision can occur. The first is an "update collision", which happens when the update changes the value of the updated record's primary key, and that new primary key already exists as the primary key of another record in the table. The second is an "insert collision", which occurs when a given filter in expressions finds no records to update, and the alternate insert record given in records\_to\_insert (or records\_to\_insert\_str) contains a primary key matching that of an existing record in the table. If update\_on\_existing\_pk is set to true, "update collisions" will result in the existing record collided into being removed and the record updated with values specified in new\_values\_maps taking its place; "insert collisions" will result in the collided-into record being updated with the values in records\_to\_insert / records\_to\_insert\_str (if given). If set to false, the existing collided-into record will remain unchanged, while the update will be rejected and the error handled as determined by ignore\_existing\_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
    • 'true': Overwrite the collided-into record when updating a record's primary key or inserting an alternate record causes a primary key collision between the record being updated/inserted and another existing record in the table
    • 'false': Reject updates which cause primary key collisions between the record being updated/inserted and an existing record in the table
    The default value is 'false'.
  • 'ignore\_existing\_pk': Specifies the record collision error-suppression policy for updating a table with a primary key, only used when primary key record collisions are rejected (update\_on\_existing\_pk is false). If set to true, any record update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update\_on\_existing\_pk is true, then this option has no effect. Supported values:
    • 'true': Ignore updates that result in primary key collisions with existing records.
    • 'false': Treat as errors any updates that result in primary key collisions with existing records.
    The default value is 'false'.
  • 'update\_partition': Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'enable\_inplace\_updates': If set to true, qualifying records are modified in place. If set to false, they are updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'truncate\_strings': If set to true, any strings which are too long for their charN string fields will be truncated to fit. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'use\_expressions\_in\_new\_values\_maps': When set to true, all new values in new\_values\_maps are considered as expression values. When set to false, all new values in new\_values\_maps are considered as constants. NOTE: When true, string constants will need to be quoted to avoid being evaluated as expressions. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
  • 'record\_id': ID of a single record to be updated (returned in the call to GPUdb#insert\_records or GPUdb#get\_records\_from\_collection).
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

update\_records\_request(request, callback) → {"{"}Promise{"}"}

Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record's column values will be updated as provided in new\_values\_maps. 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 result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

The update\_on\_existing\_pk option specifies the record primary key collision policy for tables with a primary key, while ignore\_existing\_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

upload\_files(file\_names, file\_data, options, callback) → {"{"}Promise{"}"}

Uploads one or more files to KiFS. There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommended for files of approximately 60 MB or larger.

To upload files in their entirety, populate file\_names with the file names to upload into on KiFS, and their respective byte content in file\_data.

Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:

1. Provide the file name in file\_names, the UUID in the multipart\_upload\_uuid key in options, and a multipart\_operation value of init.

2. Upload one or more parts by providing the file name, the part data in file\_data, the UUID, a multipart\_operation value of upload\_part, and the part number in the multipart\_upload\_part\_number. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.

3. Complete the upload by providing the file name, the UUID, and a multipart\_operation value of complete.

Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart\_operation value of cancel. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.

The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in GPUdb#show\_files.

File data may be pre-encoded using base64 encoding. This should be indicated using the file\_encoding option, and is recommended when using JSON serialization.

Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in GPUdb#show\_directories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are delineated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.

These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '\[' ']' '(' ')' '#' '='.

Parameters:
Name Type Description
file\_names Array.\ An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.
file\_data Array.\ File data for the files being uploaded, for the respective files in file\_names.
options Object Optional parameters.
  • 'file\_encoding': Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. The caller is responsible for encoding the data provided in this payload. Supported values:
    • 'base64': Specifies that the file data being uploaded has been base64 encoded.
    • 'none': The uploaded file data has not been encoded.
    The default value is 'none'.
  • 'multipart\_operation': Multipart upload operation to perform. Supported values:
    • 'none': Default, indicates this is not a multipart upload.
    • 'init': Initialize a multipart file upload.
    • 'upload\_part': Uploads a part of the specified multipart file upload.
    • 'complete': Complete the specified multipart file upload.
    • 'cancel': Cancel the specified multipart file upload.
    The default value is 'none'.
  • 'multipart\_upload\_uuid': UUID to uniquely identify a multipart upload.
  • 'multipart\_upload\_part\_number': Incremental part number for each part in a multipart upload. Part numbers start at 1, increment by 1, and must be uploaded sequentially
  • 'delete\_if\_exists': If true, any existing files specified in file\_names will be deleted prior to start of upload. Otherwise the file is replaced once the upload completes. Rollback of the original file is no longer possible if the upload is cancelled, aborted or fails if the file was deleted beforehand. Supported values:
    • 'true'
    • 'false'
    The default value is 'false'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

upload\_files\_fromurl(file\_names, urls, options, callback) → {"{"}Promise{"}"}

Uploads one or more files to KiFS.

Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in GPUdb#show\_directories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are delineated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.

These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '\[' ']' '(' ')' '#' '='.

Parameters:
Name Type Description
file\_names Array.\ An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.
urls Array.\ List of URLs to upload, for each respective file in file\_names.
options Object Optional parameters. The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

upload\_files\_fromurl\_request(request, callback) → {"{"}Promise{"}"}

Uploads one or more files to KiFS.

Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in GPUdb#show\_directories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are delineated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.

These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '\[' ']' '(' ')' '#' '='.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

upload\_files\_request(request, callback) → {"{"}Promise{"}"}

Uploads one or more files to KiFS. There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommended for files of approximately 60 MB or larger.

To upload files in their entirety, populate file\_names with the file names to upload into on KiFS, and their respective byte content in file\_data.

Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:

1. Provide the file name in file\_names, the UUID in the multipart\_upload\_uuid key in options, and a multipart\_operation value of init.

2. Upload one or more parts by providing the file name, the part data in file\_data, the UUID, a multipart\_operation value of upload\_part, and the part number in the multipart\_upload\_part\_number. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.

3. Complete the upload by providing the file name, the UUID, and a multipart\_operation value of complete.

Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart\_operation value of cancel. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.

The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in GPUdb#show\_files.

File data may be pre-encoded using base64 encoding. This should be indicated using the file\_encoding option, and is recommended when using JSON serialization.

Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in GPUdb#show\_directories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are delineated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.

These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '\[' ']' '(' ')' '#' '='.

Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

verify\_backup(backup\_name, datasource\_name, options, callback) → {"{"}Promise{"}"}

Inspects the requested database backup(s) for conformity at the remote file store accessible via the data source specified by datasource\_name. By default all snapshots are inspected unless the option backup\_id is used to target a specific instance. Returns backup verification results.
Parameters:
Name Type Description
backup\_name String Name of the backup. An empty string or '\*' will check all existing backups. Any text followed by a '\*' will inspect backups whose name starts with that text. The default value is ''.
datasource\_name String Data source through which the backup is accessible.
options Object Optional parameters.
  • 'backup\_id': ID of the snapshot to verify. Set to '-1' to verify all snapshots in the backup. Leave empty to verify only the most recent snapshot. The default value is '-1'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

verify\_backup\_request(request, callback) → {"{"}Promise{"}"}

Inspects the requested database backup(s) for conformity at the remote file store accessible via the data source specified by datasource\_name. By default all snapshots are inspected unless the option backup\_id is used to target a specific instance. Returns backup verification results.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

visualize\_image\_chart(table\_name, x\_column\_names, y\_column\_names, min\_x, max\_x, min\_y, max\_y, width, height, bg\_color, style\_options, options, callback) → {"{"}Promise{"}"}

Scatter plot is the only plot type currently supported. A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the image\_data field.
Parameters:
Name Type Description
table\_name String Name of the table containing the data to be drawn as a chart, in \[schema\_name.]table\_name format, using standard name resolution rules.
x\_column\_names Array.\ Names of the columns containing the data mapped to the x axis of a chart.
y\_column\_names Array.\ Names of the columns containing the data mapped to the y axis of a chart.
min\_x Number 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.
max\_x Number 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.
min\_y Number 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.
max\_y Number 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 Number Width of the generated image in pixels.
height Number Height of the generated image in pixels.
bg\_color String Background color of the generated image.
style\_options Object Rendering style options for a chart.
  • 'pointcolor': The color of points in the plot represented as a hexadecimal number. The default value is '0000FF'.
  • 'pointsize': The size of points in the plot represented as number of pixels. The default value is '3'.
  • 'pointshape': The shape of points in the plot. Supported values:
    • 'none'
    • 'circle'
    • 'square'
    • 'diamond'
    • 'hollowcircle'
    • 'hollowsquare'
    • 'hollowdiamond'
    The default value is 'square'.
  • 'cb\_pointcolors': Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values. This option overrides the pointcolor option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point color values are separated by cb\_delimiter, e.g. {"{"}"price", "20:30;30:40;40:50", "0xFF0000;0x00FF00;0x0000FF"{"}"}.
  • 'cb\_pointsizes': Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values. This option overrides the pointsize option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point size values are separated by cb\_delimiter, e.g. {"{"}"states", "NY;TX;CA", "3;5;7"{"}"}.
  • 'cb\_pointshapes': Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names. This option overrides the pointshape option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point shape names are separated by cb\_delimiter, e.g. {"{"}"states", "NY;TX;CA", "circle;square;diamond"{"}"}.
  • 'cb\_delimiter': A character or string which separates per-class values in a class-break style option string. The default value is ';'.
  • 'x\_order\_by': An expression or aggregate expression by which non-numeric x column values are sorted, e.g. "avg(price) descending".
  • 'y\_order\_by': An expression or aggregate expression by which non-numeric y column values are sorted, e.g. "avg(price)", which defaults to "avg(price) ascending".
  • 'scale\_type\_x': Type of x axis scale. Supported values:
    • 'none': No scale is applied to the x axis.
    • 'log': A base-10 log scale is applied to the x axis.
    The default value is 'none'.
  • 'scale\_type\_y': Type of y axis scale. Supported values:
    • 'none': No scale is applied to the y axis.
    • 'log': A base-10 log scale is applied to the y axis.
    The default value is 'none'.
  • 'min\_max\_scaled': If this options is set to false, this endpoint expects request's min/max values are not yet scaled. They will be scaled according to scale\_type\_x or scale\_type\_y for response. If this options is set to true, this endpoint expects request's min/max values are already scaled according to scale\_type\_x/scale\_type\_y. Response's min/max values will be equal to request's min/max values. The default value is 'false'.
  • 'jitter\_x': Amplitude of horizontal jitter applied to non-numeric x column values. The default value is '0.0'.
  • 'jitter\_y': Amplitude of vertical jitter applied to non-numeric y column values. The default value is '0.0'.
  • 'plot\_all': If this options is set to true, all non-numeric column values are plotted ignoring min\_x, max\_x, min\_y and max\_y parameters. The default value is 'false'.
options Object 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.
    The default value is 'none'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

visualize\_image\_chart\_request(request, callback) → {"{"}Promise{"}"}

Scatter plot is the only plot type currently supported. A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the image\_data field.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

visualize\_isochrone(graph\_name, source\_node, max\_solution\_radius, weights\_on\_edges, restrictions, num\_levels, generate\_image, levels\_table, style\_options, solve\_options, contour\_options, options, callback) → {"{"}Promise{"}"}

Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.
Parameters:
Name Type Description
graph\_name String Name of the graph on which the isochrone is to be computed.
source\_node String Starting vertex on the underlying graph from/to which the isochrones are created.
max\_solution\_radius Number Extent of the search radius around source\_node. Set to '-1.0' for unrestricted search radius. The default value is -1.0.
weights\_on\_edges Array.\ 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 array ( \[] ).
restrictions Array.\ 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 array ( \[] ).
num\_levels Number Number of equally-separated isochrones to compute. The default value is 1.
generate\_image Boolean If set to true, generates a PNG image of the isochrones in the response. Supported values:
  • true
  • false
The default value is true.
levels\_table String Name of the table to output the isochrones to, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ''.
style\_options Object Various style related options of the isochrone image.
  • 'line\_size': The width of the contour lines in pixels. The default value is '3'. The minimum allowed value is '0'. The maximum allowed value is '20'.
  • '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 generate\_image 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'
    The default value is 'jet'.
solve\_options Object 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:
    • 'true'
    • 'false'
    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 weights\_on\_edges will override this value.
The default value is an empty object ( {"{"}{"}"} ).
contour\_options Object Contour specific parameters.
  • 'projection': Spatial Reference System (i.e. EPSG Code). Supported values:
    • '3857'
    • '102100'
    • '900913'
    • 'EPSG:4326'
    • 'PLATE\_CARREE'
    • 'EPSG:900913'
    • 'EPSG:102100'
    • 'EPSG:3857'
    • 'WEB\_MERCATOR'
    The default value is 'PLATE\_CARREE'.
  • 'width': When generate\_image is set to true, width of the generated image. The default value is '512'.
  • 'height': When generate\_image 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:
    • 'true'
    • 'false'
    The default value is 'true'.
  • 'add\_labels': If set to true, add labels to the isolines. Supported values:
    • 'true'
    • 'false'
    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'.
The default value is an empty object ( {"{"}{"}"} ).
options Object Additional parameters.
  • 'solve\_table': Name of the table to host intermediate solve results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. This table will contain 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:
    • 'true'
    • 'false'
    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'. The minimum allowed value is '0'. The maximum allowed value is '1'.
  • '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.
    The default value is '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).
    The default value is 'from\_source'.
The default value is an empty object ( {"{"}{"}"} ).
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

visualize\_isochrone\_request(request, callback) → {"{"}Promise{"}"}

Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.
Parameters:
Name Type Description
request Object Request object containing the parameters for the operation.
callback GPUdbCallback Callback that handles the response.
Source:
  • ,
Returns:
A promise that will be fulfilled with the response object, if no callback function is provided.
Type
Promise

wms\_request(request, callbackopt) → {"{"}Promise{"}"}

Request a WMS (Web Map Service) rasterized image. The image will be returned as a Node.js Buffer object via the specified callback function, or via a promise if no callback function is provided.
Parameters:
Name Type Attributes Description
request Object Object containing WMS parameters.
callback GPUdbCallback \
 The callback function.
Source:
  • ,
Returns:
A promise that will be fulfilled with the image, if no callback function is provided.
Type
Promise

(static) decode(o) → {"{"}Object|Array.\{"}"}
Decodes a JSON string, or array of JSON strings, returned from GPUdb into JSON object(s).
Parameters:
Name Type Description
o String | Array.\ The JSON string(s) to decode.
Source:
  • ,
Returns:
The decoded JSON object(s).
Type
Object | Array.\

(static) decode\_no\_inf\_nan(o) → {"{"}Object|Array.\{"}"}
Decodes a JSON string, or array of JSON strings, returned from GPUdb into JSON object(s). Special treatment for quoted "Infinity", "-Infinity", and "NaN". Catches those and converts to null. This is significantly slower than the regular decode function.
Parameters:
Name Type Description
o String | Array.\ The JSON string(s) to decode.
Source:
  • ,
Returns:
The decoded JSON object(s).
Type
Object | Array.\

(static) decode\_regular(o) → {"{"}Object|Array.\{"}"}
Decodes a JSON string, or array of JSON strings, returned from GPUdb into JSON object(s).
Parameters:
Name Type Description
o String | Array.\ The JSON string(s) to decode.
Source:
  • ,
Returns:
The decoded JSON object(s).
Type
Object | Array.\

(static) encode(o) → {"{"}String|Array.\{"}"}

Encodes a JSON object, or array of JSON objects, into JSON string(s) to be passed to GPUdb.
Parameters:
Name Type Description
o Object | Array.\ The JSON object(s) to encode.
Source:
  • ,
Returns:
The encoded JSON string(s).
Type
String | Array.\