Functions on Kinetica Docs

Administration: Add Host

Mon, 01 Jan 0001 00:00:00 +0000

Adds a host to an existing cluster. NOTE: This endpoint should be used for on-premise deployments only. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ).

Administration: Add Ranks

Mon, 01 Jan 0001 00:00:00 +0000

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 Administration: Rebalance. The database must be offline for this operation, see Administration: System Offline For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.

Administration: Alter Host

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ).

Administration: Alter Job

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description job_ids array of longs Jobs to be modified.

Administration: Begin Backup

Mon, 01 Jan 0001 00:00:00 +0000

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 Administration: End Backup. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Administration: End Backup

Mon, 01 Jan 0001 00:00:00 +0000

Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description info map of string to strings Additional information.

Administration: HA refresh

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description info map of string to strings Additional information.

Administration: Rebalance

Mon, 01 Jan 0001 00:00:00 +0000

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 Administration: System Offline If Administration: 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 Administration: Rebalance is invoked at some point when unsharded data (a.

Administration: Remove Host

Mon, 01 Jan 0001 00:00:00 +0000

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 Administration: Remove Ranks or manually switched over to a new host using Administration: Switch Over Process 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 Administration: Switch Over Process.

Administration: Remove Ranks

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter 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 Administration: System 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.

Administration: Show Alerts

Mon, 01 Jan 0001 00:00:00 +0000

Requests a list of the most recent alerts. Returns lists of alert data, including timestamp and type. Input Parameter Description Name Type Description num_alerts int Number of most recent alerts to request. The response will include up to input parameter num_alerts depending on how many alerts there are in the system. A value of 0 returns all stored alerts. options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Administration: Show Cluster Operations

Mon, 01 Jan 0001 00:00:00 +0000

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by input parameter history_index. Returns details on the requested cluster operation. The response will also indicate how many cluster operations are stored in the history. Input Parameter Description Name Type Description history_index int Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0. options map of string to strings Optional parameters.

Administration: Show Jobs

Mon, 01 Jan 0001 00:00:00 +0000

Get a list of the current jobs in GPUdb. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description 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. The default value is false.

Administration: Show Shards

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description version long Current shard array version number.

Administration: Switch Over Process

Mon, 01 Jan 0001 00:00:00 +0000

Manually switch over one or more processes to another host. Individual ranks or entire hosts may be moved to another host. NOTE: This endpoint should be used for on-premise deployments only. Input Parameter Description Name Type Description processes array of strings 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.

Administration: System Offline

Mon, 01 Jan 0001 00:00:00 +0000

Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown. Input Parameter Description Name Type Description offline boolean Set to true if desired state is offline. The supported values are: true false options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description flush_to_disk Flush to disk when going offline The supported values are:

Administration: System Shutdown

Mon, 01 Jan 0001 00:00:00 +0000

Exits the database server application. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description exit_status string 'OK' upon (right before) successful exit. info map of string to strings Additional information.

Administration: Verify Database

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description rebuild_on_error [DEPRECATED -- Use the Rebuild DB feature of GAdmin instead.

Aggregate Convex Hull

Mon, 01 Jan 0001 00:00:00 +0000

Calculates and returns the convex hull for the values in a table specified by input parameter table_name. Input Parameter Description 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.

Aggregate Group By

Mon, 01 Jan 0001 00:00:00 +0000

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; columns marked as store-only are unable to be used in grouping or aggregation.

Aggregate Histogram

Mon, 01 Jan 0001 00:00:00 +0000

Performs a histogram calculation given a table, a column, and an interval function. The input parameter 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.

Aggregate K-means

Mon, 01 Jan 0001 00:00:00 +0000

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.

Aggregate Min/Max

Mon, 01 Jan 0001 00:00:00 +0000

Calculates and returns the minimum and maximum values of a particular column in a table. Input Parameter Description 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 map of string to strings Optional parameters.

Aggregate Min/Max Geometry

Mon, 01 Jan 0001 00:00:00 +0000

Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. Input Parameter Description 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 map of string to strings Optional parameters.

Aggregate Statistics

Mon, 01 Jan 0001 00:00:00 +0000

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.

Aggregate Statistics by Range

Mon, 01 Jan 0001 00:00:00 +0000

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.

Aggregate Unique

Mon, 01 Jan 0001 00:00:00 +0000

Returns all the unique values from a particular column (specified by input parameter column_name) of a particular table or view (specified by input parameter table_name). If input parameter column_name is a numeric column, the values will be in output parameter binary_encoded_response. Otherwise if input parameter column_name is a string column, the values will be in output parameter json_encoded_response. The results can be paged via input parameter offset and input parameter limit parameters.

Alter Credential

Mon, 01 Jan 0001 00:00:00 +0000

Alter the properties of an existing credential. Input Parameter Description Name Type Description credential_name string Name of the credential to be altered. Must be an existing credential. credential_updates_map map of string to strings Map containing the properties of the credential to be updated. Error if empty. Supported Parameters (keys) Parameter Description type New type for the credential. The supported values are: 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.

Alter Data Sink

Mon, 01 Jan 0001 00:00:00 +0000

Alters the properties of an existing data sink Input Parameter Description Name Type Description name string Name of the data sink to be altered. Must be an existing data sink. datasink_updates_map map of string to strings Map containing the properties of the data sink to be updated. Error if empty. Supported Parameters (keys) Parameter Description destination Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'http', 'https' and 'kafka'.

Alter Data Source

Mon, 01 Jan 0001 00:00:00 +0000

Alters the properties of an existing data source Input Parameter Description Name Type Description name string Name of the data source to be altered. Must be an existing data source. datasource_updates_map map of string to strings Map containing the properties of the data source to be updated. Error if empty. Supported Parameters (keys) Parameter Description location Location of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format. Supported storage provider types are 'azure','gcs','hdfs','kafka' and 's3'.

Alter Directory

Mon, 01 Jan 0001 00:00:00 +0000

Alters an existing directory in KiFS. Input Parameter Description Name Type Description directory_name string Name of the directory in KiFS to be altered. directory_updates_map map of string to strings Map containing the properties of the directory to be altered. Error if empty. Supported Parameters (keys) Parameter Description data_limit The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit. options map of string to strings Optional parameters.

Alter Resource Group

Mon, 01 Jan 0001 00:00:00 +0000

Alters the properties of an exisiting resource group to facilitate resource management. Input Parameter Description 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 inconjunction with the is_default_group option. tier_attributes map of string to maps of string to strings Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers.

Alter Role

Mon, 01 Jan 0001 00:00:00 +0000

Alters a Role. Input Parameter Description 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 Description 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 input parameter action.

Alter Schema

Mon, 01 Jan 0001 00:00:00 +0000

Used to change the name of a SQL-style schema, specified in input parameter schema_name. Input Parameter Description Name Type Description schema_name string Name of the schema to be altered. action string Modification operation to be applied Supported Values Description rename_schema Renames a schema to input parameter value. Has the same naming restrictions as tables. value string The value of the modification, depending on input parameter action. For now the only value of input parameter action is rename_schema.

Alter System Properties

Mon, 01 Jan 0001 00:00:00 +0000

The 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 input parameter property_updates_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false'). Input Parameter Description Name Type Description property_updates_map map of string to strings Map containing the properties of the system to be updated.

Alter Table

Mon, 01 Jan 0001 00:00:00 +0000

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, chunk skip, or geospatial index. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns.

Alter Table Columns

Mon, 01 Jan 0001 00:00:00 +0000

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.

Alter Table Metadata

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description table_names array of strings Names of the tables whose metadata will be updated, in [schema_name.]table_name format, using standard name resolution rules.

Alter Table Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Alters a table monitor previously created with Create Table Monitor. Input Parameter Description Name Type Description topic_id string The topic ID returned by Create Table Monitor . monitor_updates_map map of string to strings Map containing the properties of the table monitor to be updated. Error if empty. Supported Parameters (keys) Parameter Description 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.

Alter Tier

Mon, 01 Jan 0001 00:00:00 +0000

Alters properties of an exisiting tier to facilitate resource management. To disable watermark-based eviction, set both high_watermark and low_watermark to 100. Input Parameter Description Name Type Description name string Name of the tier to be altered. Must be an existing tier group name. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description capacity Maximum size in bytes this tier may hold at once.

Alter UDF environment

Mon, 01 Jan 0001 00:00:00 +0000

Alters an existing environment which can be referenced by a user-defined function (UDF). Input Parameter Description Name Type Description environment_name string Name of the environment to be altered. action string Modification operation to be applied Supported Values Description 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 input parameter action.

Alter User

Mon, 01 Jan 0001 00:00:00 +0000

Alters a user. Input Parameter Description 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 Description 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.

Alter Video

Mon, 01 Jan 0001 00:00:00 +0000

Alters a video. Input Parameter Description Name Type Description path string Fully-qualified KiFS path to the video to be altered. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description ttl Sets the TTL of the video. Output Parameter Description Name Type Description path string Fully qualified KIFS path to the video file. info map of string to strings Additional information.

Append Records

Mon, 01 Jan 0001 00:00:00 +0000

Append (or insert) all records from a source table (specified by input parameter source_table_name) to a particular target table (specified by input parameter table_name). The field map (specified by input parameter field_map) holds the user specified map of target table column names with their mapped source column names. Input Parameter Description 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.

Clear Statistics

Mon, 01 Jan 0001 00:00:00 +0000

Clears statistics (cardinality, mean value, etc.) for a column in a specified table. Input Parameter Description 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 input parameter 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.

Clear Table

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description 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.

Clear Table Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Deactivates a table monitor previously created with Create Table Monitor. Input Parameter Description Name Type Description topic_id string The topic ID returned by Create Table Monitor . options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description keep_autogenerated_sink If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use.

Clear Trigger

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description trigger_id string ID for the trigger to be deactivated. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description trigger_id string Value of input parameter trigger_id.

Collect Statistics

Mon, 01 Jan 0001 00:00:00 +0000

Collect statistics for a column(s) in a specified table. Input Parameter Description 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. column_names array of strings List of one or more column names in input parameter table_name for which to collect statistics (cardinality, mean value, etc.). options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Create Asynchronous Job

Mon, 01 Jan 0001 00:00:00 +0000

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 Get Asynchronous Job Result. Input Parameter Description 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.

Create Credential

Mon, 01 Jan 0001 00:00:00 +0000

Create a new credential. Input Parameter Description 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. The supported values are: 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 jdbc kafka confluent identity string User of the credential to be created.

Create Data Sink

Mon, 01 Jan 0001 00:00:00 +0000

Creates a data sink, which contains the destination information for a data sink that is external to the database. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ).

Create Data Source

Mon, 01 Jan 0001 00:00:00 +0000

Creates a data source, which contains the location and connection information for a data store that is external to the database. Input Parameter Description 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 map of string to strings Optional parameters.

Create Directory

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new directory in KiFS. The new directory serves as a location in which the user can upload files using Upload Files. Input Parameter Description Name Type Description directory_name string Name of the directory in KiFS to be created. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description create_home_directory When set, a home directory is created for the user name provided in the value.

Create External Table

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter create_table_options, which contains many of the options from Create Table; or defined implicitly, inferred from the source data.

Create External User

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new external user (a user whose credentials are managed by an external LDAP). NOTE: This endpoint should be used for on-premise deployments only. Input Parameter Description 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 map of string to strings Optional parameters.

Create Graph

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new graph network using given nodes, edges, weights, and restrictions. IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint. Input Parameter Description 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.

Create Internal User

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new internal user (a user whose credentials are managed by the database system). Input Parameter Description 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.

Create Join Table

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description 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 of strings The list of table names composing the join, each in [schema_name.]table_name format, using standard name resolution rules.

Create Materialized View

Mon, 01 Jan 0001 00:00:00 +0000

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 output parameter view_id, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view. Input Parameter Description 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.

Create Proc

Mon, 01 Jan 0001 00:00:00 +0000

Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution. Input Parameter Description 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. The default value is distributed. Supported Values Description 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.

Create Projection

Mon, 01 Jan 0001 00:00:00 +0000

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 Get Records by Column. A projection can be created with a different shard key than the source table.

Create Resource Group

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new resource group to facilitate resource management. Input Parameter Description 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 map of string to maps of string to strings Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers.

Create Role

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new role. NOTE: This endpoint should be used for on-premise deployments only. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ).

Create Schema

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description schema_name string Name of the schema to be created. Has the same naming restrictions as tables. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description no_error_if_exists If true, prevents an error from occurring if the schema already exists.

Create Table

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new table. If a new table is being created, the type of the table is given by input parameter type_id, which must be the ID of a currently registered type (i.e. one created via Create Type). 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. Input Parameter Description Name Type Description table_name string Name of the table to be created, in [schema_name.

Create Table Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by input parameter table_name) and forwards event notifications to subscribers via ZMQ. After this call completes, subscribe to the returned output parameter 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 output parameter type_schema.

Create Trigger by Area

Mon, 01 Jan 0001 00:00:00 +0000

Sets up an area trigger mechanism for two column_names for one or more tables. (This function is essentially the two-dimensional version of Create Trigger by Range.) Once the trigger has been activated, any record added to the listed tables(s) via 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 Show System Status) for any listening client to collect.

Create Trigger by Range

Mon, 01 Jan 0001 00:00:00 +0000

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 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 Show System Status) for any listening client to collect.

Create Type

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new type describing the layout of a table. The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition, one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive--i.

Create UDF Environment

Mon, 01 Jan 0001 00:00:00 +0000

Creates a new environment which can be used by user-defined functions (UDF). Input Parameter Description Name Type Description environment_name string Name of the environment to be created. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description environment_name string Value of input parameter environment_name. info map of string to strings Additional information.

Create Union

Mon, 01 Jan 0001 00:00:00 +0000

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.

Create Video

Mon, 01 Jan 0001 00:00:00 +0000

Creates a job to generate a sequence of raster images that visualize data over a specified time. Input Parameter Description 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 input parameter attribute.

Delete Directory

Mon, 01 Jan 0001 00:00:00 +0000

Deletes a directory from KiFS. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description recursive If true, will delete directory and all files residing in it. If false, directory must be empty for deletion.

Delete Files

Mon, 01 Jan 0001 00:00:00 +0000

Deletes one or more files from KiFS. Input Parameter Description Name Type Description file_names array of strings An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Delete Graph

Mon, 01 Jan 0001 00:00:00 +0000

Deletes an existing graph from the graph server and/or persist. Input Parameter Description Name Type Description graph_name string Name of the graph to be deleted. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description 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.

Delete Proc

Mon, 01 Jan 0001 00:00:00 +0000

Deletes a proc. Any currently running instances of the proc will be killed. Input Parameter Description Name Type Description proc_name string Name of the proc to be deleted. Must be the name of a currently existing proc. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description proc_name string Value of input parameter proc_name. info map of string to strings Additional information.

Delete Records

Mon, 01 Jan 0001 00:00:00 +0000

Deletes record(s) matching the provided criteria from the given table. The record selection criteria can either be one or more input parameter 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.

Delete Resource Group

Mon, 01 Jan 0001 00:00:00 +0000

Deletes a resource group. Input Parameter Description Name Type Description name string Name of the resource group to be deleted. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description cascade_delete If true, delete any existing entities owned by this group. Otherwise this request will return an error of any such entities exist. The default value is false.

Delete Role

Mon, 01 Jan 0001 00:00:00 +0000

Deletes an existing role. NOTE: This endpoint should be used for on-premise deployments only. Input Parameter Description Name Type Description name string Name of the role to be deleted. Must be an existing role. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description name string Value of input parameter name. info map of string to strings Additional information.

Delete User

Mon, 01 Jan 0001 00:00:00 +0000

Deletes an existing user. NOTE: This endpoint should be used for on-premise deployments only. Input Parameter Description Name Type Description name string Name of the user to be deleted. Must be an existing user. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description name string Value of input parameter name. info map of string to strings Additional information.

Download Files

Mon, 01 Jan 0001 00:00:00 +0000

Downloads one or more files from KiFS. Input Parameter Description Name Type Description file_names array of strings An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimeter. 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 of longs An array of starting byte offsets from which to read each respective file in input parameter file_names.

Drop Credential

Mon, 01 Jan 0001 00:00:00 +0000

Drop an existing credential. Input Parameter Description Name Type Description credential_name string Name of the credential to be dropped. Must be an existing credential. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description credential_name string Value of input parameter credential_name. info map of string to strings Additional information.

Drop Data Sink

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description name string Name of the data sink to be dropped. Must be an existing data sink. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description clear_table_monitors If true, any table monitors that use this data sink will be cleared.

Drop Data Source

Mon, 01 Jan 0001 00:00:00 +0000

Drops an existing data source. Any external tables that depend on the data source must be dropped before it can be dropped. Input Parameter Description Name Type Description name string Name of the data source to be dropped. Must be an existing data source. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description name string Value of input parameter name.

Drop Schema

Mon, 01 Jan 0001 00:00:00 +0000

Drops an existing SQL-style schema, specified in input parameter schema_name. Input Parameter Description Name Type Description schema_name string Name of the schema to be dropped. Must be an existing schema. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description no_error_if_not_exists If true and if the schema specified in input parameter schema_name does not exist, no error is returned.

Drop UDF Environment

Mon, 01 Jan 0001 00:00:00 +0000

Drop an existing user-defined function (UDF) environment. Input Parameter Description Name Type Description environment_name string Name of the environment to be dropped. Must be an existing environment. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description no_error_if_not_exists If true and if the environment specified in input parameter environment_name does not exist, no error is returned. If false and if the environment specified in input parameter environment_name does not exist, then an error is returned.

Execute Proc

Mon, 01 Jan 0001 00:00:00 +0000

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 parameter input_table_names & input parameter input_column_names may be passed to the proc to use for reading data, and input parameter 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.

Execute SQL

Mon, 01 Jan 0001 00:00:00 +0000

Execute a SQL statement (query, DML, or DDL). See SQL Support for the complete set of supported SQL commands. Input Parameter Description Name Type Description statement string SQL statement (query, DML, or DDL) to be executed offset long 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.

Export records from table

Mon, 01 Jan 0001 00:00:00 +0000

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 Create Data Sink. 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.

Filter

Mon, 01 Jan 0001 00:00:00 +0000

Filters data based on the specified expression. The results are stored in a result set with the given input parameter 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. Input Parameter Description Name Type Description table_name string Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules.

Filter by Area

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name passed in as part of the input.

Filter by Box

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name is passed in as part of the input payload.

Filter by Geometry

Mon, 01 Jan 0001 00:00:00 +0000

Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by input parameter input_wkt. Input Parameter Description 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.

Filter by List

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name is passed in as part of the request.

Filter by Radius

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name is passed in as part of the request.

Filter by Range

Mon, 01 Jan 0001 00:00:00 +0000

Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by input parameter table_name is added to the view input parameter view_name if its column is within [input parameter lower_bound, input parameter 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.

Filter by Series

Mon, 01 Jan 0001 00:00:00 +0000

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).

Filter by String

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description 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.

Filter by Table

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name is specified, then the filtered objects will then be put in a newly created view.

Filter by Value

Mon, 01 Jan 0001 00:00:00 +0000

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.

Filter Geometry by Area

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name passed in as part of the input.

Filter Geometry by Box

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name is passed in as part of the input payload.

Filter Geometry by Radius

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter view_name is passed in as part of the request.

Get Asynchronous Job Result

Mon, 01 Jan 0001 00:00:00 +0000

Get the status and result of asynchronously running job. See the Create Asynchronous Job for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution. Input Parameter Description Name Type Description job_id long A unique identifier for the job whose status and result is to be fetched. options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Get JSON Records

Mon, 01 Jan 0001 00:00:00 +0000

Overview Usage Parameters Examples Responses Overview Kinetica provides a direct JSON egress service to allow records to be retrieved as raw JSON from the database. Several options can be used to identify & filter the data being requested. There is also limited support for aggregation. JSON objects will be returned as an array: Single or Multiple Records 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 [ { "id": 1, "category": "Furniture", "name": "Clamp-on Lamps", "description": "Strong, steadfast fasteners; localized lighting for laboring", "stock": 10 }, { "id": 14, "category": "Technology", "name": "Dot Matrix Printers", "description": "Impactful industrial implements for impressing ink iteratively", "stock": 27 } ] For examples, see Examples or JSON Egress Snippets.

Get Records

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter offset and input parameter 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.

Get Records by Column

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter offset and input parameter limit parameters. Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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.

Get Records by Series

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves the complete series/track records from the given input parameter world_table_name based on the partial track information contained in the input parameter table_name. This operation supports paging through the data via the input parameter offset and input parameter limit parameters. In contrast to Get Records this returns records grouped by series/track. So if input parameter offset is 0 and input parameter limit is 5 this operation would return the first 5 series/tracks in input parameter table_name.

Get Records from Collection

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as Delete Records. This operation supports paging through the data via the input parameter offset and input parameter limit parameters. Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED) Input Parameter Description Name Type Description table_name string Name of the collection or table from which records are to be retrieved, in [schema_name.

Grant Credential Permission

Mon, 01 Jan 0001 00:00:00 +0000

Grants a credential-level permission to a user or role. Input Parameter Description 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 Description 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.

Grant Data Source Permission

Mon, 01 Jan 0001 00:00:00 +0000

Grants a data source permission to a user or role. Input Parameter Description 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 Description 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.

Grant Directory Permission

Mon, 01 Jan 0001 00:00:00 +0000

Grants a KiFS directory-level permission to a user or role. Input Parameter Description 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 Description 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.

Grant Permission

Mon, 01 Jan 0001 00:00:00 +0000

Grant user or role the specified permission on the specified object. Input Parameter Description 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

Grant Proc Permission

Mon, 01 Jan 0001 00:00:00 +0000

Grants a proc-level permission to a user or role. Input Parameter Description 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 Description 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.

Grant Role

Mon, 01 Jan 0001 00:00:00 +0000

Grants membership in a role to a user or role. Input Parameter Description 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 input parameter role. Must be an existing user or role. options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Grant System Permission

Mon, 01 Jan 0001 00:00:00 +0000

Grants a system-level permission to a user or role. Input Parameter Description 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 Description 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.

Grant Table Permission

Mon, 01 Jan 0001 00:00:00 +0000

Grants a table-level permission to a user or role. Input Parameter Description 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 Description 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.

Has Permission

Mon, 01 Jan 0001 00:00:00 +0000

Checks if the specified user has the specified permission on the specified object. Input Parameter Description 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.

Has Proc

Mon, 01 Jan 0001 00:00:00 +0000

Checks the existence of a proc with the given name. Input Parameter Description Name Type Description proc_name string Name of the proc to check for existence. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description proc_name string Value of input parameter proc_name proc_exists boolean Indicates whether the proc exists or not. Possible values are:

Has Role

Mon, 01 Jan 0001 00:00:00 +0000

Checks if the specified user has the specified role. Input Parameter Description Name Type Description principal string Name of the user for which role membersih 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 map of string to strings Optional parameters. The default value is an empty map ( {} ).

Has Schema

Mon, 01 Jan 0001 00:00:00 +0000

Checks for the existence of a schema with the given name. Input Parameter Description Name Type Description schema_name string Name of the schema to check for existence, in root, using standard name resolution rules. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description schema_name string Value of input parameter schema_name schema_exists boolean Indicates whether the schema exists or not.

Has Table

Mon, 01 Jan 0001 00:00:00 +0000

Checks for the existence of a table with the given name. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description table_name string Value of input parameter table_name table_exists boolean Indicates whether the table exists or not.

Has Type

Mon, 01 Jan 0001 00:00:00 +0000

Check for the existence of a type. Input Parameter Description Name Type Description type_id string Id of the type returned in response to Create Type request. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description type_id string Value of input parameter type_id. type_exists boolean Indicates whether the type exists or not. Possible values are:

Insert JSON Records

Mon, 01 Jan 0001 00:00:00 +0000

Overview Usage Examples Responses Overview Kinetica provides a direct JSON ingest service to allow raw JSON to be translated into records and inserted into the database. If the target table exists, inserted records will be appended to it. If the target table does not exist, it will be created automatically, with type inferencing used to determine column types & sizes, before inserting data. Tip To ensure a particular column ordering with a created target table, use the columns_to_load parameter, specifying all columns in the desired order.

Insert Records

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter 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.

Insert Records from external database

Mon, 01 Jan 0001 00:00:00 +0000

Computes remote query result and inserts the result data into a new or existing table Input Parameter Description 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.

Insert Records from File(s)

Mon, 01 Jan 0001 00:00:00 +0000

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.

Insert Records from Payload

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description 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.

Insert Records Random

Mon, 01 Jan 0001 00:00:00 +0000

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.

Insert Records to table in external database

Mon, 01 Jan 0001 00:00:00 +0000

Exports records from source table to the specified target table in an external database Input Parameter Description 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 map of string to strings Optional parameters.

Insert Symbol

Mon, 01 Jan 0001 00:00:00 +0000

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.

Kill Proc

Mon, 01 Jan 0001 00:00:00 +0000

Kills a running proc instance. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ).

Lock Table

Mon, 01 Jan 0001 00:00:00 +0000

Manages global access to a table's data. By default a table has a input parameter 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 input parameter lock_type is no_access then no operations are permitted on the table. The lock status can be queried by setting input parameter lock_type to status.

Match Graph

Mon, 01 Jan 0001 00:00:00 +0000

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 Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint. Input Parameter Description Name Type Description graph_name string Name of the underlying geospatial graph resource to match to using input parameter sample_points.

Merge Records

Mon, 01 Jan 0001 00:00:00 +0000

Create a new empty result table (specified by input parameter table_name), and insert all records from source tables (specified by input parameter source_table_names) based on the field mapping information (specified by input parameter field_maps). For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions. The field map (specified by input parameter field_maps) holds the user-specified maps of target table column names to source table columns.

Modify Graph

Mon, 01 Jan 0001 00:00:00 +0000

Update an existing graph network using given nodes, edges, weights, restrictions, and options. IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint. Input Parameter Description Name Type Description graph_name string Name of the graph resource to modify. nodes array of strings Nodes with which to update existing input parameter nodes in graph specified by input parameter graph_name.

Query Graph

Mon, 01 Jan 0001 00:00:00 +0000

Employs a topological query on a network graph generated a-priori by 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 input parameter queries.

Repartition Graph

Mon, 01 Jan 0001 00:00:00 +0000

Rebalances an existing partitioned graph. IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint. Input Parameter Description Name Type Description graph_name string Name of the graph resource to rebalance. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description new_graph_name If a non-empty value is specified, the original graph will be kept (non-default behaviour) and a new balanced graph will be created under this given name.

Revoke Credential Permission

Mon, 01 Jan 0001 00:00:00 +0000

Revokes a credential-level permission from a user or role. Input Parameter Description 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 Description 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.

Revoke Data Source Permission

Mon, 01 Jan 0001 00:00:00 +0000

Revokes a data source permission from a user or role. Input Parameter Description 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 Description 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.

Revoke Directory Permission

Mon, 01 Jan 0001 00:00:00 +0000

Revokes a KiFS directory-level permission from a user or role. Input Parameter Description 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 Description 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.

Revoke Permission

Mon, 01 Jan 0001 00:00:00 +0000

Revoke user or role the specified permission on the specified object. Input Parameter Description 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

Revoke Proc Permission

Mon, 01 Jan 0001 00:00:00 +0000

Revokes a proc-level permission from a user or role. Input Parameter Description 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 Description 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.

Revoke Role

Mon, 01 Jan 0001 00:00:00 +0000

Revokes membership in a role from a user or role. Input Parameter Description 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 input parameter role. Must be an existing user or role. options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Revoke System Permission

Mon, 01 Jan 0001 00:00:00 +0000

Revokes a system-level permission from a user or role. Input Parameter Description 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 Description 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.

Revoke Table Permission

Mon, 01 Jan 0001 00:00:00 +0000

Revokes a table-level permission from a user or role. Input Parameter Description 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 Description 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.

Show Credential

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about a specified credential or all credentials. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description credential_names array of strings A list of all credential names.

Show Data Sink

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about a specified data sink or all data sinks. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description datasink_names array of strings The data sink names.

Show Data Source

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about a specified data source or all data sources. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description datasource_names array of strings The data source names.

Show Directories

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about directories in KiFS. Can be used to show a single directory, or all directories. Input Parameter Description Name Type Description directory_name string The KiFS directory name to show. If empty, shows all directories. The default value is ''. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description directories array of strings KiFS directory names users array of strings User that created each directory for the respective directories in output parameter directories creation_times array of longs The creation time for each directory in milliseconds since epoch, for the respective directories in output parameter directories data_usages array of longs The data usage each directory in bytes, for the respective directories in output parameter directories data_limits array of longs The data limit for each directory in bytes, for the respective directories in output parameter directories permissions array of strings Highest level of permission the calling user has for the respective directories in output parameter directories.

Show Environment

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments. Input Parameter Description 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 map of string to strings Optional parameters.

Show Files

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about files in KiFS. Can be used for individual files, or to show all files in a given directory. Input Parameter Description Name Type Description paths array of strings 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 delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?

Show Graphs

Mon, 01 Jan 0001 00:00:00 +0000

Shows information and characteristics of graphs that exist on the graph server. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description show_original_request If set to true, the request that was originally used to create the graph is also returned as JSON.

Show Proc

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about a proc. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description include_files If set to true, the files that make up the proc will be returned.

Show Proc Status

Mon, 01 Jan 0001 00:00:00 +0000

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from Execute Proc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID). Input Parameter Description 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.

Show Resource Group

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Show Resource Group

Mon, 01 Jan 0001 00:00:00 +0000

Requests resource group properties. Returns detailed information about the requested resource groups. Input Parameter Description Name Type Description names array of strings List of names of groups to be shown. A single entry with an empty string returns all groups. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description show_default_values If true include values of fields that are based on the default resource group.

Show Resource Statistics

Mon, 01 Jan 0001 00:00:00 +0000

Requests various statistics for storage/memory tiers and resource groups. Returns statistics on a per-rank basis. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description statistics_map map of string to strings Map of resource statistics info map of string to strings Additional information.

Show Schema

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves information about a schema (or all schemas), as specified in input parameter schema_name. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description no_error_if_not_exists If false will return an error if the provided input parameter schema_name does not exist.

Show Security

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description names array of strings 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 map of string to strings Optional parameters.

Show SQL Procedure

Mon, 01 Jan 0001 00:00:00 +0000

Shows information about SQL procedures, including the full definition of each requested procedure. Input Parameter Description 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description no_error_if_not_exists If true, no error will be returned if the requested procedure does not exist.

Show System Properties

Mon, 01 Jan 0001 00:00:00 +0000

Returns server configuration and version related information to the caller. The admin tool uses it to present server related information to the user. Input Parameter Description Name Type Description options map of string to strings Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description properties A list of comma separated names of properties requested. If not specified, all properties will be returned.

Show System Status

Mon, 01 Jan 0001 00:00:00 +0000

Provides server configuration and health related status to the caller. The admin tool uses it to present server related information to the user. Input Parameter Description Name Type Description options map of string to strings Optional parameters, currently unused. The default value is an empty map ( {} ). Output Parameter Description Name Type Description status_map map of string to strings A map of server configuration and health related status.

Show System Timing

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description options map of string to strings Optional parameters, currently unused. The default value is an empty map ( {} ). Output Parameter Description Name Type Description endpoints array of strings List of recently called endpoints, most recent first.

Show Table

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves detailed information about a table, view, or schema, specified in input parameter table_name. If the supplied input parameter table_name is a schema the call can return information about either the schema itself or the tables and views it contains. If input parameter 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 output parameter sizes and output parameter full_sizes), along with the total number of objects across all requested tables (in output parameter total_size and output parameter total_full_size).

Show Table Metadata

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves the user provided metadata for the specified tables. Input Parameter Description Name Type Description table_names array of strings 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description table_names array of strings Value of input parameter table_names.

Show Table Monitors

Mon, 01 Jan 0001 00:00:00 +0000

Show table monitors and their properties. Table monitors are created using Create Table Monitor. Returns detailed information about existing table monitors. Input Parameter Description Name Type Description monitor_ids array of strings List of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors. options map of string to strings Optional parameters. The default value is an empty map ( {} ).

Show Table Statistics

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves the collected column statistics for the specified table(s). Input Parameter Description Name Type Description table_names array of strings 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. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description table_names array of strings Value of input parameter table_names.

Show Tables by Type

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description type_id string Type id returned by a call to Create Type .

Show Triggers

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves information regarding the specified triggers or all existing triggers currently active. Input Parameter Description Name Type Description trigger_ids array of strings 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 map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description trigger_map map of string to maps of string to strings This dictionary contains (key, value) pairs of (trigger ID, information map/dictionary) where the key is a Unicode string representing a Trigger ID.

Show Types

Mon, 01 Jan 0001 00:00:00 +0000

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. Input Parameter Description Name Type Description type_id string Type Id returned in response to a call to Create Type . label string Option string that was supplied by user in a call to Create Type .

Show Video

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves information about rendered videos. Input Parameter Description Name Type Description paths array of strings The fully-qualified KiFS paths for the videos to show. If empty, shows all videos. options map of string to strings Optional parameters. The default value is an empty map ( {} ). Output Parameter Description Name Type Description creation_times array of strings Creation time for each video as an ISO-8601 datetime. elapsed_render_time_seconds array of longs The elapsed time spent rendering each video in seconds.

Solve Graph

Mon, 01 Jan 0001 00:00:00 +0000

Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions. IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint. Input Parameter Description Name Type Description graph_name string Name of the graph resource to solve. weights_on_edges array of strings Additional weights to apply to the edges of an existing graph.

Unpivot Table

Mon, 01 Jan 0001 00:00:00 +0000

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.

Update Records

Mon, 01 Jan 0001 00:00:00 +0000

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 input parameter 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.

Update Records by Series

Mon, 01 Jan 0001 00:00:00 +0000

Updates the view specified by input parameter table_name to include full series (track) information from the input parameter world_table_name for the series (tracks) present in the input parameter view_name. Input Parameter Description Name Type Description table_name string Name of the view on which the update operation will be performed, in [schema_name.]view_name format, using standard name resolution rules. Must be an existing view. world_table_name string Name of the table containing the complete series (track) information, in [schema_name.

Upload Files

Mon, 01 Jan 0001 00:00:00 +0000

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 recommeded for files of approximately 60 MB or larger. To upload files in their entirety, populate input parameter file_names with the file names to upload into on KiFS, and their respective byte content in input parameter file_data. Multiple steps are involved when uploading in multiple parts.

Upload Files From URL

Mon, 01 Jan 0001 00:00:00 +0000

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 Show Directories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated 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: '.

Vector Tile Service

Mon, 01 Jan 0001 00:00:00 +0000

Overview Configuration Usage Example Limitations and Cautions Overview Kinetica provides a Vector Tile Service (VTS) to generate Vector Tiles and support client-side visualization of the geospatial data contained within the tiles. The Vector Tile format generated follows the open standard Mapbox Vector Tile specification. The Kinetica VTS feeds a client-side Vector Tile renderer, such as Mapbox GL, by adding the VTS URL to the renderer's style configuration as a map layer source.

Visualize Image Chart

Mon, 01 Jan 0001 00:00:00 +0000

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 output parameter image_data field. Input Parameter Description Name Type Description table_name string Name of the table containing the data to be drawn as a chart, in [schema_name.

Visualize Isochrone

Mon, 01 Jan 0001 00:00:00 +0000

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 Network Graphs & Solvers for more information on graphs. Input Parameter Description 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.

Web Map Service

Mon, 01 Jan 0001 00:00:00 +0000

Overview Downloads Required Parameters Optional Parameters Modes RASTER CB_RASTER HEATMAP CONTOUR LABELS ISOCHRONES Overview Kinetica provides a Web Map Service (WMS) for generating image tiles from the geospatial data contained in it. The type of image tiles returned, the data used to generate the tiles, and the graphical styles in the tiles are specified in the query string of the WMS call. These would typically be used as overlays on top of a map.