|
Kinetica C# API
Version 7.0.19.0
|
|
Kinetica C# API
Version 7.0.19.0
|
API to talk to Kinetica Database More...
Classes | |
| class | Options |
| Connection Options More... | |
Public Member Functions | |
| Kinetica (string url_str, Options options=null) | |
| API Constructor More... | |
| void | AddTableType (string table_name, Type obj_type) |
| Given a table name, add its record type to enable proper encoding of records for insertion or updates. More... | |
| void | SetKineticaSourceClassToTypeMapping (Type objectType, KineticaType kineticaType) |
| Saves an object class type to a KineticaType association. More... | |
| void | DecodeRawBinaryDataUsingRecordType< T > (KineticaType record_type, IList< byte[]> records_binary, IList< T > records) |
| Given a KineticaType object for a certain record type, decode binary data into distinct records (objects). More... | |
| void | DecodeRawBinaryDataUsingSchemaString< T > (string schema_string, IList< byte[]> records_binary, IList< T > records) |
| Given a schema string for a certain record type, decode binary data into distinct records (objects). More... | |
| void | DecodeRawBinaryDataUsingSchemaString< T > (IList< string > schema_strings, IList< IList< byte[]>> lists_records_binary, IList< IList< T >> record_lists) |
| Given a list of schema strings, decode binary data into distinct records (objects). More... | |
| void | DecodeRawBinaryDataUsingTypeIDs< T > (IList< string > type_ids, IList< byte[]> records_binary, IList< T > records) |
| Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects). More... | |
| void | DecodeRawBinaryDataUsingTypeIDs< T > (IList< string > type_ids, IList< IList< byte[]>> lists_records_binary, IList< IList< T >> record_lists) |
| Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects). More... | |
| AdminAddRanksResponse | adminAddRanks (AdminAddRanksRequest request_) |
| Add one or more new ranks to the Kinetica cluster. More... | |
| AdminAddRanksResponse | adminAddRanks (IList< string > hosts, IList< IDictionary< string, string >> config_params, IDictionary< string, string > options=null) |
| Add one or more new ranks to the Kinetica cluster. More... | |
| AdminAlterJobsResponse | adminAlterJobs (AdminAlterJobsRequest request_) |
| Perform the requested action on a list of one or more job(s). More... | |
| AdminAlterJobsResponse | adminAlterJobs (IList< long > job_ids, string action, IDictionary< string, string > options=null) |
| Perform the requested action on a list of one or more job(s). More... | |
| AdminOfflineResponse | adminOffline (AdminOfflineRequest request_) |
| Take the system offline. More... | |
| AdminOfflineResponse | adminOffline (bool offline, IDictionary< string, string > options=null) |
| Take the system offline. More... | |
| AdminRebalanceResponse | adminRebalance (AdminRebalanceRequest request_) |
| Rebalance the cluster so that all the nodes contain approximately an equal number of records. More... | |
| AdminRebalanceResponse | adminRebalance (IDictionary< string, string > options=null) |
| Rebalance the cluster so that all the nodes contain approximately an equal number of records. More... | |
| AdminRemoveRanksResponse | adminRemoveRanks (AdminRemoveRanksRequest request_) |
| Remove one or more ranks from the cluster. More... | |
| AdminRemoveRanksResponse | adminRemoveRanks (IList< int > ranks, IDictionary< string, string > options=null) |
| Remove one or more ranks from the cluster. More... | |
| AdminShowAlertsResponse | adminShowAlerts (AdminShowAlertsRequest request_) |
| Requests a list of the most recent alerts. More... | |
| AdminShowAlertsResponse | adminShowAlerts (int num_alerts, IDictionary< string, string > options=null) |
| Requests a list of the most recent alerts. More... | |
| AdminShowClusterOperationsResponse | adminShowClusterOperations (AdminShowClusterOperationsRequest request_) |
| Requests the detailed status of the current operation (by default) or a prior cluster operation specified by . More... | |
| AdminShowClusterOperationsResponse | adminShowClusterOperations (int history_index=0, IDictionary< string, string > options=null) |
| Requests the detailed status of the current operation (by default) or a prior cluster operation specified by history_index . More... | |
| AdminShowJobsResponse | adminShowJobs (AdminShowJobsRequest request_) |
| Get a list of the current jobs in GPUdb. More... | |
| AdminShowJobsResponse | adminShowJobs (IDictionary< string, string > options=null) |
| Get a list of the current jobs in GPUdb. More... | |
| AdminShowShardsResponse | adminShowShards (AdminShowShardsRequest request_) |
| Show the mapping of shards to the corresponding rank and tom. More... | |
| AdminShowShardsResponse | adminShowShards (IDictionary< string, string > options=null) |
| Show the mapping of shards to the corresponding rank and tom. More... | |
| AdminShutdownResponse | adminShutdown (AdminShutdownRequest request_) |
| Exits the database server application. More... | |
| AdminShutdownResponse | adminShutdown (string exit_type, string authorization, IDictionary< string, string > options=null) |
| Exits the database server application. More... | |
| AdminVerifyDbResponse | adminVerifyDb (AdminVerifyDbRequest request_) |
| Verify database is in a consistent state. More... | |
| AdminVerifyDbResponse | adminVerifyDb (IDictionary< string, string > options=null) |
| Verify database is in a consistent state. More... | |
| AggregateConvexHullResponse | aggregateConvexHull (AggregateConvexHullRequest request_) |
| Calculates and returns the convex hull for the values in a table specified by . More... | |
| AggregateConvexHullResponse | aggregateConvexHull (string table_name, string x_column_name, string y_column_name, IDictionary< string, string > options=null) |
| Calculates and returns the convex hull for the values in a table specified by table_name . More... | |
| AggregateGroupByResponse | aggregateGroupBy (AggregateGroupByRequest request_) |
| Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. More... | |
| AggregateGroupByResponse | aggregateGroupBy (string table_name, IList< string > column_names, long offset=0, long limit=-9999, IDictionary< string, string > options=null) |
| Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. More... | |
| AggregateHistogramResponse | aggregateHistogram (AggregateHistogramRequest request_) |
| Performs a histogram calculation given a table, a column, and an interval function. More... | |
| AggregateHistogramResponse | aggregateHistogram (string table_name, string column_name, double start, double end, double interval, IDictionary< string, string > options=null) |
| Performs a histogram calculation given a table, a column, and an interval function. More... | |
| AggregateKMeansResponse | aggregateKMeans (AggregateKMeansRequest request_) |
| This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. More... | |
| AggregateKMeansResponse | aggregateKMeans (string table_name, IList< string > column_names, int k, double tolerance, IDictionary< string, string > options=null) |
| This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. More... | |
| AggregateMinMaxResponse | aggregateMinMax (AggregateMinMaxRequest request_) |
| Calculates and returns the minimum and maximum values of a particular column in a table. More... | |
| AggregateMinMaxResponse | aggregateMinMax (string table_name, string column_name, IDictionary< string, string > options=null) |
| Calculates and returns the minimum and maximum values of a particular column in a table. More... | |
| AggregateMinMaxGeometryResponse | aggregateMinMaxGeometry (AggregateMinMaxGeometryRequest request_) |
| Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More... | |
| AggregateMinMaxGeometryResponse | aggregateMinMaxGeometry (string table_name, string column_name, IDictionary< string, string > options=null) |
| Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More... | |
| AggregateStatisticsResponse | aggregateStatistics (AggregateStatisticsRequest request_) |
| Calculates the requested statistics of the given column(s) in a given table. More... | |
| AggregateStatisticsResponse | aggregateStatistics (string table_name, string column_name, string stats, IDictionary< string, string > options=null) |
| Calculates the requested statistics of the given column(s) in a given table. More... | |
| AggregateStatisticsByRangeResponse | aggregateStatisticsByRange (AggregateStatisticsByRangeRequest request_) |
| Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More... | |
| AggregateStatisticsByRangeResponse | aggregateStatisticsByRange (string table_name, string select_expression, string column_name, string value_column_name, string stats, double start, double end, double interval, IDictionary< string, string > options=null) |
| Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More... | |
| AggregateUniqueResponse | aggregateUnique (AggregateUniqueRequest request_) |
| Returns all the unique values from a particular column (specified by ) of a particular table or view (specified by ). More... | |
| AggregateUniqueResponse | aggregateUnique (string table_name, string column_name, long offset=0, long limit=-9999, IDictionary< string, string > options=null) |
| Returns all the unique values from a particular column (specified by column_name ) of a particular table or view (specified by table_name ). More... | |
| AggregateUnpivotResponse | aggregateUnpivot (AggregateUnpivotRequest request_) |
| Rotate the column values into rows values. More... | |
| AggregateUnpivotResponse | aggregateUnpivot (string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, IDictionary< string, string > options=null) |
| Rotate the column values into rows values. More... | |
| AlterResourceGroupResponse | alterResourceGroup (AlterResourceGroupRequest request_) |
| Alters the properties of an exisiting resource group to facilitate resource management. More... | |
| AlterResourceGroupResponse | alterResourceGroup (string name, IDictionary< string, IDictionary< string, string >> tier_attributes=null, string ranking=AlterResourceGroupRequest.Ranking.EMPTY_STRING, string adjoining_resource_group="", IDictionary< string, string > options=null) |
| Alters the properties of an exisiting resource group to facilitate resource management. More... | |
| AlterRoleResponse | alterRole (AlterRoleRequest request_) |
| Alters a Role. More... | |
| AlterRoleResponse | alterRole (string name, string action, string _value, IDictionary< string, string > options=null) |
| Alters a Role. More... | |
| AlterSystemPropertiesResponse | alterSystemProperties (AlterSystemPropertiesRequest request_) |
| The Kinetica.alterSystemProperties(IDictionary{string, string},IDictionary{string, string}) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More... | |
| AlterSystemPropertiesResponse | alterSystemProperties (IDictionary< string, string > property_updates_map, IDictionary< string, string > options=null) |
| The Kinetica.alterSystemProperties(IDictionary{string, string},IDictionary{string, string}) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More... | |
| AlterTableResponse | alterTable (AlterTableRequest request_) |
| Apply various modifications to a table, view, or collection. More... | |
| AlterTableResponse | alterTable (string table_name, string action, string _value, IDictionary< string, string > options=null) |
| Apply various modifications to a table, view, or collection. More... | |
| AlterTableColumnsResponse | alterTableColumns (AlterTableColumnsRequest request_) |
| Apply various modifications to columns in a table, view. More... | |
| AlterTableColumnsResponse | alterTableColumns (string table_name, IList< IDictionary< string, string >> column_alterations, IDictionary< string, string > options) |
| Apply various modifications to columns in a table, view. More... | |
| AlterTableMetadataResponse | alterTableMetadata (AlterTableMetadataRequest request_) |
| Updates (adds or changes) metadata for tables. More... | |
| AlterTableMetadataResponse | alterTableMetadata (IList< string > table_names, IDictionary< string, string > metadata_map, IDictionary< string, string > options=null) |
| Updates (adds or changes) metadata for tables. More... | |
| AlterTierResponse | alterTier (AlterTierRequest request_) |
| Alters properties of an exisiting tier to facilitate resource management. More... | |
| AlterTierResponse | alterTier (string name, IDictionary< string, string > options=null) |
| Alters properties of an exisiting tier to facilitate resource management. More... | |
| AlterUserResponse | alterUser (AlterUserRequest request_) |
| Alters a user. More... | |
| AlterUserResponse | alterUser (string name, string action, string _value, IDictionary< string, string > options=null) |
| Alters a user. More... | |
| AppendRecordsResponse | appendRecords (AppendRecordsRequest request_) |
| Append (or insert) all records from a source table (specified by ) to a particular target table (specified by ). More... | |
| AppendRecordsResponse | appendRecords (string table_name, string source_table_name, IDictionary< string, string > field_map, IDictionary< string, string > options=null) |
| Append (or insert) all records from a source table (specified by source_table_name ) to a particular target table (specified by table_name ). More... | |
| ClearStatisticsResponse | clearStatistics (ClearStatisticsRequest request_) |
| Clears statistics (cardinality, mean value, etc.) for a column in a specified table. More... | |
| ClearStatisticsResponse | clearStatistics (string table_name="", string column_name="", IDictionary< string, string > options=null) |
| Clears statistics (cardinality, mean value, etc.) for a column in a specified table. More... | |
| ClearTableResponse | clearTable (ClearTableRequest request_) |
| Clears (drops) one or all tables in the database cluster. More... | |
| ClearTableResponse | clearTable (string table_name="", string authorization="", IDictionary< string, string > options=null) |
| Clears (drops) one or all tables in the database cluster. More... | |
| ClearTableMonitorResponse | clearTableMonitor (ClearTableMonitorRequest request_) |
| Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary{string, string}). More... | |
| ClearTableMonitorResponse | clearTableMonitor (string topic_id, IDictionary< string, string > options=null) |
| Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary{string, string}). More... | |
| ClearTriggerResponse | clearTrigger (ClearTriggerRequest request_) |
| Clears or cancels the trigger identified by the specified handle. More... | |
| ClearTriggerResponse | clearTrigger (string trigger_id, IDictionary< string, string > options=null) |
| Clears or cancels the trigger identified by the specified handle. More... | |
| CollectStatisticsResponse | collectStatistics (CollectStatisticsRequest request_) |
| Collect statistics for a column(s) in a specified table. More... | |
| CollectStatisticsResponse | collectStatistics (string table_name, IList< string > column_names, IDictionary< string, string > options=null) |
| Collect statistics for a column(s) in a specified table. More... | |
| CreateGraphResponse | createGraph (CreateGraphRequest request_) |
| Creates a new graph network using given nodes, edges, weights, and restrictions. More... | |
| CreateGraphResponse | createGraph (string graph_name, bool directed_graph, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null) |
| Creates a new graph network using given nodes, edges, weights, and restrictions. More... | |
| CreateJobResponse | createJob (CreateJobRequest request_) |
| Create a job which will run asynchronously. More... | |
| CreateJobResponse | createJob (string endpoint, string request_encoding, byte[] data, string data_str, IDictionary< string, string > options=null) |
| Create a job which will run asynchronously. More... | |
| CreateJoinTableResponse | createJoinTable (CreateJoinTableRequest request_) |
| Creates a table that is the result of a SQL JOIN. More... | |
| CreateJoinTableResponse | createJoinTable (string join_table_name, IList< string > table_names, IList< string > column_names, IList< string > expressions=null, IDictionary< string, string > options=null) |
| Creates a table that is the result of a SQL JOIN. More... | |
| CreateMaterializedViewResponse | createMaterializedView (CreateMaterializedViewRequest request_) |
| Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name. More... | |
| CreateMaterializedViewResponse | createMaterializedView (string table_name, IDictionary< string, string > options=null) |
| 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. More... | |
| CreateProcResponse | createProc (CreateProcRequest request_) |
| Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More... | |
| CreateProcResponse | createProc (string proc_name, string execution_mode=CreateProcRequest.ExecutionMode.DISTRIBUTED, IDictionary< string, byte[]> files=null, string command="", IList< string > args=null, IDictionary< string, string > options=null) |
| Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More... | |
| CreateProjectionResponse | createProjection (CreateProjectionRequest request_) |
| Creates a new projection of an existing table. More... | |
| CreateProjectionResponse | createProjection (string table_name, string projection_name, IList< string > column_names, IDictionary< string, string > options=null) |
| Creates a new projection of an existing table. More... | |
| CreateResourceGroupResponse | createResourceGroup (CreateResourceGroupRequest request_) |
| Creates a new resource group to facilitate resource management. More... | |
| CreateResourceGroupResponse | createResourceGroup (string name, IDictionary< string, IDictionary< string, string >> tier_attributes, string ranking, string adjoining_resource_group="", IDictionary< string, string > options=null) |
| Creates a new resource group to facilitate resource management. More... | |
| CreateRoleResponse | createRole (CreateRoleRequest request_) |
| Creates a new role. More... | |
| CreateRoleResponse | createRole (string name, IDictionary< string, string > options=null) |
| Creates a new role. More... | |
| CreateTableResponse | createTable (CreateTableRequest request_) |
| Creates a new table or collection. More... | |
| CreateTableResponse | createTable (string table_name, string type_id, IDictionary< string, string > options=null) |
| Creates a new table or collection. More... | |
| CreateTableMonitorResponse | createTableMonitor (CreateTableMonitorRequest request_) |
| Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by ) and forwards event notifications to subscribers via ZMQ. More... | |
| CreateTableMonitorResponse | createTableMonitor (string table_name, IDictionary< string, string > options=null) |
| Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by table_name ) and forwards event notifications to subscribers via ZMQ. More... | |
| CreateTriggerByAreaResponse | createTriggerByArea (CreateTriggerByAreaRequest request_) |
| Sets up an area trigger mechanism for two column_names for one or more tables. More... | |
| CreateTriggerByAreaResponse | createTriggerByArea (string request_id, IList< string > table_names, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null) |
| Sets up an area trigger mechanism for two column_names for one or more tables. More... | |
| CreateTriggerByRangeResponse | createTriggerByRange (CreateTriggerByRangeRequest request_) |
| Sets up a simple range trigger for a column_name for one or more tables. More... | |
| CreateTriggerByRangeResponse | createTriggerByRange (string request_id, IList< string > table_names, string column_name, double min, double max, IDictionary< string, string > options=null) |
| Sets up a simple range trigger for a column_name for one or more tables. More... | |
| CreateTypeResponse | createType (CreateTypeRequest request_) |
| Creates a new type describing the layout or schema of a table. More... | |
| CreateTypeResponse | createType (string type_definition, string label, IDictionary< string, IList< string >> properties=null, IDictionary< string, string > options=null) |
| Creates a new type describing the layout or schema of a table. More... | |
| CreateUnionResponse | createUnion (CreateUnionRequest request_) |
| Merges data from one or more tables with comparable data types into a new table. More... | |
| CreateUnionResponse | createUnion (string table_name, IList< string > table_names, IList< IList< string >> input_column_names, IList< string > output_column_names, IDictionary< string, string > options=null) |
| Merges data from one or more tables with comparable data types into a new table. More... | |
| CreateUserExternalResponse | createUserExternal (CreateUserExternalRequest request_) |
| Creates a new external user (a user whose credentials are managed by an external LDAP). More... | |
| CreateUserExternalResponse | createUserExternal (string name, IDictionary< string, string > options=null) |
| Creates a new external user (a user whose credentials are managed by an external LDAP). More... | |
| CreateUserInternalResponse | createUserInternal (CreateUserInternalRequest request_) |
| Creates a new internal user (a user whose credentials are managed by the database system). More... | |
| CreateUserInternalResponse | createUserInternal (string name, string password, IDictionary< string, string > options=null) |
| Creates a new internal user (a user whose credentials are managed by the database system). More... | |
| DeleteGraphResponse | deleteGraph (DeleteGraphRequest request_) |
| Deletes an existing graph from the graph server and/or persist. More... | |
| DeleteGraphResponse | deleteGraph (string graph_name, IDictionary< string, string > options=null) |
| Deletes an existing graph from the graph server and/or persist. More... | |
| DeleteProcResponse | deleteProc (DeleteProcRequest request_) |
| Deletes a proc. More... | |
| DeleteProcResponse | deleteProc (string proc_name, IDictionary< string, string > options=null) |
| Deletes a proc. More... | |
| DeleteRecordsResponse | deleteRecords (DeleteRecordsRequest request_) |
| Deletes record(s) matching the provided criteria from the given table. More... | |
| DeleteRecordsResponse | deleteRecords (string table_name, IList< string > expressions, IDictionary< string, string > options=null) |
| Deletes record(s) matching the provided criteria from the given table. More... | |
| DeleteResourceGroupResponse | deleteResourceGroup (DeleteResourceGroupRequest request_) |
| Deletes a resource group. More... | |
| DeleteResourceGroupResponse | deleteResourceGroup (string name, IDictionary< string, string > options=null) |
| Deletes a resource group. More... | |
| DeleteRoleResponse | deleteRole (DeleteRoleRequest request_) |
| Deletes an existing role. More... | |
| DeleteRoleResponse | deleteRole (string name, IDictionary< string, string > options=null) |
| Deletes an existing role. More... | |
| DeleteUserResponse | deleteUser (DeleteUserRequest request_) |
| Deletes an existing user. More... | |
| DeleteUserResponse | deleteUser (string name, IDictionary< string, string > options=null) |
| Deletes an existing user. More... | |
| ExecuteProcResponse | executeProc (ExecuteProcRequest request_) |
| Executes a proc. More... | |
| ExecuteProcResponse | executeProc (string proc_name, IDictionary< string, string > _params=null, IDictionary< string, byte[]> bin_params=null, IList< string > input_table_names=null, IDictionary< string, IList< string >> input_column_names=null, IList< string > output_table_names=null, IDictionary< string, string > options=null) |
| Executes a proc. More... | |
| ExecuteSqlResponse | executeSql (ExecuteSqlRequest request_) |
| SQL Request More... | |
| ExecuteSqlResponse | executeSql (string statement, long offset=0, long limit=-9999, string request_schema_str="", IList< byte[]> data=null, IDictionary< string, string > options=null) |
| SQL Request More... | |
| FilterResponse | filter (FilterRequest request_) |
| Filters data based on the specified expression. More... | |
| FilterResponse | filter (string table_name, string view_name, string expression, IDictionary< string, string > options=null) |
| Filters data based on the specified expression. More... | |
| FilterByAreaResponse | filterByArea (FilterByAreaRequest request_) |
| Calculates which objects from a table are within a named area of interest (NAI/polygon). More... | |
| FilterByAreaResponse | filterByArea (string table_name, string view_name, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null) |
| Calculates which objects from a table are within a named area of interest (NAI/polygon). More... | |
| FilterByAreaGeometryResponse | filterByAreaGeometry (FilterByAreaGeometryRequest request_) |
| Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More... | |
| FilterByAreaGeometryResponse | filterByAreaGeometry (string table_name, string view_name, string column_name, IList< double > x_vector, IList< double > y_vector, IDictionary< string, string > options=null) |
| Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More... | |
| FilterByBoxResponse | filterByBox (FilterByBoxRequest request_) |
| Calculates how many objects within the given table lie in a rectangular box. More... | |
| FilterByBoxResponse | filterByBox (string table_name, string view_name, string x_column_name, double min_x, double max_x, string y_column_name, double min_y, double max_y, IDictionary< string, string > options=null) |
| Calculates how many objects within the given table lie in a rectangular box. More... | |
| FilterByBoxGeometryResponse | filterByBoxGeometry (FilterByBoxGeometryRequest request_) |
| Calculates which geospatial geometry objects from a table intersect a rectangular box. More... | |
| FilterByBoxGeometryResponse | filterByBoxGeometry (string table_name, string view_name, string column_name, double min_x, double max_x, double min_y, double max_y, IDictionary< string, string > options=null) |
| Calculates which geospatial geometry objects from a table intersect a rectangular box. More... | |
| FilterByGeometryResponse | filterByGeometry (FilterByGeometryRequest request_) |
| Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More... | |
| FilterByGeometryResponse | filterByGeometry (string table_name, string view_name, string column_name, string input_wkt, string operation, IDictionary< string, string > options=null) |
| Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More... | |
| FilterByListResponse | filterByList (FilterByListRequest request_) |
| Calculates which records from a table have values in the given list for the corresponding column. More... | |
| FilterByListResponse | filterByList (string table_name, string view_name, IDictionary< string, IList< string >> column_values_map, IDictionary< string, string > options=null) |
| Calculates which records from a table have values in the given list for the corresponding column. More... | |
| FilterByRadiusResponse | filterByRadius (FilterByRadiusRequest request_) |
| Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More... | |
| FilterByRadiusResponse | filterByRadius (string table_name, string view_name, string x_column_name, double x_center, string y_column_name, double y_center, double radius, IDictionary< string, string > options=null) |
| Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More... | |
| FilterByRadiusGeometryResponse | filterByRadiusGeometry (FilterByRadiusGeometryRequest request_) |
| Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More... | |
| FilterByRadiusGeometryResponse | filterByRadiusGeometry (string table_name, string view_name, string column_name, double x_center, double y_center, double radius, IDictionary< string, string > options=null) |
| Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More... | |
| FilterByRangeResponse | filterByRange (FilterByRangeRequest request_) |
| Calculates which objects from a table have a column that is within the given bounds. More... | |
| FilterByRangeResponse | filterByRange (string table_name, string view_name, string column_name, double lower_bound, double upper_bound, IDictionary< string, string > options=null) |
| Calculates which objects from a table have a column that is within the given bounds. More... | |
| FilterBySeriesResponse | filterBySeries (FilterBySeriesRequest request_) |
| Filters objects matching all points of the given track (works only on track type data). More... | |
| FilterBySeriesResponse | filterBySeries (string table_name, string view_name, string track_id, IList< string > target_track_ids, IDictionary< string, string > options=null) |
| Filters objects matching all points of the given track (works only on track type data). More... | |
| FilterByStringResponse | filterByString (FilterByStringRequest request_) |
| Calculates which objects from a table, collection, or view match a string expression for the given string columns. More... | |
| FilterByStringResponse | filterByString (string table_name, string view_name, string expression, string mode, IList< string > column_names, IDictionary< string, string > options=null) |
| Calculates which objects from a table, collection, or view match a string expression for the given string columns. More... | |
| FilterByTableResponse | filterByTable (FilterByTableRequest request_) |
| Filters objects in one table based on objects in another table. More... | |
| FilterByTableResponse | filterByTable (string table_name, string view_name, string column_name, string source_table_name, string source_table_column_name, IDictionary< string, string > options=null) |
| Filters objects in one table based on objects in another table. More... | |
| FilterByValueResponse | filterByValue (FilterByValueRequest request_) |
| Calculates which objects from a table has a particular value for a particular column. More... | |
| FilterByValueResponse | filterByValue (string table_name, string view_name, bool is_string, double _value, string value_str, string column_name, IDictionary< string, string > options=null) |
| Calculates which objects from a table has a particular value for a particular column. More... | |
| GetJobResponse | getJob (GetJobRequest request_) |
| Get the status and result of asynchronously running job. More... | |
| GetJobResponse | getJob (long job_id, IDictionary< string, string > options=null) |
| Get the status and result of asynchronously running job. More... | |
| GetRecordsResponse< T > | getRecords< T > (GetRecordsRequest request_) |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| GetRecordsResponse< T > | getRecords< T > (string table_name, long offset=0, long limit=-9999, IDictionary< string, string > options=null) |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| GetRecordsByColumnResponse | getRecordsByColumn (GetRecordsByColumnRequest request_) |
| For a given table, retrieves the values from the requested column(s). More... | |
| GetRecordsByColumnResponse | getRecordsByColumn (string table_name, IList< string > column_names, long offset=0, long limit=-9999, IDictionary< string, string > options=null) |
| For a given table, retrieves the values from the requested column(s). More... | |
| GetRecordsBySeriesResponse< T > | getRecordsBySeries< T > (GetRecordsBySeriesRequest request_) |
| Retrieves the complete series/track records from the given based on the partial track information contained in the . More... | |
| GetRecordsBySeriesResponse< T > | getRecordsBySeries< T > (string table_name, string world_table_name, int offset=0, int limit=250, IDictionary< string, string > options=null) |
| Retrieves the complete series/track records from the given world_table_name based on the partial track information contained in the table_name . More... | |
| GetRecordsFromCollectionResponse < T > | getRecordsFromCollection< T > (GetRecordsFromCollectionRequest request_) |
| Retrieves records from a collection. More... | |
| GetRecordsFromCollectionResponse < T > | getRecordsFromCollection< T > (string table_name, long offset=0, long limit=-9999, IDictionary< string, string > options=null) |
| Retrieves records from a collection. More... | |
| GrantPermissionProcResponse | grantPermissionProc (GrantPermissionProcRequest request_) |
| Grants a proc-level permission to a user or role. More... | |
| GrantPermissionProcResponse | grantPermissionProc (string name, string permission, string proc_name, IDictionary< string, string > options=null) |
| Grants a proc-level permission to a user or role. More... | |
| GrantPermissionSystemResponse | grantPermissionSystem (GrantPermissionSystemRequest request_) |
| Grants a system-level permission to a user or role. More... | |
| GrantPermissionSystemResponse | grantPermissionSystem (string name, string permission, IDictionary< string, string > options=null) |
| Grants a system-level permission to a user or role. More... | |
| GrantPermissionTableResponse | grantPermissionTable (GrantPermissionTableRequest request_) |
| Grants a table-level permission to a user or role. More... | |
| GrantPermissionTableResponse | grantPermissionTable (string name, string permission, string table_name, string filter_expression="", IDictionary< string, string > options=null) |
| Grants a table-level permission to a user or role. More... | |
| GrantRoleResponse | grantRole (GrantRoleRequest request_) |
| Grants membership in a role to a user or role. More... | |
| GrantRoleResponse | grantRole (string role, string member, IDictionary< string, string > options=null) |
| Grants membership in a role to a user or role. More... | |
| HasProcResponse | hasProc (HasProcRequest request_) |
| Checks the existence of a proc with the given name. More... | |
| HasProcResponse | hasProc (string proc_name, IDictionary< string, string > options=null) |
| Checks the existence of a proc with the given name. More... | |
| HasTableResponse | hasTable (HasTableRequest request_) |
| Checks for the existence of a table with the given name. More... | |
| HasTableResponse | hasTable (string table_name, IDictionary< string, string > options=null) |
| Checks for the existence of a table with the given name. More... | |
| HasTypeResponse | hasType (HasTypeRequest request_) |
| Check for the existence of a type. More... | |
| HasTypeResponse | hasType (string type_id, IDictionary< string, string > options=null) |
| Check for the existence of a type. More... | |
| InsertRecordsResponse | insertRecordsRaw (RawInsertRecordsRequest request_) |
| Adds multiple records to the specified table. More... | |
| InsertRecordsResponse | insertRecords< T > (InsertRecordsRequest< T > request_) |
| Adds multiple records to the specified table. More... | |
| InsertRecordsResponse | insertRecords< T > (string table_name, IList< T > data, IDictionary< string, string > options=null) |
| Adds multiple records to the specified table. More... | |
| InsertRecordsFromFilesResponse | insertRecordsFromFiles (InsertRecordsFromFilesRequest request_) |
| Reads from one or more files located on the server and inserts the data into a new or existing table. More... | |
| InsertRecordsFromFilesResponse | insertRecordsFromFiles (string table_name, IList< string > filepaths, IDictionary< string, string > create_table_options=null, IDictionary< string, string > options=null) |
| Reads from one or more files located on the server and inserts the data into a new or existing table. More... | |
| InsertRecordsRandomResponse | insertRecordsRandom (InsertRecordsRandomRequest request_) |
| Generates a specified number of random records and adds them to the given table. More... | |
| InsertRecordsRandomResponse | insertRecordsRandom (string table_name, long count, IDictionary< string, IDictionary< string, double >> options=null) |
| Generates a specified number of random records and adds them to the given table. More... | |
| InsertSymbolResponse | insertSymbol (InsertSymbolRequest request_) |
| Adds a symbol or icon (i.e. More... | |
| InsertSymbolResponse | insertSymbol (string symbol_id, string symbol_format, byte[] symbol_data, IDictionary< string, string > options=null) |
| Adds a symbol or icon (i.e. More... | |
| KillProcResponse | killProc (KillProcRequest request_) |
| Kills a running proc instance. More... | |
| KillProcResponse | killProc (string run_id="", IDictionary< string, string > options=null) |
| Kills a running proc instance. More... | |
| LockTableResponse | lockTable (LockTableRequest request_) |
| Manages global access to a table's data. More... | |
| LockTableResponse | lockTable (string table_name, string lock_type=LockTableRequest.LockType.STATUS, IDictionary< string, string > options=null) |
| Manages global access to a table's data. More... | |
| MatchGraphResponse | matchGraph (MatchGraphRequest request_) |
| Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type. More... | |
| MatchGraphResponse | matchGraph (string graph_name, IList< string > sample_points, string solve_method=MatchGraphRequest.SolveMethod.MARKOV_CHAIN, string solution_table="", IDictionary< string, string > options=null) |
| 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. More... | |
| MergeRecordsResponse | mergeRecords (MergeRecordsRequest request_) |
| Create a new empty result table (specified by ), and insert all records from source tables (specified by ) based on the field mapping information (specified by ). More... | |
| MergeRecordsResponse | mergeRecords (string table_name, IList< string > source_table_names, IList< IDictionary< string, string >> field_maps, IDictionary< string, string > options=null) |
| Create a new empty result table (specified by table_name ), and insert all records from source tables (specified by source_table_names ) based on the field mapping information (specified by field_maps ). More... | |
| ModifyGraphResponse | modifyGraph (ModifyGraphRequest request_) |
| Update an existing graph network using given nodes, edges, weights, restrictions, and options. More... | |
| ModifyGraphResponse | modifyGraph (string graph_name, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null) |
| Update an existing graph network using given nodes, edges, weights, restrictions, and options. More... | |
| QueryGraphResponse | queryGraph (QueryGraphRequest request_) |
| Employs a topological query on a network graph generated a-priori by Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) 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. More... | |
| QueryGraphResponse | queryGraph (string graph_name, IList< string > queries, IList< string > restrictions=null, string adjacency_table="", int rings=1, IDictionary< string, string > options=null) |
| Employs a topological query on a network graph generated a-priori by Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) 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. More... | |
| RevokePermissionProcResponse | revokePermissionProc (RevokePermissionProcRequest request_) |
| Revokes a proc-level permission from a user or role. More... | |
| RevokePermissionProcResponse | revokePermissionProc (string name, string permission, string proc_name, IDictionary< string, string > options=null) |
| Revokes a proc-level permission from a user or role. More... | |
| RevokePermissionSystemResponse | revokePermissionSystem (RevokePermissionSystemRequest request_) |
| Revokes a system-level permission from a user or role. More... | |
| RevokePermissionSystemResponse | revokePermissionSystem (string name, string permission, IDictionary< string, string > options=null) |
| Revokes a system-level permission from a user or role. More... | |
| RevokePermissionTableResponse | revokePermissionTable (RevokePermissionTableRequest request_) |
| Revokes a table-level permission from a user or role. More... | |
| RevokePermissionTableResponse | revokePermissionTable (string name, string permission, string table_name, IDictionary< string, string > options=null) |
| Revokes a table-level permission from a user or role. More... | |
| RevokeRoleResponse | revokeRole (RevokeRoleRequest request_) |
| Revokes membership in a role from a user or role. More... | |
| RevokeRoleResponse | revokeRole (string role, string member, IDictionary< string, string > options=null) |
| Revokes membership in a role from a user or role. More... | |
| ShowGraphResponse | showGraph (ShowGraphRequest request_) |
| Shows information and characteristics of graphs that exist on the graph server. More... | |
| ShowGraphResponse | showGraph (string graph_name="", IDictionary< string, string > options=null) |
| Shows information and characteristics of graphs that exist on the graph server. More... | |
| ShowProcResponse | showProc (ShowProcRequest request_) |
| Shows information about a proc. More... | |
| ShowProcResponse | showProc (string proc_name="", IDictionary< string, string > options=null) |
| Shows information about a proc. More... | |
| ShowProcStatusResponse | showProcStatus (ShowProcStatusRequest request_) |
| Shows the statuses of running or completed proc instances. More... | |
| ShowProcStatusResponse | showProcStatus (string run_id="", IDictionary< string, string > options=null) |
| Shows the statuses of running or completed proc instances. More... | |
| ShowResourceStatisticsResponse | showResourceStatistics (ShowResourceStatisticsRequest request_) |
| Requests various statistics for storage/memory tiers and resource groups. More... | |
| ShowResourceStatisticsResponse | showResourceStatistics (IDictionary< string, string > options=null) |
| Requests various statistics for storage/memory tiers and resource groups. More... | |
| ShowResourceGroupsResponse | showResourceGroups (ShowResourceGroupsRequest request_) |
| Requests resource group properties. More... | |
| ShowResourceGroupsResponse | showResourceGroups (IList< string > names, IDictionary< string, string > options=null) |
| Requests resource group properties. More... | |
| ShowSecurityResponse | showSecurity (ShowSecurityRequest request_) |
| Shows security information relating to users and/or roles. More... | |
| ShowSecurityResponse | showSecurity (IList< string > names, IDictionary< string, string > options=null) |
| Shows security information relating to users and/or roles. More... | |
| ShowSqlProcResponse | showSqlProc (ShowSqlProcRequest request_) |
| Shows information about SQL procedures, including the full definition of each requested procedure. More... | |
| ShowSqlProcResponse | showSqlProc (string procedure_name="", IDictionary< string, string > options=null) |
| Shows information about SQL procedures, including the full definition of each requested procedure. More... | |
| ShowStatisticsResponse | showStatistics (ShowStatisticsRequest request_) |
| Retrieves the collected column statistics for the specified table. More... | |
| ShowStatisticsResponse | showStatistics (IList< string > table_names, IDictionary< string, string > options=null) |
| Retrieves the collected column statistics for the specified table. More... | |
| ShowSystemPropertiesResponse | showSystemProperties (ShowSystemPropertiesRequest request_) |
| Returns server configuration and version related information to the caller. More... | |
| ShowSystemPropertiesResponse | showSystemProperties (IDictionary< string, string > options=null) |
| Returns server configuration and version related information to the caller. More... | |
| ShowSystemStatusResponse | showSystemStatus (ShowSystemStatusRequest request_) |
| Provides server configuration and health related status to the caller. More... | |
| ShowSystemStatusResponse | showSystemStatus (IDictionary< string, string > options=null) |
| Provides server configuration and health related status to the caller. More... | |
| ShowSystemTimingResponse | showSystemTiming (ShowSystemTimingRequest request_) |
| Returns the last 100 database requests along with the request timing and internal job id. More... | |
| ShowSystemTimingResponse | showSystemTiming (IDictionary< string, string > options=null) |
| Returns the last 100 database requests along with the request timing and internal job id. More... | |
| ShowTableResponse | showTable (ShowTableRequest request_) |
| Retrieves detailed information about a table, view, or collection, specified in . More... | |
| ShowTableResponse | showTable (string table_name, IDictionary< string, string > options=null) |
| Retrieves detailed information about a table, view, or collection, specified in table_name . More... | |
| ShowTableMetadataResponse | showTableMetadata (ShowTableMetadataRequest request_) |
| Retrieves the user provided metadata for the specified tables. More... | |
| ShowTableMetadataResponse | showTableMetadata (IList< string > table_names, IDictionary< string, string > options=null) |
| Retrieves the user provided metadata for the specified tables. More... | |
| ShowTablesByTypeResponse | showTablesByType (ShowTablesByTypeRequest request_) |
| Gets names of the tables whose type matches the given criteria. More... | |
| ShowTablesByTypeResponse | showTablesByType (string type_id, string label, IDictionary< string, string > options=null) |
| Gets names of the tables whose type matches the given criteria. More... | |
| ShowTriggersResponse | showTriggers (ShowTriggersRequest request_) |
| Retrieves information regarding the specified triggers or all existing triggers currently active. More... | |
| ShowTriggersResponse | showTriggers (IList< string > trigger_ids, IDictionary< string, string > options=null) |
| Retrieves information regarding the specified triggers or all existing triggers currently active. More... | |
| ShowTypesResponse | showTypes (ShowTypesRequest request_) |
| Retrieves information for the specified data type ID or type label. More... | |
| ShowTypesResponse | showTypes (string type_id, string label, IDictionary< string, string > options=null) |
| Retrieves information for the specified data type ID or type label. More... | |
| SolveGraphResponse | solveGraph (SolveGraphRequest request_) |
| Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions. More... | |
| SolveGraphResponse | solveGraph (string graph_name, IList< string > weights_on_edges=null, IList< string > restrictions=null, string solver_type=SolveGraphRequest.SolverType.SHORTEST_PATH, IList< string > source_nodes=null, IList< string > destination_nodes=null, string solution_table="graph_solutions", IDictionary< string, string > options=null) |
| 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. More... | |
| UpdateRecordsResponse | updateRecordsRaw (RawUpdateRecordsRequest request_) |
| Runs multiple predicate-based updates in a single call. More... | |
| UpdateRecordsResponse | updateRecords< T > (UpdateRecordsRequest< T > request_) |
| Runs multiple predicate-based updates in a single call. More... | |
| UpdateRecordsResponse | updateRecords< T > (string table_name, IList< string > expressions, IList< IDictionary< string, string >> new_values_maps, IList< T > data=null, IDictionary< string, string > options=null) |
| Runs multiple predicate-based updates in a single call. More... | |
| UpdateRecordsBySeriesResponse | updateRecordsBySeries (UpdateRecordsBySeriesRequest request_) |
| Updates the view specified by to include full series (track) information from the for the series (tracks) present in the . More... | |
| UpdateRecordsBySeriesResponse | updateRecordsBySeries (string table_name, string world_table_name, string view_name="", IList< string > reserved=null, IDictionary< string, string > options=null) |
| Updates the view specified by table_name to include full series (track) information from the world_table_name for the series (tracks) present in the view_name . More... | |
| VisualizeImageChartResponse | visualizeImageChart (VisualizeImageChartRequest request_) |
| Scatter plot is the only plot type currently supported. More... | |
| VisualizeImageChartResponse | visualizeImageChart (string table_name, IList< string > x_column_names, IList< string > y_column_names, double min_x, double max_x, double min_y, double max_y, int width, int height, string bg_color, IDictionary< string, IList< string >> style_options, IDictionary< string, string > options=null) |
| Scatter plot is the only plot type currently supported. More... | |
| VisualizeIsochroneResponse | visualizeIsochrone (VisualizeIsochroneRequest request_) |
| Generate an image containing isolines for travel results using an existing graph. More... | |
| VisualizeIsochroneResponse | visualizeIsochrone (string graph_name, string source_node, double max_solution_radius, IList< string > weights_on_edges, IList< string > restrictions, int num_levels, bool generate_image, string levels_table, IDictionary< string, string > style_options, IDictionary< string, string > solve_options=null, IDictionary< string, string > contour_options=null, IDictionary< string, string > options=null) |
| Generate an image containing isolines for travel results using an existing graph. More... | |
Static Public Member Functions | |
| static string | GetApiVersion () |
| API Version More... | |
Public Attributes | |
| const int | END_OF_SET = -9999 |
| No Limit More... | |
| const string | API_VERSION = "7.0.19.0" |
Properties | |
| string | Url [get, set] |
| URL for Kinetica Server (including "http:" and port) as a string More... | |
| Uri | URL [get, set] |
| URL for Kinetica Server (including "http:" and port) More... | |
| string | Username [get, set] |
| Optional: User Name for Kinetica security More... | |
| bool | UseSnappy = null [get, set] |
| Use Snappy More... | |
| int | ThreadCount = false [get, set] |
| Thread Count More... | |
API to talk to Kinetica Database
Definition at line 40 of file Kinetica.cs.
|
inline |
API Constructor
| url_str | URL for Kinetica Server (including "http:" and port) |
| options | Optional connection options |
Definition at line 128 of file Kinetica.cs.
|
inline |
Given a table name, add its record type to enable proper encoding of records for insertion or updates.
| table_name | Name of the table. |
| obj_type | The type associated with the table. |
Definition at line 158 of file Kinetica.cs.
|
inline |
Add one or more new ranks to the Kinetica cluster.
The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see Kinetica.adminRebalance(IDictionary{string, string}).
For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:
| request_ | Request object containing the parameters for the operation. |
Definition at line 58 of file KineticaFunctions.cs.
|
inline |
Add one or more new ranks to the Kinetica cluster.
The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see Kinetica.adminRebalance(IDictionary{string, string}).
For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:
| hosts | The IP address of each rank being added to the cluster. Insert one entry per rank, even if they are on the same host. The order of the hosts in the array only matters as it relates to the . |
| config_params | Configuration parameters to apply to the new ranks, e.g., which GPU to use. Configuration parameters that start with 'rankN.', where N is the rank number, should omit the N, as the new rank number(s) are not allocated until the ranks are created. Each entry in this array corresponds to the entry at the same array index in the . This array must either be completely empty or have the same number of elements as the hosts array. An empty array will result in the new ranks being set only with default parameters. |
| options | Optional parameters.
|
Definition at line 137 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 159 of file KineticaFunctions.cs.
|
inline |
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.
| job_ids | Jobs to be modified. |
| action | Action to be performed on the jobs specified by job_ids. Supported values: |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 191 of file KineticaFunctions.cs.
|
inline |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
| request_ | Request object containing the parameters for the operation. |
Definition at line 209 of file KineticaFunctions.cs.
|
inline |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
| offline | Set to true if desired state is offline. Supported values: |
| options | Optional parameters.
|
Definition at line 257 of file KineticaFunctions.cs.
|
inline |
Rebalance the cluster so that all the nodes contain approximately an equal number of records.
The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.
This endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}).
| request_ | Request object containing the parameters for the operation. |
Definition at line 281 of file KineticaFunctions.cs.
|
inline |
Rebalance the cluster so that all the nodes contain approximately an equal number of records.
The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.
This endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}).
| options | Optional parameters.
|
Definition at line 443 of file KineticaFunctions.cs.
|
inline |
Remove one or more ranks from the cluster.
All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the .
Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}).
| request_ | Request object containing the parameters for the operation. |
Definition at line 468 of file KineticaFunctions.cs.
|
inline |
Remove one or more ranks from the cluster.
All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options .
Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}).
| ranks | Rank numbers of the ranks to be removed from the cluster. |
| options | Optional parameters.
|
Definition at line 552 of file KineticaFunctions.cs.
|
inline |
Requests a list of the most recent alerts.
Returns lists of alert data, including timestamp and type.
| request_ | Request object containing the parameters for the operation. |
Definition at line 569 of file KineticaFunctions.cs.
|
inline |
Requests a list of the most recent alerts.
Returns lists of alert data, including timestamp and type.
| num_alerts | Number of most recent alerts to request. The response will include up to depending on how many alerts there are in the system. A value of 0 returns all stored alerts. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 592 of file KineticaFunctions.cs.
|
inline |
Requests the detailed status of the current operation (by default) or a prior cluster operation specified by .
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
| request_ | Request object containing the parameters for the operation. |
Definition at line 613 of file KineticaFunctions.cs.
|
inline |
Requests the detailed status of the current operation (by default) or a prior cluster operation specified by history_index .
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
| history_index | Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 638 of file KineticaFunctions.cs.
|
inline |
Get a list of the current jobs in GPUdb.
| request_ | Request object containing the parameters for the operation. |
Definition at line 655 of file KineticaFunctions.cs.
|
inline |
Get a list of the current jobs in GPUdb.
| options | Optional parameters.
|
Definition at line 693 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 710 of file KineticaFunctions.cs.
|
inline |
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.
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 729 of file KineticaFunctions.cs.
|
inline |
Exits the database server application.
| request_ | Request object containing the parameters for the operation. |
Definition at line 743 of file KineticaFunctions.cs.
|
inline |
Exits the database server application.
| exit_type | Reserved for future use. User can pass an empty string. |
| authorization | No longer used. User can pass an empty string. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 763 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 783 of file KineticaFunctions.cs.
|
inline |
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.
| options | Optional parameters.
|
Definition at line 898 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the convex hull for the values in a table specified by .
| request_ | Request object containing the parameters for the operation. |
Definition at line 914 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the convex hull for the values in a table specified by table_name .
| table_name | Name of table on which the operation will be performed. Must be an existing table. It cannot be a collection. |
| x_column_name | Name of the column containing the x coordinates of the points for the operation being performed. |
| y_column_name | Name of the column containing the y coordinates of the points for the operation being performed. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 940 of file KineticaFunctions.cs.
|
inline |
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.
The results can be paged via the and parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected ( is 0 and is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of is an unrestricted-length string.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1035 of file KineticaFunctions.cs.
|
inline |
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.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of column_names is an unrestricted-length string.
| table_name | Name of an existing table or view on which the operation will be performed. |
| column_names | List of one or more column names, expressions, and aggregate expressions. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999. |
| options | Optional parameters.
|
Definition at line 1378 of file KineticaFunctions.cs.
|
inline |
Performs a histogram calculation given a table, a column, and an interval function.
The is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1413 of file KineticaFunctions.cs.
|
inline |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.
| table_name | Name of the table on which the operation will be performed. Must be an existing table or collection. |
| column_name | Name of a column or an expression of one or more column names over which the histogram will be calculated. |
| start | Lower end value of the histogram interval, inclusive. |
| end | Upper end value of the histogram interval, inclusive. |
| interval | The size of each bin within the start and end parameters. |
| options | Optional parameters.
|
Definition at line 1464 of file KineticaFunctions.cs.
|
inline |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1498 of file KineticaFunctions.cs.
|
inline |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| table_name | Name of the table on which the operation will be performed. Must be an existing table or collection. |
| column_names | List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns. |
| k | The number of mean points to be determined by the algorithm. |
| tolerance | Stop iterating when the distances between successive points is less than the given tolerance. |
| options | Optional parameters.
|
Definition at line 1558 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum values of a particular column in a table.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1578 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum values of a particular column in a table.
| table_name | Name of the table on which the operation will be performed. Must be an existing table. |
| column_name | Name of a column or an expression of one or more column on which the min-max will be calculated. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 1599 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1618 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
| table_name | Name of the table on which the operation will be performed. Must be an existing table. |
| column_name | Name of a geospatial geometry column on which the min-max will be calculated. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 1640 of file KineticaFunctions.cs.
|
inline |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight_column_name to be specified in . The weighted average is then defined as the sum of the products of times the weight_column_name values divided by the sum of the weight_column_name values.
Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1703 of file KineticaFunctions.cs.
|
inline |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight_column_name to be specified in options . The weighted average is then defined as the sum of the products of column_name times the weight_column_name values divided by the sum of the weight_column_name values.
Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of column_name x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
| table_name | Name of the table on which the statistics operation will be performed. |
| column_name | Name of the primary column for which the statistics are to be calculated. |
| stats | Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
|
| options | Optional parameters.
|
Definition at line 1875 of file KineticaFunctions.cs.
|
inline |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in . The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.
There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1922 of file KineticaFunctions.cs.
|
inline |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in options . The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.
There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, options bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| table_name | Name of the table on which the ranged-statistics operation will be performed. |
| select_expression | For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''. |
| column_name | Name of the binning-column used to divide the set samples into bins. |
| value_column_name | Name of the value-column for which statistics are to be computed. |
| stats | A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum. |
| start | The lower bound of the binning-column. |
| end | The upper bound of the binning-column. |
| interval | The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval*i, start+interval*(i+1)). |
| options | Map of optional parameters:
|
Definition at line 2011 of file KineticaFunctions.cs.
|
inline |
Returns all the unique values from a particular column (specified by ) of a particular table or view (specified by ).
If is a numeric column the values will be in . Otherwise if is a string column the values will be in . The results can be paged via the and parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the , the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of is an unrestricted-length string.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2084 of file KineticaFunctions.cs.
|
inline |
Returns all the unique values from a particular column (specified by column_name ) of a particular table or view (specified by table_name ).
If column_name is a numeric column the values will be in . Otherwise if column_name is a string column the values will be in . The results can be paged via the offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the column_name , the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of column_name is an unrestricted-length string.
| table_name | Name of an existing table or view on which the operation will be performed. |
| column_name | Name of the column or an expression containing one or more column names on which the unique function would be applied. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999. |
| options | Optional parameters.
|
Definition at line 2291 of file KineticaFunctions.cs.
|
inline |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2327 of file KineticaFunctions.cs.
|
inline |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| table_name | Name of the table on which the operation will be performed. Must be an existing table/view. |
| column_names | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. |
| variable_column_name | Specifies the variable/parameter column name. The default value is ''. |
| value_column_name | Specifies the value column name. The default value is ''. |
| pivoted_columns | List of one or more values typically the column names of the input table. All the columns in the source table must have the same data type. |
| options | Optional parameters.
|
Definition at line 2512 of file KineticaFunctions.cs.
|
inline |
Alters the properties of an exisiting resource group to facilitate resource management.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2536 of file KineticaFunctions.cs.
|
inline |
Alters the properties of an exisiting resource group to facilitate resource management.
| name | Name of the group to be altered. Must be an existing resource group name. |
| tier_attributes | Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}
|
| ranking | If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be moved; leave blank if not changing the ranking. When using before or after, specify which resource group this one will be inserted before or after in . Supported values: The default value is EMPTY_STRING. |
| adjoining_resource_group | If is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ''. |
| options | Optional parameters.
|
Definition at line 2650 of file KineticaFunctions.cs.
|
inline |
Alters a Role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2672 of file KineticaFunctions.cs.
|
inline |
Alters a Role.
| name | Name of the role to be altered. Must be an existing role. |
| action | Modification operation to be applied to the role. Supported values:
|
| _value | The value of the modification, depending on . |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 2704 of file KineticaFunctions.cs.
|
inline |
The Kinetica.alterSystemProperties(IDictionary{string, string},IDictionary{string, string}) 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 whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
| request_ | Request object containing the parameters for the operation. |
Definition at line 2729 of file KineticaFunctions.cs.
|
inline |
The Kinetica.alterSystemProperties(IDictionary{string, string},IDictionary{string, string}) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.
Commands are given through the property_updates_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
| property_updates_map | Map containing the properties of the system to be updated. Error if empty.
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 2953 of file KineticaFunctions.cs.
|
inline |
Apply various modifications to a table, view, or collection.
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 compressed or not.
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Create or delete a foreign key on a particular column.
Manage a range-partitioned or a manual list-partitioned table's partitions.
Set (or reset) the tier strategy of a table or view.
Refresh and manage the refresh mode of a materialized view.
Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3028 of file KineticaFunctions.cs.
|
inline |
Apply various modifications to a table, view, or collection.
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 compressed or not.
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Create or delete a foreign key on a particular column.
Manage a range-partitioned or a manual list-partitioned table's partitions.
Set (or reset) the tier strategy of a table or view.
Refresh and manage the refresh mode of a materialized view.
Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
| table_name | Table on which the operation will be performed. Must be an existing table, view, or collection. |
| action | Modification operation to be applied Supported values:
|
| _value | The value of the modification, depending on . For example, if is add_column, this would be the column name; while the column's definition would be covered by the column_type, column_properties, column_default_value, and add_column_expression in . If is ttl, it would be the number of minutes for the new TTL. If is refresh, this field would be blank. |
| options | Optional parameters.
|
Definition at line 3519 of file KineticaFunctions.cs.
|
inline |
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.
Set or unset compression for a column.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3555 of file KineticaFunctions.cs.
|
inline |
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.
Set or unset compression for a column.
| table_name | Table on which the operation will be performed. Must be an existing table or view. |
| column_alterations | list of alter table add/delete/change column requests - all for the same table. each request is a map that includes 'column_name', 'action' and the options specific for the action, note that the same options as in alter table requests but in the same map as the column name and the action. For example: [{'column_name':'col_1','action':'change_column','rename_column':'col_2'}, {'column_name':'col_1','action':'add_column', 'type':'int','default_value':'1'} ] |
| options | Optional parameters. |
Definition at line 3602 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3624 of file KineticaFunctions.cs.
|
inline |
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.
| table_names | Names of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned. |
| metadata_map | A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 3652 of file KineticaFunctions.cs.
|
inline |
Alters properties of an exisiting tier to facilitate resource management.
To disable watermark-based eviction, set both high_watermark and low_watermark to 100.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3678 of file KineticaFunctions.cs.
|
inline |
Alters properties of an exisiting tier to facilitate resource management.
To disable watermark-based eviction, set both high_watermark and low_watermark to 100.
| name | Name of the tier to be altered. Must be an existing tier group name. |
| options | Optional parameters.
|
Definition at line 3726 of file KineticaFunctions.cs.
|
inline |
Alters a user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3741 of file KineticaFunctions.cs.
|
inline |
Alters a user.
| name | Name of the user to be altered. Must be an existing user. |
| action | Modification operation to be applied to the user. Supported values:
|
| _value | The value of the modification, depending on . |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 3779 of file KineticaFunctions.cs.
|
inline |
Append (or insert) all records from a source table (specified by ) to a particular target table (specified by ).
The field map (specified by ) holds the user specified map of target table column names with their mapped source column names.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3803 of file KineticaFunctions.cs.
|
inline |
Append (or insert) all records from a source table (specified by source_table_name ) to a particular target table (specified by table_name ).
The field map (specified by field_map ) holds the user specified map of target table column names with their mapped source column names.
| table_name | The table name for the records to be appended. Must be an existing table. |
| source_table_name | The source table name to get records from. Must be an existing table name. |
| field_map | Contains the mapping of column names from the target table (specified by ) as the keys, and corresponding column names or expressions (e.g., 'col_name+1') from the source table (specified by ). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions. |
| options | Optional parameters.
|
Definition at line 3926 of file KineticaFunctions.cs.
|
inline |
Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3945 of file KineticaFunctions.cs.
|
inline |
Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
| table_name | Name of a table. Must be an existing table. The default value is ''. |
| column_name | Name of the column in for which to clear statistics. The column must be from an existing table. An empty string clears statistics for all columns in the table. The default value is ''. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 3969 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3990 of file KineticaFunctions.cs.
|
inline |
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.
| table_name | Name of the table to be cleared. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''. |
| authorization | No longer used. User can pass an empty string. The default value is ''. |
| options | Optional parameters.
|
Definition at line 4040 of file KineticaFunctions.cs.
|
inline |
Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary{string, string}).
| request_ | Request object containing the parameters for the operation. |
Definition at line 4058 of file KineticaFunctions.cs.
|
inline |
Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary{string, string}).
| topic_id | The topic ID returned by /create/tablemonitor. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4078 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 4096 of file KineticaFunctions.cs.
|
inline |
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.
| trigger_id | ID for the trigger to be deactivated. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4117 of file KineticaFunctions.cs.
|
inline |
Collect statistics for a column(s) in a specified table.
| request_ | Request object containing the parameters for the operation. |
Definition at line 4133 of file KineticaFunctions.cs.
|
inline |
Collect statistics for a column(s) in a specified table.
| table_name | Name of a table. Must be an existing table. |
| column_names | List of one or more column names in for which to collect statistics (cardinality, mean value, etc.). |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4155 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 4441 of file KineticaFunctions.cs.
|
inline |
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.
| graph_name | Name of the graph resource to generate. |
| directed_graph | If set to true, the graph will be directed. If set to false, the graph will not be directed. Consult Directed Graphs for more details. Supported values: The default value is TRUE. |
| nodes | Nodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination. |
| edges | Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination. |
| weights | Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination. |
| restrictions | Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination. |
| options | Optional parameters.
|
Definition at line 4812 of file KineticaFunctions.cs.
|
inline |
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 Kinetica.getJob(long,IDictionary{string, string}).
| request_ | Request object containing the parameters for the operation. |
Definition at line 4839 of file KineticaFunctions.cs.
|
inline |
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 Kinetica.getJob(long,IDictionary{string, string}).
| endpoint | Indicates which endpoint to execute, e.g. '/alter/table'. |
| request_encoding | The encoding of the request payload for the job. Supported values: The default value is BINARY. |
| data | Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then must be binary or snappy. |
| data_str | JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then must be json. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4898 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 4923 of file KineticaFunctions.cs.
|
inline |
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.
| join_table_name | Name of the join table to be created. Has the same naming restrictions as tables. |
| table_names | The list of table names composing the join. Corresponds to a SQL statement FROM clause. |
| column_names | List of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions composing the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables. |
| expressions | An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 5028 of file KineticaFunctions.cs.
|
inline |
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 , which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5059 of file KineticaFunctions.cs.
|
inline |
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 , which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| table_name | Name of the table to be created that is the top-level table of the materialized view. |
| options | Optional parameters.
|
Definition at line 5179 of file KineticaFunctions.cs.
|
inline |
Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.
For details on UDFs, see: User-Defined Functions
| request_ | Request object containing the parameters for the operation. |
Definition at line 5199 of file KineticaFunctions.cs.
|
inline |
Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.
For details on UDFs, see: User-Defined Functions
| proc_name | Name of the proc to be created. Must not be the name of a currently existing proc. |
| execution_mode | The execution mode of the proc. Supported values:
|
| files | A map of the files that make up the proc. The keys of the map are file names, and the values are the binary contents of the files. The file names may include subdirectory names (e.g. 'subdir/file') but must not resolve to a directory above the root for the proc. The default value is an empty Dictionary. |
| command | The command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc and may be any command that can be resolved from that directory. It need not refer to a file actually in that directory; for example, it could be 'java' if the proc is a Java application; however, any necessary external programs must be preinstalled on every database node. If the command refers to a file in that directory, it must be preceded with './' as per Linux convention. If not specified, and exactly one file is provided in , that file will be invoked. The default value is ''. |
| args | An array of command-line arguments that will be passed to when the proc is executed. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 5275 of file KineticaFunctions.cs.
|
inline |
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 Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}).
A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.
If is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
| request_ | Request object containing the parameters for the operation. |
Definition at line 5327 of file KineticaFunctions.cs.
|
inline |
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 Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}).
A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.
If table_name is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
| table_name | Name of the existing table on which the projection is to be applied. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions. |
| projection_name | Name of the projection to be created. Has the same naming restrictions as tables. |
| column_names | List of columns from to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax 'column_name as alias'. |
| options | Optional parameters.
|
Definition at line 5564 of file KineticaFunctions.cs.
|
inline |
Creates a new resource group to facilitate resource management.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5584 of file KineticaFunctions.cs.
|
inline |
Creates a new resource group to facilitate resource management.
| name | Name of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name. |
| tier_attributes | Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}
|
| ranking | Indicates the relative ranking among existing resource groups where this new resource group will be placed. When using before or after, specify which resource group this one will be inserted before or after in . Supported values: |
| adjoining_resource_group | If is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ''. |
| options | Optional parameters.
|
Definition at line 5669 of file KineticaFunctions.cs.
|
inline |
Creates a new role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5691 of file KineticaFunctions.cs.
|
inline |
Creates a new role.
| name | Name of the role to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role. |
| options | Optional parameters.
|
Definition at line 5719 of file KineticaFunctions.cs.
|
inline |
Creates a new table or collection.
If a new table is being created, the type of the table is given by , which must be the ID of a currently registered type (i.e. one created via Kinetica.createType(string,string,IDictionary{string, IList{string}},IDictionary{string, string})). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.
To create a new collection, specify the name of the collection in and set the is_collection option to true; will be ignored.
A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5760 of file KineticaFunctions.cs.
|
inline |
Creates a new table or collection.
If a new table is being created, the type of the table is given by type_id , which must be the ID of a currently registered type (i.e. one created via Kinetica.createType(string,string,IDictionary{string, IList{string}},IDictionary{string, string})). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.
To create a new collection, specify the name of the collection in table_name and set the is_collection option to true; type_id will be ignored.
A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.
| table_name | Name of the table to be created. Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions. |
| type_id | ID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true. |
| options | Optional parameters.
|
Definition at line 6055 of file KineticaFunctions.cs.
|
inline |
Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by ) and forwards event notifications to subscribers via ZMQ.
After this call completes, subscribe to the returned 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 . The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with Kinetica.clearTableMonitor(string,IDictionary{string, string}).
For more information on table monitors, see Table Monitors.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6096 of file KineticaFunctions.cs.
|
inline |
Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by table_name ) and forwards event notifications to subscribers via ZMQ.
After this call completes, subscribe to the returned 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 . The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with Kinetica.clearTableMonitor(string,IDictionary{string, string}).
For more information on table monitors, see Table Monitors.
| table_name | Name of the table to monitor. Must not refer to a collection. |
| options | Optional parameters.
|
Definition at line 6172 of file KineticaFunctions.cs.
|
inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of Kinetica.createTriggerByRange(string,IList{string},string,double,double,IDictionary{string, string}).) Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords{T}(string,IList{T},IDictionary{string, string}) 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 Kinetica.showSystemStatus(IDictionary{string, string})) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary{string, string}) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6205 of file KineticaFunctions.cs.
|
inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of Kinetica.createTriggerByRange(string,IList{string},string,double,double,IDictionary{string, string}).) Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords{T}(string,IList{T},IDictionary{string, string}) 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 Kinetica.showSystemStatus(IDictionary{string, string})) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary{string, string}) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_id | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| table_names | Names of the tables on which the trigger will be activated and maintained. |
| x_column_name | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. |
| x_vector | The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region. |
| y_column_name | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. |
| y_vector | The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 6257 of file KineticaFunctions.cs.
|
inline |
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 Kinetica.insertRecords{T}(string,IList{T},IDictionary{string, string}) 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 Kinetica.showSystemStatus(IDictionary{string, string})) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary{string, string}) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6296 of file KineticaFunctions.cs.
|
inline |
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 Kinetica.insertRecords{T}(string,IList{T},IDictionary{string, string}) 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 Kinetica.showSystemStatus(IDictionary{string, string})) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary{string, string}) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_id | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| table_names | Tables on which the trigger will be active. |
| column_name | Name of a numeric column_name on which the trigger is activated. |
| min | The lower bound (inclusive) for the trigger range. |
| max | The upper bound (inclusive) for the trigger range. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 6337 of file KineticaFunctions.cs.
|
inline |
Creates a new type describing the layout or schema 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.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.
A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
| request_ | Request object containing the parameters for the operation. |
Definition at line 6400 of file KineticaFunctions.cs.
|
inline |
Creates a new type describing the layout or schema 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.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.
A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
| type_definition | a JSON string describing the columns of the type to be registered. |
| label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
| properties | Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type). Valid values are:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 6705 of file KineticaFunctions.cs.
|
inline |
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.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6755 of file KineticaFunctions.cs.
|
inline |
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.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| table_name | Name of the table to be created. Has the same naming restrictions as tables. |
| table_names | The list of table names to merge. Must contain the names of one or more existing tables. |
| input_column_names | The list of columns from each of the corresponding input tables. |
| output_column_names | The list of names of the columns to be stored in the output table. |
| options | Optional parameters.
|
Definition at line 6987 of file KineticaFunctions.cs.
|
inline |
Creates a new external user (a user whose credentials are managed by an external LDAP).
| request_ | Request object containing the parameters for the operation. |
Definition at line 7008 of file KineticaFunctions.cs.
|
inline |
Creates a new external user (a user whose credentials are managed by an external LDAP).
| name | Name of the user to be created. Must exactly match the user's name in the external LDAP, prefixed with a Must not be the same name as an existing user. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7028 of file KineticaFunctions.cs.
|
inline |
Creates a new internal user (a user whose credentials are managed by the database system).
| request_ | Request object containing the parameters for the operation. |
Definition at line 7044 of file KineticaFunctions.cs.
|
inline |
Creates a new internal user (a user whose credentials are managed by the database system).
| name | Name of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role. |
| password | Initial password of the user to be created. May be an empty string for no password. |
| options | Optional parameters.
|
Definition at line 7075 of file KineticaFunctions.cs.
|
inline |
Given a KineticaType object for a certain record type, decode binary data into distinct records (objects).
| T | The type of the records. |
| record_type | The type for the records. |
| records_binary | The binary encoded data to be decoded. |
| records | The decoded objects/records. |
| T | : | new() |
Definition at line 200 of file Kinetica.cs.
|
inline |
Given a schema string for a certain record type, decode binary data into distinct records (objects).
| T | The type of the records. |
| schema_string | The schema for the records. |
| records_binary | The binary encoded data to be decoded. |
| records | The decoded objects/records. |
| T | : | new() |
Definition at line 221 of file Kinetica.cs.
|
inline |
Given a list of schema strings, decode binary data into distinct records (objects).
| T | The type of the records. |
| schema_strings | The schemas for the records. |
| lists_records_binary | The binary encoded data to be decoded (the data is in a 2D list). |
| record_lists | The decoded objects/records in a 2d list. |
| T | : | new() |
Definition at line 245 of file Kinetica.cs.
|
inline |
Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects).
| T | The type of the records. |
| type_ids | The IDs for each of the records' types. |
| records_binary | The binary encoded data to be decoded. |
| records | The decoded objects/records. |
| T | : | new() |
Definition at line 285 of file Kinetica.cs.
|
inline |
Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects).
| T | The type of the records. |
| type_ids | The IDs for each of the lists of records. |
| lists_records_binary | The binary encoded data to be decoded in a 2d list. |
| record_lists | The decoded objects/records in a 2d list. |
| T | : | new() |
Definition at line 314 of file Kinetica.cs.
|
inline |
Deletes an existing graph from the graph server and/or persist.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7093 of file KineticaFunctions.cs.
|
inline |
Deletes an existing graph from the graph server and/or persist.
| graph_name | Name of the graph to be deleted. |
| options | Optional parameters.
|
Definition at line 7135 of file KineticaFunctions.cs.
|
inline |
Deletes a proc.
Any currently running instances of the proc will be killed.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7151 of file KineticaFunctions.cs.
|
inline |
Deletes a proc.
Any currently running instances of the proc will be killed.
| proc_name | Name of the proc to be deleted. Must be the name of a currently existing proc. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7170 of file KineticaFunctions.cs.
|
inline |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7194 of file KineticaFunctions.cs.
|
inline |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
| table_name | Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view. |
| expressions | A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more is mutually exclusive to specifying record_id in the . |
| options | Optional parameters.
|
Definition at line 7269 of file KineticaFunctions.cs.
|
inline |
Deletes a resource group.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7286 of file KineticaFunctions.cs.
|
inline |
Deletes a resource group.
| name | Name of the resource group to be deleted. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7304 of file KineticaFunctions.cs.
|
inline |
Deletes an existing role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7319 of file KineticaFunctions.cs.
|
inline |
Deletes an existing role.
| name | Name of the role to be deleted. Must be an existing role. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7337 of file KineticaFunctions.cs.
|
inline |
Deletes an existing user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7352 of file KineticaFunctions.cs.
|
inline |
Deletes an existing user.
| name | Name of the user to be deleted. Must be an existing user. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7370 of file KineticaFunctions.cs.
|
inline |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7386 of file KineticaFunctions.cs.
|
inline |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
| proc_name | Name of the proc to execute. Must be the name of a currently existing proc. |
| _params | A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary. |
| bin_params | A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary. |
| input_table_names | Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table. If no table names are specified, no data will be passed to the proc. The default value is an empty List. |
| input_column_names | Map of table names from to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from is not included, all columns from that table will be passed to the proc. The default value is an empty Dictionary. |
| output_table_names | Names of the tables to which output data from the proc will be written. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from , excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 7481 of file KineticaFunctions.cs.
|
inline |
SQL Request
| request_ | Request object containing the parameters for the operation. |
Definition at line 7504 of file KineticaFunctions.cs.
|
inline |
SQL Request
| statement | SQL statement (query, DML, or DDL) to be executed |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999. |
| request_schema_str | Avro schema of . The default value is ''. |
| data | An array of binary-encoded data for the records to be binded to the SQL query. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 7847 of file KineticaFunctions.cs.
|
inline |
Filters data based on the specified expression.
The results are stored in a result set with the given .
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7877 of file KineticaFunctions.cs.
|
inline |
Filters data based on the specified expression.
The results are stored in a result set with the given view_name .
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| table_name | Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| expression | The select expression to filter the specified table. For details see Expressions. |
| options | Optional parameters.
|
Definition at line 7940 of file KineticaFunctions.cs.
|
inline |
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 passed in as part of the input.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7964 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.
| table_name | Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| x_column_name | Name of the column containing the x values to be filtered. |
| x_vector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| y_column_name | Name of the column containing the y values to be filtered. |
| y_vector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
Definition at line 8015 of file KineticaFunctions.cs.
|
inline |
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 passed in as part of the input.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8045 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.
| table_name | Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. The default value is ''. |
| column_name | Name of the geospatial geometry column to be filtered. |
| x_vector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| y_vector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
Definition at line 8093 of file KineticaFunctions.cs.
|
inline |
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 is passed in as part of the input payload.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8124 of file KineticaFunctions.cs.
|
inline |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.
| table_name | Name of the table on which the bounding box operation will be performed. Must be an existing table. |
| view_name | Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables. The default value is ''. |
| x_column_name | Name of the column on which to perform the bounding box query. Must be a valid numeric column. |
| min_x | Lower bound for the column chosen by . Must be less than or equal to . |
| max_x | Upper bound for . Must be greater than or equal to . |
| y_column_name | Name of a column on which to perform the bounding box query. Must be a valid numeric column. |
| min_y | Lower bound for . Must be less than or equal to . |
| max_y | Upper bound for . Must be greater than or equal to . |
| options | Optional parameters.
|
Definition at line 8179 of file KineticaFunctions.cs.
|
inline |
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 is passed in as part of the input payload.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8211 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.
| table_name | Name of the table on which the bounding box operation will be performed. Must be an existing table. |
| view_name | Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view. The default value is ''. |
| column_name | Name of the geospatial geometry column to be filtered. |
| min_x | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to . |
| max_x | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to . |
| min_y | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to . |
| max_y | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to . |
| options | Optional parameters.
|
Definition at line 8265 of file KineticaFunctions.cs.
|
inline |
Applies a geometry filter against a geospatial geometry column in a given table, collection or view.
The filtering geometry is provided by .
| request_ | Request object containing the parameters for the operation. |
Definition at line 8294 of file KineticaFunctions.cs.
|
inline |
Applies a geometry filter against a geospatial geometry column in a given table, collection or view.
The filtering geometry is provided by input_wkt .
| table_name | Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_name | Name of the column to be used in the filter. Must be a geospatial geometry column. |
| input_wkt | A geometry in WKT format that will be used to filter the objects in . The default value is ''. |
| operation | The geometric filtering operation to perform Supported values:
|
| options | Optional parameters.
|
Definition at line 8390 of file KineticaFunctions.cs.
|
inline |
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 is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3
and y = 0.0" would not be returned because the values in the given lists do not correspond.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8427 of file KineticaFunctions.cs.
|
inline |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a view_name is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3
and y = 0.0" would not be returned because the values in the given lists do not correspond.
| table_name | Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_values_map | List of values for the corresponding column in the table |
| options | Optional parameters.
|
Definition at line 8503 of file KineticaFunctions.cs.
|
inline |
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 is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8533 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e.
circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view_name is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| table_name | Name of the table on which the filter by radius operation will be performed. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| x_column_name | Name of the column to be used for the x-coordinate (the longitude) of the center. |
| x_center | Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180. |
| y_column_name | Name of the column to be used for the y-coordinate-the latitude-of the center. |
| y_center | Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90. |
| radius | The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| options | Optional parameters.
|
Definition at line 8592 of file KineticaFunctions.cs.
|
inline |
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 is passed in as part of the request.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8624 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.
circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view_name is passed in as part of the request.
| table_name | Name of the table on which the filter by radius operation will be performed. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. The default value is ''. |
| column_name | Name of the geospatial geometry column to be filtered. |
| x_center | Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180. |
| y_center | Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90. |
| radius | The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| options | Optional parameters.
|
Definition at line 8676 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by is added to the view if its column is within [, ] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| request_ | Request object containing the parameters for the operation. |
Definition at line 8715 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by table_name is added to the view view_name if its column is within [lower_bound , upper_bound ] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| table_name | Name of the table on which the filter by range operation will be performed. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_name | Name of a column on which the operation would be applied. |
| lower_bound | Value of the lower bound (inclusive). |
| upper_bound | Value of the upper bound (inclusive). |
| options | Optional parameters.
|
Definition at line 8766 of file KineticaFunctions.cs.
|
inline |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8801 of file KineticaFunctions.cs.
|
inline |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| table_name | Name of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| track_id | The ID of the track which will act as the filtering points. Must be an existing track within the given table. |
| target_track_ids | Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set. |
| options | Optional parameters.
|
Definition at line 8890 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table, collection, or view match a string expression for the given string columns.
The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8915 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table, collection, or view match a string expression for the given string columns.
The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.
| table_name | Name of the table on which the filter operation will be performed. Must be an existing table, collection or view. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| expression | The expression with which to filter the table. |
| mode | The string filtering mode to apply. See below for details. Supported values:
|
| column_names | List of columns on which to apply the filter. Ignored for 'search' mode. |
| options | Optional parameters.
|
Definition at line 9017 of file KineticaFunctions.cs.
|
inline |
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 is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9048 of file KineticaFunctions.cs.
|
inline |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a view_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| table_name | Name of the table whose data will be filtered. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_name | Name of the column by whose value the data will be filtered from the table designated by . |
| source_table_name | Name of the table whose data will be compared against in the table called . Must be an existing table. |
| source_table_column_name | Name of the column in the whose values will be used as the filter for table . Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the . |
| options | Optional parameters.
|
Definition at line 9196 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9229 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| table_name | Name of an existing table on which to perform the calculation. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| is_string | Indicates whether the value being searched for is string or numeric. |
| _value | The value to search for. The default value is 0. |
| value_str | The string value to search for. The default value is ''. |
| column_name | Name of a column on which the filter by value would be applied. |
| options | Optional parameters.
|
Definition at line 9279 of file KineticaFunctions.cs.
|
inlinestatic |
|
inline |
Get the status and result of asynchronously running job.
See the Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}) for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9306 of file KineticaFunctions.cs.
|
inline |
Get the status and result of asynchronously running job.
See the Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}) for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
| job_id | A unique identifier for the job whose status and result is to be fetched. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 9329 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
This operation supports paging through the data via the and 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.
| T | The type of object being retrieved. |
| request_ | Request object containing the parameters for the operation. |
| T | : | new() |
Definition at line 9358 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
| T | The type of object being retrieved. |
| table_name | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999. |
| options |
|
| T | : | new() |
Definition at line 9470 of file KineticaFunctions.cs.
|
inline |
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 and parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.createProjection(string,string,IList{string},IDictionary{string, string}).
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9519 of file KineticaFunctions.cs.
|
inline |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.createProjection(string,string,IList{string},IDictionary{string, string}).
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If table_name is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| table_name | Name of the table on which this operation will be performed. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. The table cannot be a parent set. |
| column_names | The list of column values to retrieve. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999. |
| options |
|
Definition at line 9656 of file KineticaFunctions.cs.
|
inline |
Retrieves the complete series/track records from the given based on the partial track information contained in the .
This operation supports paging through the data via the and parameters.
In contrast to Kinetica.getRecords{T}(string,long,long,IDictionary{string, string}) this returns records grouped by series/track. So if is 0 and is 5 this operation would return the first 5 series/tracks in . Each series/track will be returned sorted by their TIMESTAMP column.
| T | The type of object being retrieved. |
| request_ | Request object containing the parameters for the operation. |
| T | : | new() |
Definition at line 9695 of file KineticaFunctions.cs.
|
inline |
Retrieves the complete series/track records from the given world_table_name based on the partial track information contained in the table_name .
This operation supports paging through the data via the offset and limit parameters.
In contrast to Kinetica.getRecords{T}(string,long,long,IDictionary{string, string}) this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in table_name . Each series/track will be returned sorted by their TIMESTAMP column.
| T | The type of object being retrieved. |
| table_name | Name of the collection/table/view for which series/tracks will be fetched. |
| world_table_name | Name of the table containing the complete series/track information to be returned for the tracks present in the . Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank. |
| offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250. |
| options | Optional parameters. The default value is an empty Dictionary. |
| T | : | new() |
Definition at line 9750 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords(string,IList{string},IDictionary{string, string}).
This operation supports paging through the data via the and parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
| T | The type of object being retrieved. |
| request_ | Request object containing the parameters for the operation. |
| T | : | new() |
Definition at line 9784 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords(string,IList{string},IDictionary{string, string}).
This operation supports paging through the data via the offset and limit parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
| T | The type of object being retrieved. |
| table_name | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use & to request subsequent pages of results. The default value is -9999. |
| options |
|
| T | : | new() |
Definition at line 9857 of file KineticaFunctions.cs.
|
inline |
Grants a proc-level permission to a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9922 of file KineticaFunctions.cs.
|
inline |
Grants a proc-level permission to a user or role.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role. Supported values:
|
| proc_name | Name of the proc to which the permission grants access. Must be an existing proc, or an empty string to grant access to all procs. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 9953 of file KineticaFunctions.cs.
|
inline |
Grants a system-level permission to a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9972 of file KineticaFunctions.cs.
|
inline |
Grants a system-level permission to a user or role.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role. Supported values:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 10018 of file KineticaFunctions.cs.
|
inline |
Grants a table-level permission to a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 10037 of file KineticaFunctions.cs.
|
inline |
Grants a table-level permission to a user or role.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role. Supported values:
|
| table_name | Name of the table to which the permission grants access. Must be an existing table, collection, or view. If a collection, the permission also applies to tables and views in the collection. |
| filter_expression | Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''. |
| options | Optional parameters.
|
Definition at line 10101 of file KineticaFunctions.cs.
|
inline |
Grants membership in a role to a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 10123 of file KineticaFunctions.cs.
|
inline |
Grants membership in a role to a user or role.
| role | Name of the role in which membership will be granted. Must be an existing role. |
| member | Name of the user or role that will be granted membership in . Must be an existing user or role. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 10144 of file KineticaFunctions.cs.
|
inline |
Checks the existence of a proc with the given name.
| request_ | Request object containing the parameters for the operation. |
Definition at line 10161 of file KineticaFunctions.cs.
|
inline |
Checks the existence of a proc with the given name.
| proc_name | Name of the proc to check for existence. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 10180 of file KineticaFunctions.cs.
|
inline |
Checks for the existence of a table with the given name.
| request_ | Request object containing the parameters for the operation. |
Definition at line 10196 of file KineticaFunctions.cs.
|
inline |
Checks for the existence of a table with the given name.
| table_name | Name of the table to check for existence. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 10215 of file KineticaFunctions.cs.
|
inline |
Check for the existence of a type.
| request_ | Request object containing the parameters for the operation. |
Definition at line 10230 of file KineticaFunctions.cs.
|
inline |
Check for the existence of a type.
| type_id | Id of the type returned in response to /create/type request. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 10248 of file KineticaFunctions.cs.
|
inline |
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 parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| T | The type of object being added. |
| request_ | Request object containing the parameters for the operation. |
Definition at line 10315 of file KineticaFunctions.cs.
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| T | The type of object being added. |
| table_name | Table to which the records are to be added. Must be an existing table. |
| data | An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if is json. |
| options | Optional parameters.
|
Definition at line 10492 of file KineticaFunctions.cs.
|
inline |
Reads from one or more files located on the server and inserts the data into a new or existing table.
For CSV files, there are two loading schemes: positional and name-based. The name-based loading scheme is enabled when the file has a header present and text_has_header is set to true. In this scheme, the source file(s) field names must match the target table's column names exactly; however, the source file can have more fields than the target table has columns. If error_handling is set to permissive, the source file can have fewer fields than the target table has columns. If the name-based loading scheme is being used, names matching the file header's names may be provided to columns_to_load instead of numbers, but ranges are not supported.
Returns once all files are processed.
| request_ | Request object containing the parameters for the operation. |
Definition at line 10524 of file KineticaFunctions.cs.
|
inline |
Reads from one or more files located on the server and inserts the data into a new or existing table.
For CSV files, there are two loading schemes: positional and name-based. The name-based loading scheme is enabled when the file has a header present and text_has_header is set to true. In this scheme, the source file(s) field names must match the target table's column names exactly; however, the source file can have more fields than the target table has columns. If error_handling is set to permissive, the source file can have fewer fields than the target table has columns. If the name-based loading scheme is being used, names matching the file header's names may be provided to columns_to_load instead of numbers, but ranges are not supported.
Returns once all files are processed.
| table_name | Name of the table into which the data will be inserted. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the file. |
| filepaths | Absolute or relative filepath(s) from where files will be loaded. Relative filepaths are relative to the defined external_files_directory parameter in the server configuration. The filepaths may include wildcards (*). If the first path ends in .tsv, the text delimiter will be defaulted to a tab character. If the first path ends in .psv, the text delimiter will be defaulted to a pipe character (|). |
| create_table_options | Options used when creating a new table.
|
| options | Optional parameters.
|
Definition at line 11046 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 11074 of file KineticaFunctions.cs.
|
inline |
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.
| table_name | Table to which random records will be added. Must be an existing table. Also, must be an individual table, not a collection of tables, nor a view of a table. |
| count | Number of records to generate. |
| options | Optional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map:
|
Definition at line 11325 of file KineticaFunctions.cs.
|
inline |
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 parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| request_ | Request object containing the parameters for the operation. |
Definition at line 10280 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 11352 of file KineticaFunctions.cs.
|
inline |
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.
| symbol_id | The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol |
| symbol_format | Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values: |
| symbol_data | The actual symbol data. If is 'svg' then this should be the raw bytes representing an svg file. If is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z' |
| options | Optional parameters.
|
Definition at line 11413 of file KineticaFunctions.cs.
|
inline |
Kills a running proc instance.
| request_ | Request object containing the parameters for the operation. |
Definition at line 11431 of file KineticaFunctions.cs.
|
inline |
Kills a running proc instance.
| run_id | The run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''. |
| options | Optional parameters.
|
Definition at line 11464 of file KineticaFunctions.cs.
|
inline |
Manages global access to a table's data.
By default a table has a 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 is no_access then no operations are permitted on the table. The lock status can be queried by setting to status.
| request_ | Request object containing the parameters for the operation. |
Definition at line 11519 of file KineticaFunctions.cs.
|
inline |
Manages global access to a table's data.
By default a table has a lock_type of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lock_type is no_access then no operations are permitted on the table. The lock status can be queried by setting lock_type to status.
| table_name | Name of the table to be locked. It must be a currently existing table, collection, or view. |
| lock_type | The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. Supported values:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 11578 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 11608 of file KineticaFunctions.cs.
|
inline |
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.
| graph_name | Name of the underlying geospatial graph resource to match to using . |
| sample_points | Sample points used to match to an underlying geospatial graph. Sample points must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with: existing column names, e.g., 'table.column AS SAMPLE_X'; expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS SAMPLE_WKTPOINT'; or constant values, e.g., '{1, 2, 10} AS SAMPLE_TRIPID'. |
| solve_method | The type of solver to use for graph matching. Supported values:
|
| solution_table | The name of the table used to store the results; this table contains a track of geospatial points for the matched portion of the graph, a track ID, and a score value. Also outputs a details table containing a trip ID (that matches the track ID), the latitude/longitude pair, the timestamp the point was recorded at, and an edge ID corresponding to the matched road segment. Has the same naming restrictions as tables. Must not be an existing table of the same name. The default value is ''. |
| options | Additional parameters
|
Definition at line 11926 of file KineticaFunctions.cs.
|
inline |
Create a new empty result table (specified by ), and insert all records from source tables (specified by ) based on the field mapping information (specified by ).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by ) holds the user-specified maps of target table column names to source table columns. The array of must match one-to-one with the , e.g., there's a map present in for each table listed in .
| request_ | Request object containing the parameters for the operation. |
Definition at line 11967 of file KineticaFunctions.cs.
|
inline |
Create a new empty result table (specified by table_name ), and insert all records from source tables (specified by source_table_names ) based on the field mapping information (specified by field_maps ).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by field_maps ) holds the user-specified maps of target table column names to source table columns. The array of field_maps must match one-to-one with the source_table_names , e.g., there's a map present in field_maps for each table listed in source_table_names .
| table_name | The new result table name for the records to be merged. Must NOT be an existing table. |
| source_table_names | The list of source table names to get the records from. Must be existing table names. |
| field_maps | Contains a list of source/target column mappings, one mapping for each source table listed in being merged into the target table specified by . Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column. |
| options | Optional parameters.
|
Definition at line 12096 of file KineticaFunctions.cs.
|
inline |
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, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
| request_ | Request object containing the parameters for the operation. |
Definition at line 12123 of file KineticaFunctions.cs.
|
inline |
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, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
| graph_name | Name of the graph resource to modify. |
| nodes | Nodes with which to update existing in graph specified by . Review Nodes for more information. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or raw values, e.g., '{9, 10, 11} AS NODE_ID'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph. |
| edges | Edges with which to update existing in graph specified by . Review Edges for more information. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or raw values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph. |
| weights | Weights with which to update existing in graph specified by . Review Weights for more information. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or raw values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph. |
| restrictions | Restrictions with which to update existing in graph specified by . Review Restrictions for more information. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph. |
| options | Optional parameters.
|
Definition at line 12385 of file KineticaFunctions.cs.
|
inline |
Employs a topological query on a network graph generated a-priori by Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) 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 . This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.
To return the adjacency list in the response, leave empty. To return the adjacency list in a table and not in the response, provide a value to and set export_query_results to false. To return the adjacency list both in a table and the response, provide a value to and set export_query_results to true.
IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.
| request_ | Request object containing the parameters for the operation. |
Definition at line 12437 of file KineticaFunctions.cs.
|
inline |
Employs a topological query on a network graph generated a-priori by Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.
To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to queries . This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.
To return the adjacency list in the response, leave adjacency_table empty. To return the adjacency list in a table and not in the response, provide a value to adjacency_table and set export_query_results to false. To return the adjacency list both in a table and the response, provide a value to adjacency_table and set export_query_results to true.
IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.
| graph_name | Name of the graph resource to query. |
| queries | Nodes or edges to be queried specified using query identifiers. Identifiers can be used with existing column names, e.g., 'table.column AS QUERY_NODE_ID', raw values, e.g., '{0, 2} AS QUERY_NODE_ID', or expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination. |
| restrictions | Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. The default value is an empty List. |
| adjacency_table | Name of the table to store the resulting adjacencies. If left blank, the query results are instead returned in the response even if export_query_results is set to false. If the 'QUERY_TARGET_NODE_LABEL' query identifier is used in , then two additional columns will be available: 'PATH_ID' and 'RING_ID'. See Using Labels for more information. The default value is ''. |
| rings | Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. Also known as number of hops. For example, if it is set to '2', the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to '0', any nodes that meet the criteria in and will be returned. This parameter is only applicable when querying nodes. The default value is 1. |
| options | Additional parameters
|
Definition at line 12655 of file KineticaFunctions.cs.
|
inline |
Revokes a proc-level permission from a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 12676 of file KineticaFunctions.cs.
|
inline |
Revokes a proc-level permission from a user or role.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role. Supported values:
|
| proc_name | Name of the proc to which the permission grants access. Must be an existing proc, or an empty string if the permission grants access to all procs. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 12709 of file KineticaFunctions.cs.
|
inline |
Revokes a system-level permission from a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 12730 of file KineticaFunctions.cs.
|
inline |
Revokes a system-level permission from a user or role.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role. Supported values:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 12778 of file KineticaFunctions.cs.
|
inline |
Revokes a table-level permission from a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 12797 of file KineticaFunctions.cs.
|
inline |
Revokes a table-level permission from a user or role.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role. Supported values:
|
| table_name | Name of the table to which the permission grants access. Must be an existing table, collection, or view. |
| options | Optional parameters.
|
Definition at line 12859 of file KineticaFunctions.cs.
|
inline |
Revokes membership in a role from a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 12880 of file KineticaFunctions.cs.
|
inline |
Revokes membership in a role from a user or role.
| role | Name of the role in which membership will be revoked. Must be an existing role. |
| member | Name of the user or role that will be revoked membership in . Must be an existing user or role. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 12902 of file KineticaFunctions.cs.
|
inline |
Saves an object class type to a KineticaType association.
If the class type already exists in the map, replaces the old KineticaType value.
| objectType | The type of the object. |
| kineticaType | The associated KinetiaType object. |
Definition at line 184 of file Kinetica.cs.
|
inline |
Shows information and characteristics of graphs that exist on the graph server.
| request_ | Request object containing the parameters for the operation. |
Definition at line 12956 of file KineticaFunctions.cs.
|
inline |
Shows information and characteristics of graphs that exist on the graph server.
| graph_name | Name of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ''. |
| options | Optional parameters.
|
Definition at line 12997 of file KineticaFunctions.cs.
|
inline |
Shows information about a proc.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13041 of file KineticaFunctions.cs.
|
inline |
Shows information about a proc.
| proc_name | Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ''. |
| options | Optional parameters.
|
Definition at line 13083 of file KineticaFunctions.cs.
|
inline |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string})) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
| request_ | Request object containing the parameters for the operation. |
Definition at line 13102 of file KineticaFunctions.cs.
|
inline |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string})) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
| run_id | The run ID of a specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ''. |
| options | Optional parameters.
|
Definition at line 13160 of file KineticaFunctions.cs.
|
inline |
Requests resource group properties.
Returns detailed information about the requested resource groups.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13211 of file KineticaFunctions.cs.
|
inline |
Requests resource group properties.
Returns detailed information about the requested resource groups.
| names | List of names of groups to be shown. A single entry with an empty string returns all groups. |
| options | Optional parameters.
|
Definition at line 13271 of file KineticaFunctions.cs.
|
inline |
Requests various statistics for storage/memory tiers and resource groups.
Returns statistics on a per-rank basis.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13177 of file KineticaFunctions.cs.
|
inline |
Requests various statistics for storage/memory tiers and resource groups.
Returns statistics on a per-rank basis.
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 13195 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13288 of file KineticaFunctions.cs.
|
inline |
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.
| names | A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 13309 of file KineticaFunctions.cs.
|
inline |
Shows information about SQL procedures, including the full definition of each requested procedure.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13325 of file KineticaFunctions.cs.
|
inline |
Shows information about SQL procedures, including the full definition of each requested procedure.
| procedure_name | Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''. |
| options | Optional parameters.
|
Definition at line 13367 of file KineticaFunctions.cs.
|
inline |
Retrieves the collected column statistics for the specified table.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13383 of file KineticaFunctions.cs.
|
inline |
Retrieves the collected column statistics for the specified table.
| table_names | Tables whose metadata will be fetched. All provided tables must exist, or an error is returned. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 13402 of file KineticaFunctions.cs.
|
inline |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13419 of file KineticaFunctions.cs.
|
inline |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
| options | Optional parameters.
|
Definition at line 13446 of file KineticaFunctions.cs.
|
inline |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13462 of file KineticaFunctions.cs.
|
inline |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
| options | Optional parameters, currently unused. The default value is an empty Dictionary. |
Definition at line 13480 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13496 of file KineticaFunctions.cs.
|
inline |
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.
| options | Optional parameters, currently unused. The default value is an empty Dictionary. |
Definition at line 13514 of file KineticaFunctions.cs.
|
inline |
Retrieves detailed information about a table, view, or collection, specified in .
If the supplied is a collection, the call can return information about either the collection itself or the tables and views it contains. If is empty, information about all collections and top-level tables and views can be returned.
If the option get_sizes is set to true, then the number of records in each table is returned (in and ), along with the total number of objects across all requested tables (in and ).
For a collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their corresponding detail.
To retrieve a list of every table, view, and collection in the database, set to '*' and show_children to true.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13554 of file KineticaFunctions.cs.
|
inline |
Retrieves detailed information about a table, view, or collection, specified in table_name .
If the supplied table_name is a collection, the call can return information about either the collection itself or the tables and views it contains. If table_name is empty, information about all collections and top-level tables and views can be returned.
If the option get_sizes is set to true, then the number of records in each table is returned (in and ), along with the total number of objects across all requested tables (in and ).
For a collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their corresponding detail.
To retrieve a list of every table, view, and collection in the database, set table_name to '*' and show_children to true.
| table_name | Name of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned. |
| options | Optional parameters.
|
Definition at line 13712 of file KineticaFunctions.cs.
|
inline |
Retrieves the user provided metadata for the specified tables.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13728 of file KineticaFunctions.cs.
|
inline |
Retrieves the user provided metadata for the specified tables.
| table_names | Tables whose metadata will be fetched. All provided tables must exist, or an error is returned. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 13747 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13766 of file KineticaFunctions.cs.
|
inline |
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.
| type_id | Type id returned by a call to /create/type. |
| label | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 13791 of file KineticaFunctions.cs.
|
inline |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13808 of file KineticaFunctions.cs.
|
inline |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| trigger_ids | List of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 13828 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13846 of file KineticaFunctions.cs.
|
inline |
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.
| type_id | Type Id returned in response to a call to /create/type. |
| label | Option string that was supplied by user in a call to /create/type. |
| options | Optional parameters.
|
Definition at line 13899 of file KineticaFunctions.cs.
|
inline |
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.
| request_ | Request object containing the parameters for the operation. |
Definition at line 13930 of file KineticaFunctions.cs.
|
inline |
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.
| graph_name | Name of the graph resource to solve. |
| weights_on_edges | Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15, 2} AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s). If using constant values in an identifier combination, the number of values specified must match across the combination. The default value is an empty List. |
| restrictions | Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED'). The default value is an empty List. |
| solver_type | The type of solver to use for the graph. Supported values:
|
| source_nodes | It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes. For BACKHAUL_ROUTING, this list depicts the fixed assets. The default value is an empty List. |
| destination_nodes | It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes. For BACKHAUL_ROUTING, this list depicts the remote assets. The default value is an empty List. |
| solution_table | Name of the table to store the solution. The default value is 'graph_solutions'. |
| options | Additional parameters
|
Definition at line 14293 of file KineticaFunctions.cs.
|
inline |
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 . There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 ==
'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and
(attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through .Note that this operation can only be run on an original table and not on a collection or a result view.
The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.
| T | The type of object being added. |
| request_ | Request object containing the parameters for the operation. |
Definition at line 14395 of file KineticaFunctions.cs.
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in new_values_maps . There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 ==
'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and
(attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options .Note that this operation can only be run on an original table and not on a collection or a result view.
The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.
| T | The type of object being added. |
| table_name | Table to be updated. Must be a currently existing table and not a collection or view. |
| expressions | A list of the actual predicates, one for each update; format should follow the guidelines /filter. |
| new_values_maps | List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of . |
| data | An optional list of new binary-avro encoded records to insert, one for each update. If one of does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 14600 of file KineticaFunctions.cs.
|
inline |
Updates the view specified by to include full series (track) information from the for the series (tracks) present in the .
| request_ | Request object containing the parameters for the operation. |
Definition at line 14625 of file KineticaFunctions.cs.
|
inline |
Updates the view specified by table_name to include full series (track) information from the world_table_name for the series (tracks) present in the view_name .
| table_name | Name of the view on which the update operation will be performed. Must be an existing view. |
| world_table_name | Name of the table containing the complete series (track) information. |
| view_name | name of the view containing the series (tracks) which have to be updated. The default value is ''. |
| reserved | The default value is an empty List. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 14653 of file KineticaFunctions.cs.
|
inline |
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 . There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 ==
'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and
(attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through .Note that this operation can only be run on an original table and not on a collection or a result view.
The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.
| request_ | Request object containing the parameters for the operation. |
Definition at line 14347 of file KineticaFunctions.cs.
|
inline |
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 field.
| request_ | Request object containing the parameters for the operation. |
Definition at line 15108 of file KineticaFunctions.cs.
|
inline |
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 field.
| table_name | Name of the table containing the data to be drawn as a chart. |
| x_column_names | Names of the columns containing the data mapped to the x axis of a chart. |
| y_column_names | Names of the columns containing the data mapped to the y axis of a chart. |
| min_x | Lower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| max_x | Upper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| min_y | Lower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| max_y | Upper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| width | Width of the generated image in pixels. |
| height | Height of the generated image in pixels. |
| bg_color | Background color of the generated image. |
| style_options | Rendering style options for a chart.
|
| options | Optional parameters.
|
Definition at line 15365 of file KineticaFunctions.cs.
|
inline |
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. .
| request_ | Request object containing the parameters for the operation. |
Definition at line 17040 of file KineticaFunctions.cs.
|
inline |
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. .
| graph_name | Name of the graph on which the isochrone is to be computed. |
| source_node | Starting vertex on the underlying graph from/to which the isochrones are created. |
| max_solution_radius | Extent of the search radius around . Set to '-1.0' for unrestricted search radius. The default value is -1.0. |
| weights_on_edges | Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', or expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s). The default value is an empty List. |
| restrictions | Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', or expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED'. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED'). The default value is an empty List. |
| num_levels | Number of equally-separated isochrones to compute. The default value is 1. |
| generate_image | If set to true, generates a PNG image of the isochrones in the response. Supported values: The default value is TRUE. |
| levels_table | Name of the table to output the isochrones, containing levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ''. |
| style_options | Various style related options of the isochrone image.
|
| solve_options | Solver specific parameters
|
| contour_options | Solver specific parameters
|
| options | Additional parameters
|
Definition at line 17790 of file KineticaFunctions.cs.
| const string kinetica.Kinetica.API_VERSION = "7.0.19.0" |
Definition at line 19 of file KineticaFunctions.cs.
| const int kinetica.Kinetica.END_OF_SET = -9999 |
No Limit
Definition at line 45 of file Kinetica.cs.
|
getset |
Thread Count
Definition at line 112 of file Kinetica.cs.
|
getset |
URL for Kinetica Server (including "http:" and port) as a string
Definition at line 82 of file Kinetica.cs.
|
getset |
URL for Kinetica Server (including "http:" and port)
Definition at line 87 of file Kinetica.cs.
|
getset |
Optional: User Name for Kinetica security
Definition at line 92 of file Kinetica.cs.
|
getset |
Use Snappy
Definition at line 107 of file Kinetica.cs.
1.8.5 
