Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.Kinetica Class Reference

API to talk to Kinetica Database More...

Classes

class  Options
 Connection Options More...
 

Public Member Functions

 Kinetica (string url, 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 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...
 
AdminDeleteNodeResponse adminDeleteNode (AdminDeleteNodeRequest request_)
 
AdminDeleteNodeResponse adminDeleteNode (int rank, string authorization, IDictionary< string, string > options=null)
 
AdminGetShardAssignmentsResponse adminGetShardAssignments (AdminGetShardAssignmentsRequest request_)
 
AdminGetShardAssignmentsResponse adminGetShardAssignments (IDictionary< string, string > options=null)
 
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_)
 
AdminRebalanceResponse adminRebalance (IList< string > table_names, IDictionary< string, string > options=null)
 
AdminSetShardAssignmentsResponse adminSetShardAssignments (AdminSetShardAssignmentsRequest request_)
 
AdminSetShardAssignmentsResponse adminSetShardAssignments (long version, bool partial_reassignment, IList< int > shard_assignments_rank, IList< int > shard_assignments_tom, IList< int > assignment_index, IDictionary< string, string > options=null)
 
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/view/collection and computes aggregates on each unique combination. More...
 
AggregateGroupByResponse aggregateGroupBy (string table_name, IList< string > column_names, long offset, long limit=1000, IDictionary< string, string > options=null)
 Calculates unique combinations (groups) of values for the given columns in a given table/view/collection 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...
 
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 (specified by ). More...
 
AggregateUniqueResponse aggregateUnique (string table_name, string column_name, long offset, long limit=10000, IDictionary< string, string > options=null)
 Returns all the unique values from a particular column (specified by column_name ) of a particular table (specified by table_name ). More...
 
AlterSystemPropertiesResponse alterSystemProperties (AlterSystemPropertiesRequest request_)
 The Kinetica.alterSystemProperties(AlterSystemPropertiesRequest) 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 or collection. More...
 
AlterTableResponse alterTable (string table_name, string action, string _value, IDictionary< string, string > options=null)
 Apply various modifications to a table or collection. 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...
 
AlterUserResponse alterUser (AlterUserRequest request_)
 Alters a user. More...
 
AlterUserResponse alterUser (string name, string action, string _value, IDictionary< string, string > options)
 Alters a user. 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(CreateTableMonitorRequest). 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...
 
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=null, IList< string > column_names=null, IList< string > expressions=null, IDictionary< string, string > options=null)
 Creates a table that is the result of a SQL JOIN. 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...
 
CreateRoleResponse createRole (CreateRoleRequest request_)
 Creates a new role. More...
 
CreateRoleResponse createRole (string name, IDictionary< string, string > options)
 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 new records inserted into a particular table (identified by ) and forwards copies to subscribers via ZMQ. More...
 
CreateTableMonitorResponse createTableMonitor (string table_name, IDictionary< string, string > options=null)
 Creates a monitor that watches for new records inserted into a particular table (identified by table_name ) and forwards copies 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_)
 Performs a union (concatenation) of one or more existing tables or views, the results of which are stored in a new view. 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)
 Performs a union (concatenation) of one or more existing tables or views, the results of which are stored in a new view. 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)
 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)
 Creates a new internal user (a user whose credentials are managed by the database system). 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...
 
DeleteRoleResponse deleteRole (DeleteRoleRequest request_)
 Deletes an existing role. More...
 
DeleteRoleResponse deleteRole (string name, IDictionary< string, string > options)
 Deletes an existing role. More...
 
DeleteUserResponse deleteUser (DeleteUserRequest request_)
 Deletes an existing user. More...
 
DeleteUserResponse deleteUser (string name, IDictionary< string, string > options)
 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...
 
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...
 
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...
 
FilterByGeometryResponse filterByGeometry (FilterByGeometryRequest request_)
 Applies a geometry filter against a spatial column named WKT 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 spatial column named WKT 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...
 
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...
 
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=10000, 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 of the given columns within a given range. More...
 
GetRecordsByColumnResponse getRecordsByColumn (string table_name, IList< string > column_names, long offset, long limit, IDictionary< string, string > options=null)
 For a given table, retrieves the values of the given columns within a given range. 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=10000, IDictionary< string, string > options=null)
 Retrieves records from a collection. 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)
 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)
 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)
 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...
 
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...
 
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)
 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)
 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)
 Revokes membership in a role from a user or role. 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...
 
ShowSecurityResponse showSecurity (ShowSecurityRequest request_)
 Shows security information relating to users and/or roles. More...
 
ShowSecurityResponse showSecurity (IList< string > names, IDictionary< string, string > options)
 Shows security information relating to users and/or roles. 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. More...
 
ShowTypesResponse showTypes (string type_id, string label, IDictionary< string, string > options=null)
 Retrieves information for the specified data type. 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...
 
VisualizeImageResponse visualizeImage (VisualizeImageRequest request_)
 
VisualizeImageResponse visualizeImage (IList< string > table_names, IList< string > world_table_names, string x_column_name, string y_column_name, IList< IList< string >> track_ids, double min_x, double max_x, double min_y, double max_y, int width, int height, string projection, long bg_color, IDictionary< string, IList< string >> style_options, IDictionary< string, string > options=null)
 
VisualizeImageClassbreakResponse visualizeImageClassbreak (VisualizeImageClassbreakRequest request_)
 
VisualizeImageClassbreakResponse visualizeImageClassbreak (IList< string > table_names, IList< string > world_table_names, string x_column_name, string y_column_name, IList< IList< string >> track_ids, string cb_column_name1, IList< string > cb_vals1, IList< string > cb_column_name2, IList< IList< string >> cb_vals2, double min_x, double max_x, double min_y, double max_y, int width, int height, string projection, long bg_color, IDictionary< string, IList< string >> style_options, IDictionary< string, string > options=null)
 
VisualizeImageHeatmapResponse visualizeImageHeatmap (VisualizeImageHeatmapRequest request_)
 
VisualizeImageHeatmapResponse visualizeImageHeatmap (IList< string > table_names, string x_column_name, string y_column_name, string value_column_name, double min_x, double max_x, double min_y, double max_y, int width, int height, string projection, IDictionary< string, string > style_options, IDictionary< string, string > options=null)
 
VisualizeImageLabelsResponse visualizeImageLabels (VisualizeImageLabelsRequest request_)
 
VisualizeImageLabelsResponse visualizeImageLabels (string table_name, string x_column_name, string y_column_name, string x_offset, string y_offset, string text_string, string font, string text_color, string text_angle, string text_scale, string draw_box, string draw_leader, string line_width, string line_color, string fill_color, string leader_x_column_name, string leader_y_column_name, double min_x, double max_x, double min_y, double max_y, int width, int height, string projection=VisualizeImageLabelsRequest.Projection.PLATE_CARREE, IDictionary< string, string > options=null)
 
VisualizeVideoResponse visualizeVideo (VisualizeVideoRequest request_)
 Creates raster images of data in the given table based on provided input parameters. More...
 
VisualizeVideoResponse visualizeVideo (IList< string > table_names, IList< string > world_table_names, IList< IList< string >> track_ids, string x_column_name, string y_column_name, double min_x, double max_x, double min_y, double max_y, int width, int height, string projection, long bg_color, IList< IList< double >> time_intervals, string video_style, string session_key, IDictionary< string, IList< string >> style_options, IDictionary< string, string > options=null)
 Creates raster images of data in the given table based on provided input parameters. More...
 
VisualizeVideoHeatmapResponse visualizeVideoHeatmap (VisualizeVideoHeatmapRequest request_)
 
VisualizeVideoHeatmapResponse visualizeVideoHeatmap (IList< string > table_names, string x_column_name, string y_column_name, double min_x, double max_x, double min_y, double max_y, IList< IList< double >> time_intervals, int width, int height, string projection, string video_style, string session_key, IDictionary< string, string > style_options, IDictionary< string, string > options=null)
 

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 = "6.0.1.0"
 

Properties

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

Detailed Description

API to talk to Kinetica Database

Definition at line 40 of file Kinetica.cs.

Constructor & Destructor Documentation

kinetica.Kinetica.Kinetica ( string  url,
Options  options = null 
)
inline

API Constructor

Parameters
urlURL for Kinetica Server (including "http:" and port)
optionsOptional connection options

Definition at line 123 of file Kinetica.cs.

Member Function Documentation

void kinetica.Kinetica.AddTableType ( string  table_name,
Type  obj_type 
)
inline

Given a table name, add its record type to enable proper encoding of records for insertion or updates.

Parameters
table_nameName of the table.
obj_typeThe type associated with the table.

Definition at line 152 of file Kinetica.cs.

AdminDeleteNodeResponse kinetica.Kinetica.adminDeleteNode ( AdminDeleteNodeRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 32 of file KineticaFunctions.cs.

AdminDeleteNodeResponse kinetica.Kinetica.adminDeleteNode ( int  rank,
string  authorization,
IDictionary< string, string >  options = null 
)
inline

Parameters
rank
authorization
options
Returns
Response object containing the result of the operation.

Definition at line 50 of file KineticaFunctions.cs.

AdminGetShardAssignmentsResponse kinetica.Kinetica.adminGetShardAssignments ( AdminGetShardAssignmentsRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 68 of file KineticaFunctions.cs.

AdminGetShardAssignmentsResponse kinetica.Kinetica.adminGetShardAssignments ( IDictionary< string, string >  options = null)
inline

Parameters
options
Returns
Response object containing the result of the operation.

Definition at line 84 of file KineticaFunctions.cs.

AdminOfflineResponse kinetica.Kinetica.adminOffline ( AdminOfflineRequest  request_)
inline

Take the system offline.

When the system is offline, no user operations can be performed with the exception of a system shutdown.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 100 of file KineticaFunctions.cs.

AdminOfflineResponse kinetica.Kinetica.adminOffline ( bool  offline,
IDictionary< string, string >  options = null 
)
inline

Take the system offline.

When the system is offline, no user operations can be performed with the exception of a system shutdown.

Parameters
offlineSet to true if desired state is offline. Values: true, false.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 120 of file KineticaFunctions.cs.

AdminRebalanceResponse kinetica.Kinetica.adminRebalance ( AdminRebalanceRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 136 of file KineticaFunctions.cs.

AdminRebalanceResponse kinetica.Kinetica.adminRebalance ( IList< string >  table_names,
IDictionary< string, string >  options = null 
)
inline

Parameters
table_names
options
Returns
Response object containing the result of the operation.

Definition at line 153 of file KineticaFunctions.cs.

AdminSetShardAssignmentsResponse kinetica.Kinetica.adminSetShardAssignments ( AdminSetShardAssignmentsRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 169 of file KineticaFunctions.cs.

AdminSetShardAssignmentsResponse kinetica.Kinetica.adminSetShardAssignments ( long  version,
bool  partial_reassignment,
IList< int >  shard_assignments_rank,
IList< int >  shard_assignments_tom,
IList< int >  assignment_index,
IDictionary< string, string >  options = null 
)
inline

Parameters
version
partial_reassignment
shard_assignments_rank
shard_assignments_tom
assignment_index
options
Returns
Response object containing the result of the operation.

Definition at line 190 of file KineticaFunctions.cs.

AdminShutdownResponse kinetica.Kinetica.adminShutdown ( AdminShutdownRequest  request_)
inline

Exits the database server application.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 214 of file KineticaFunctions.cs.

AdminShutdownResponse kinetica.Kinetica.adminShutdown ( string  exit_type,
string  authorization,
IDictionary< string, string >  options = null 
)
inline

Exits the database server application.

Parameters
exit_typeReserved for future use. User can pass an empty string.
authorizationNo longer used. User can pass an empty string.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 233 of file KineticaFunctions.cs.

AdminVerifyDbResponse kinetica.Kinetica.adminVerifyDb ( AdminVerifyDbRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 253 of file KineticaFunctions.cs.

AdminVerifyDbResponse kinetica.Kinetica.adminVerifyDb ( IDictionary< string, string >  options = null)
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.

Parameters
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 271 of file KineticaFunctions.cs.

AggregateConvexHullResponse kinetica.Kinetica.aggregateConvexHull ( AggregateConvexHullRequest  request_)
inline

Calculates and returns the convex hull for the values in a table specified by .

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 287 of file KineticaFunctions.cs.

AggregateConvexHullResponse kinetica.Kinetica.aggregateConvexHull ( string  table_name,
string  x_column_name,
string  y_column_name,
IDictionary< string, string >  options = null 
)
inline

Calculates and returns the convex hull for the values in a table specified by table_name .

Parameters
table_nameName of Table on which the operation will be performed. Must be an existing table. It can not be a collection.
x_column_nameName of the column containing the x coordinates of the points for the operation being performed.
y_column_nameName of the column containing the y coordinates of the points for the operation being performed.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 312 of file KineticaFunctions.cs.

AggregateGroupByResponse kinetica.Kinetica.aggregateGroupBy ( AggregateGroupByRequest  request_)
inline

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.
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.
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), 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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 385 of file KineticaFunctions.cs.

AggregateGroupByResponse kinetica.Kinetica.aggregateGroupBy ( string  table_name,
IList< string >  column_names,
long  offset,
long  limit = 1000,
IDictionary< string, string >  options = null 
)
inline

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of column_names is an unrestricted-length string.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table/view/collection.
column_namesList of one or more column names, expressions, and aggregate expressions. Must include at least one 'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA 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.
optionsOptional parameters.
  • collection_name Name of a collection which is to contain the table specified in result_table, otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail. Additionally this option is invalid if is a collection.
  • expression Filter expression to apply to the table prior to computing the aggregate group by.
  • having Filter expression to apply to the aggregated results.
  • sort_order String indicating how the returned values should be sorted - ascending or descending. Values: ascending, descending.
  • sort_by String determining how the results are sorted. Values: key, value.
  • result_table The name of the table used to store the results. Has the same naming restrictions as tables. Column names (group-by and aggregate fields) need to be given aliases e.g. ["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
  • result_table_persist If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false then the result table will be a read-only, memory-only temporary table. Values: true, false.
  • ttl Sets the TTL of the table specified in result_table. The value must be the desired TTL in minutes.
Returns
Response object containing the result of the operation.

Definition at line 531 of file KineticaFunctions.cs.

AggregateHistogramResponse kinetica.Kinetica.aggregateHistogram ( AggregateHistogramRequest  request_)
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 . In this latter case the sum of the values corresponding to the value_column is used as the result instead.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 562 of file KineticaFunctions.cs.

AggregateHistogramResponse kinetica.Kinetica.aggregateHistogram ( string  table_name,
string  column_name,
double  start,
double  end,
double  interval,
IDictionary< string, string >  options = null 
)
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 options . In this latter case the sum of the values corresponding to the value_column is used as the result instead.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table or collection.
column_nameName of a column or an expression of one or more column names over which the histogram will be calculated.
startLower end value of the histogram interval, inclusive.
endUpper end value of the histogram interval, inclusive.
intervalThe size of each bin within the start and end parameters.
optionsOptional parameters.
  • value_column The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).
Returns
Response object containing the result of the operation.

Definition at line 608 of file KineticaFunctions.cs.

AggregateKMeansResponse kinetica.Kinetica.aggregateKMeans ( AggregateKMeansRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 639 of file KineticaFunctions.cs.

AggregateKMeansResponse kinetica.Kinetica.aggregateKMeans ( string  table_name,
IList< string >  column_names,
int  k,
double  tolerance,
IDictionary< string, string >  options = null 
)
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.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table or collection.
column_namesList 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.
kThe number of mean points to be determined by the algorithm.
toleranceStop iterating when the distances between successive points is less than the given tolerance.
optionsOptional parameters.
  • whiten When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.
  • max_iters Number of times to try to hit the tolerance limit before giving up - default is 10.
  • num_tries Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. Default is 1.
Returns
Response object containing the result of the operation.

Definition at line 693 of file KineticaFunctions.cs.

AggregateMinMaxResponse kinetica.Kinetica.aggregateMinMax ( AggregateMinMaxRequest  request_)
inline

Calculates and returns the minimum and maximum values of a particular column in a table.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 713 of file KineticaFunctions.cs.

AggregateMinMaxResponse kinetica.Kinetica.aggregateMinMax ( string  table_name,
string  column_name,
IDictionary< string, string >  options = null 
)
inline

Calculates and returns the minimum and maximum values of a particular column in a table.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table.
column_nameName of a column or an expression of one or more column on which the min-max will be calculated.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 733 of file KineticaFunctions.cs.

AggregateStatisticsResponse kinetica.Kinetica.aggregateStatistics ( AggregateStatisticsRequest  request_)
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)').
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 789 of file KineticaFunctions.cs.

AggregateStatisticsResponse kinetica.Kinetica.aggregateStatistics ( string  table_name,
string  column_name,
string  stats,
IDictionary< string, string >  options = null 
)
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)').
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.

Parameters
table_nameName of the table on which the statistics operation will be performed.
column_nameName of the primary column for which the statistics are to be calculated.
statsComma separated list of the statistics to calculate, e.g. "sum,mean". Values: count, mean, stdv, variance, skew, kurtosis, sum, min, max, weighted_average, cardinality, estimated_cardinality, percentile, percentile_rank.
optionsOptional parameters.
  • additional_column_names A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and must be of the same type. Must not include the column specified in and no column can be listed twice.
  • weight_column_name Name of column used as weighting attribute for the weighted average statistic.
Returns
Response object containing the result of the operation.

Definition at line 867 of file KineticaFunctions.cs.

AggregateStatisticsByRangeResponse kinetica.Kinetica.aggregateStatisticsByRange ( AggregateStatisticsByRangeRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 911 of file KineticaFunctions.cs.

AggregateStatisticsByRangeResponse kinetica.Kinetica.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 
)
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.

Parameters
table_nameName of the table on which the ranged-statistics operation will be performed.
select_expressionFor a non-empty expression statistics are calculated for those records for which the expression is true.
column_nameName of the binning-column used to divide the set samples into bins.
value_column_nameName of the value-column for which statistics are to be computed.
statsA string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
startThe lower bound of the binning-column.
endThe upper bound of the binning-column.
intervalThe 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)).
optionsMap of optional parameters:
  • additional_column_names A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.
  • bin_values A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin.
  • weight_column_name Name of the column used as weighting column for the weighted_average statistic.
  • order_column_name Name of the column used for candlestick charting techniques.
Returns
Response object containing the result of the operation.

Definition at line 993 of file KineticaFunctions.cs.

AggregateUniqueResponse kinetica.Kinetica.aggregateUnique ( AggregateUniqueRequest  request_)
inline

Returns all the unique values from a particular column (specified by ) of a particular table (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 when the value of is an unrestricted-length string.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1067 of file KineticaFunctions.cs.

AggregateUniqueResponse kinetica.Kinetica.aggregateUnique ( string  table_name,
string  column_name,
long  offset,
long  limit = 10000,
IDictionary< string, string >  options = null 
)
inline

Returns all the unique values from a particular column (specified by column_name ) of a particular table (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 when the value of column_name is an unrestricted-length string.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table.
column_nameName of the column or an expression containing one or more column names on which the unique function would be applied.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA 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.
optionsOptional parameters.
  • collection_name Name of a collection which is to contain the table specified in 'result_table', otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
  • expression Optional filter expression to apply to the table.
  • sort_order String indicating how the returned values should be sorted. Values: ascending, descending.
  • result_table The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables.
  • result_table_persist If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false (the default) then the result table will be a read-only, memory-only temporary table. Values: true, false.
  • ttl Sets the TTL of the table specified in 'result_table'. The value must be the desired TTL in minutes.
Returns
Response object containing the result of the operation.

Definition at line 1183 of file KineticaFunctions.cs.

AlterSystemPropertiesResponse kinetica.Kinetica.alterSystemProperties ( AlterSystemPropertiesRequest  request_)
inline

The Kinetica.alterSystemProperties(AlterSystemPropertiesRequest) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

Commands are given through the whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1210 of file KineticaFunctions.cs.

AlterSystemPropertiesResponse kinetica.Kinetica.alterSystemProperties ( IDictionary< string, string >  property_updates_map,
IDictionary< string, string >  options = null 
)
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').

Parameters
property_updates_mapMap containing the properties of the system to be updated. Error if empty.
  • sm_omp_threads Set the number of OpenMP threads that will be used to service filter & aggregation requests against collections to the specified integer value.
  • kernel_omp_threads Set the number of kernel OpenMP threads to the specified integer value.
  • concurrent_kernel_execution Enables concurrent kernel execution if the value is true and disables it if the value is false. Values: true, false.
  • chunk_size Sets the chunk size of all new sets to the specified integer value.
  • flush_to_disk Flushes any changes to any tables to the persistent store. These changes include updates to the vector store, object store, and text search store, Value string is ignored
  • clear_cache Clears cached results. Useful to allow repeated timing of endpoints. Value string is ignored
  • communicator_test Invoke the communicator test and report timing results. Value string is is a comma separated list of <key>=

    expressions. Expressions are: num_transactions=<num> where num is the number of request reply transactions to invoke per test; message_size=<bytes> where bytes is the size of the messages to send in bytes; check_values=<enabled> where if enabled is true the value of the messages received are verified.

  • set_message_timers_enabled Enables the communicator test to collect additional timing statistics when the value string is true. Disables the collection when the value string is false Values: true, false.
  • bulk_add_test Invoke the bulk add test and report timing results. Value string is ignored.
  • network_speed Invoke the network speed test and report timing results. Value string is a semicolon-separated list of <key>=

    expressions. Valid expressions are: seconds=<time> where time is the time in seconds to run the test; data_size=<size> where size is the size in bytes of the block to be transferred; threads=<number of="" threads>="">; to_ranks=<space-separated list of ranks> where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.

  • request_timeout Number of minutes after which filtering (e.g., /filter) and aggregating (e.g., /aggregate/groupby) queries will timeout.
  • max_get_records_size The maximum number of records the database will serve for a given data retrieval call
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 1318 of file KineticaFunctions.cs.

AlterTableResponse kinetica.Kinetica.alterTable ( AlterTableRequest  request_)
inline

Apply various modifications to a table or collection.

Available modifications include:
Creating or deleting an index on a particular column. This can speed up certain search queries (such as Kinetica.getRecords{T}(GetRecordsRequest), Kinetica.deleteRecords(DeleteRecordsRequest), Kinetica.updateRecordsRaw(RawUpdateRecordsRequest)) when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.
Making a table protected or not. Protected tables have their TTLs set to not automatically expire. This can be applied to tables, views, and collections.
Allowing homogeneous tables within a collection.
Managing a table's columns–a column can be added or removed, or have its type modified.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1359 of file KineticaFunctions.cs.

AlterTableResponse kinetica.Kinetica.alterTable ( string  table_name,
string  action,
string  _value,
IDictionary< string, string >  options = null 
)
inline

Apply various modifications to a table or collection.

Available modifications include:
Creating or deleting an index on a particular column. This can speed up certain search queries (such as Kinetica.getRecords{T}(string,long,long,IDictionary{string, string}), Kinetica.deleteRecords(string,IList{string},IDictionary{string, string}), Kinetica.updateRecords{T}(string,IList{string},IList{IDictionary{string, string}},IList{T},IDictionary{string, string})) when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.
Making a table protected or not. Protected tables have their TTLs set to not automatically expire. This can be applied to tables, views, and collections.
Allowing homogeneous tables within a collection.
Managing a table's columns–a column can be added or removed, or have its type modified.

Parameters
table_nameTable on which the operation will be performed. Must be an existing table, view, or collection.
actionModification operation to be applied Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl, add_column, delete_column, change_column, rename_table.
_valueThe value of the modification. May be a column name, 'true' or 'false', or a TTL depending on .
optionsOptional parameters.
  • column_default_value when adding a column: set a default value, for existing data.
  • column_properties when adding or changing a column: set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
  • column_type when adding or changing a column: set the column type (strings, separated by a comma: int, double, string, null etc).
  • validate_change_column Validate the type change before applying column_change request. Default is true (if option is missing). If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Values: true, false.
  • copy_values_from_column when adding or changing a column: enter column name - from where to copy values.
Returns
Response object containing the result of the operation.

Definition at line 1445 of file KineticaFunctions.cs.

AlterTableMetadataResponse kinetica.Kinetica.alterTableMetadata ( AlterTableMetadataRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1466 of file KineticaFunctions.cs.

AlterTableMetadataResponse kinetica.Kinetica.alterTableMetadata ( IList< string >  table_names,
IDictionary< string, string >  metadata_map,
IDictionary< string, string >  options = null 
)
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.

Parameters
table_namesNames of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned.
metadata_mapA 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.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 1493 of file KineticaFunctions.cs.

AlterUserResponse kinetica.Kinetica.alterUser ( AlterUserRequest  request_)
inline

Alters a user.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1511 of file KineticaFunctions.cs.

AlterUserResponse kinetica.Kinetica.alterUser ( string  name,
string  action,
string  _value,
IDictionary< string, string >  options 
)
inline

Alters a user.

Parameters
nameName of the user to be altered. Must be an existing user.
actionModification operation to be applied to the user. Values: set_password.
_valueThe value of the modification, depending on .
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 1533 of file KineticaFunctions.cs.

ClearTableResponse kinetica.Kinetica.clearTable ( ClearTableRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1554 of file KineticaFunctions.cs.

ClearTableResponse kinetica.Kinetica.clearTable ( string  table_name = "",
string  authorization = "",
IDictionary< string, string >  options = null 
)
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.

Parameters
table_nameName of the table to be cleared. Must be an existing table. Empty string clears all available tables.
authorizationNo longer used. User can pass an empty string.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 1578 of file KineticaFunctions.cs.

ClearTableMonitorResponse kinetica.Kinetica.clearTableMonitor ( ClearTableMonitorRequest  request_)
inline

Deactivates a table monitor previously created with Kinetica.createTableMonitor(CreateTableMonitorRequest).

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1596 of file KineticaFunctions.cs.

ClearTableMonitorResponse kinetica.Kinetica.clearTableMonitor ( string  topic_id,
IDictionary< string, string >  options = null 
)
inline

Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary{string, string}).

Parameters
topic_idThe topic ID returned by /create/tablemonitor.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 1615 of file KineticaFunctions.cs.

ClearTriggerResponse kinetica.Kinetica.clearTrigger ( ClearTriggerRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1633 of file KineticaFunctions.cs.

ClearTriggerResponse kinetica.Kinetica.clearTrigger ( string  trigger_id,
IDictionary< string, string >  options = null 
)
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.

Parameters
trigger_idID for the trigger to be deactivated.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 1653 of file KineticaFunctions.cs.

CreateJoinTableResponse kinetica.Kinetica.createJoinTable ( CreateJoinTableRequest  request_)
inline

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

For details see: join concept documentation.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1670 of file KineticaFunctions.cs.

CreateJoinTableResponse kinetica.Kinetica.createJoinTable ( string  join_table_name,
IList< string >  table_names = null,
IList< string >  column_names = null,
IList< string >  expressions = null,
IDictionary< string, string >  options = null 
)
inline

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

For details see: join concept documentation.

Parameters
join_table_nameName of the join table to be created. Has the same naming restrictions as tables.
table_namesThe list of table names composing the join. Corresponds to a SQL statement FROM clause
column_namesList of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions comprising the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables.
expressionsAn optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions.
optionsOptional parameters.
  • collection_name Name of a collection which is to contain the join. If the collection provided is non-existent, the collection will be automatically created. If empty, then the join will be at the top level.
  • max_query_dimensions The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
  • optimize_lookups Use more memory to speed up the joining of tables. Values: true, false.
  • refresh_method Method by which the join can be refreshed when the data in underlying member tables have changed. Values: manual, on_query, on_insert.
  • refresh Do a manual refresh of the join if it exists - throws an error otherwise Values: no_refresh, refresh, full_refresh.
  • ttl Sets the TTL of the table specified in . The value must be the desired TTL in minutes.
Returns
Response object containing the result of the operation.

Definition at line 1749 of file KineticaFunctions.cs.

CreateProcResponse kinetica.Kinetica.createProc ( CreateProcRequest  request_)
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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1773 of file KineticaFunctions.cs.

CreateProcResponse kinetica.Kinetica.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 
)
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

Parameters
proc_nameName of the proc to be created. Must not be the name of a currently existing proc.
execution_modeThe execution mode of the proc. Values: distributed, nondistributed.
filesA 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.
commandThe 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.
argsAn array of command-line arguments that will be passed to when the proc is executed.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 1817 of file KineticaFunctions.cs.

CreateProjectionResponse kinetica.Kinetica.createProjection ( CreateProjectionRequest  request_)
inline

Creates a new projection of an existing table.

A projection represents a subset of the columns (potentially including derived columns) of a table.
Notes:
A moving average can be calculated on a given column using the following syntax in the parameter:
'moving_average(column_name,num_points_before,num_points_after) as new_column_name'
For each record in the moving_average function's 'column_name' parameter, it computes the average over the previous 'num_points_before' records and the subsequent 'num_points_after' records.
Note that moving average relies on order_by, and order_by requires that all the data being ordered resides on the same processing node, so it won't make sense to use order_by without moving average.
Also, a projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1867 of file KineticaFunctions.cs.

CreateProjectionResponse kinetica.Kinetica.createProjection ( string  table_name,
string  projection_name,
IList< string >  column_names,
IDictionary< string, string >  options = null 
)
inline

Creates a new projection of an existing table.

A projection represents a subset of the columns (potentially including derived columns) of a table.
Notes:
A moving average can be calculated on a given column using the following syntax in the column_names parameter:
'moving_average(column_name,num_points_before,num_points_after) as new_column_name'
For each record in the moving_average function's 'column_name' parameter, it computes the average over the previous 'num_points_before' records and the subsequent 'num_points_after' records.
Note that moving average relies on order_by, and order_by requires that all the data being ordered resides on the same processing node, so it won't make sense to use order_by without moving average.
Also, a projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.

Parameters
table_nameName of the existing table on which the projection is to be applied.
projection_nameName of the projection to be created. Has the same naming restrictions as tables.
column_namesList 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'.
optionsOptional parameters.
  • collection_name Name of a collection to which the projection is to be assigned as a child. If the collection provided is non-existent, the collection will be automatically created.
  • expression An optional filter expression to be applied to the source table prior to the projection.
  • limit The number of records to keep.
  • order_by Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.
  • materialize_on_gpu If true then the columns of the projection will be cached on the GPU. Values: true, false.
  • ttl Sets the TTL of the table, view, or collection specified in . The value must be the desired TTL in minutes.
  • shard_key Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.
  • persist If true then the projection will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false then the projection will be a read-only, memory-only temporary table. Values: true, false.
Returns
Response object containing the result of the operation.

Definition at line 1982 of file KineticaFunctions.cs.

CreateRoleResponse kinetica.Kinetica.createRole ( CreateRoleRequest  request_)
inline

Creates a new role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2001 of file KineticaFunctions.cs.

CreateRoleResponse kinetica.Kinetica.createRole ( string  name,
IDictionary< string, string >  options 
)
inline

Creates a new role.

Parameters
nameName 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.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2020 of file KineticaFunctions.cs.

CreateTableResponse kinetica.Kinetica.createTable ( CreateTableRequest  request_)
inline

Creates a new table or collection.

If a new table is being created, the type of the table is given by , which must the be the ID of a currently registered type (i.e. one created via Kinetica.createType(CreateTypeRequest)). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.
To create a new collection, specify the name of the collection in and set the is_collection option to true; will be ignored.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2047 of file KineticaFunctions.cs.

CreateTableResponse kinetica.Kinetica.createTable ( string  table_name,
string  type_id,
IDictionary< string, string >  options = null 
)
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 the 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.

Parameters
table_nameName 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_idID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true.
optionsOptional parameters.
  • no_error_if_exists If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Values: true, false.
  • collection_name Name of a collection which is to contain the newly created table. If empty, then the newly created table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
  • is_collection Indicates whether the new table to be created will be a collection. Values: true, false.
  • disallow_homogeneous_tables For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. Values: true, false.
  • is_replicated For a table, indicates whether the table is to be replicated to all the database ranks. This may be necessary when the table is to be joined with other tables in a query. Values: true, false.
  • foreign_keys Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'.
  • foreign_shard_key Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'
  • ttl Sets the TTL of the table or collection specified in . The value must be the desired TTL in minutes.
  • is_result_table For a table, indicates whether the table is a non-persistent, memory-only table that will store the output of a proc executed with /execute/proc. A result table cannot contain store_only, text_search, or string columns (char columns are acceptable), records cannot be inserted into it directly, and it will not be retained if the server is restarted. Values: true, false.
Returns
Response object containing the result of the operation.

Definition at line 2151 of file KineticaFunctions.cs.

CreateTableMonitorResponse kinetica.Kinetica.createTableMonitor ( CreateTableMonitorRequest  request_)
inline

Creates a monitor that watches for new records inserted into a particular table (identified by ) and forwards copies to subscribers via ZMQ.

After this call completes, subscribe to the returned on the ZMQ table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with Kinetica.clearTableMonitor(ClearTableMonitorRequest).

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2179 of file KineticaFunctions.cs.

CreateTableMonitorResponse kinetica.Kinetica.createTableMonitor ( string  table_name,
IDictionary< string, string >  options = null 
)
inline

Creates a monitor that watches for new records inserted into a particular table (identified by table_name ) and forwards copies to subscribers via ZMQ.

After this call completes, subscribe to the returned on the ZMQ table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with Kinetica.clearTableMonitor(string,IDictionary{string, string}).

Parameters
table_nameName of the table to monitor. Must not refer to a collection.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2208 of file KineticaFunctions.cs.

CreateTriggerByAreaResponse kinetica.Kinetica.createTriggerByArea ( CreateTriggerByAreaRequest  request_)
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(CreateTriggerByRangeRequest).) Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecordsRaw(RawInsertRecordsRequest) with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001', but able to be retrieved via Kinetica.showSystemStatus(ShowSystemStatusRequest)) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(ClearTriggerRequest) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2239 of file KineticaFunctions.cs.

CreateTriggerByAreaResponse kinetica.Kinetica.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 
)
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.

Parameters
request_idUser-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
table_namesNames of the tables on which the trigger will be activated and maintained.
x_column_nameName of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
x_vectorThe 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_nameName of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
y_vectorThe 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.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2290 of file KineticaFunctions.cs.

CreateTriggerByRangeResponse kinetica.Kinetica.createTriggerByRange ( CreateTriggerByRangeRequest  request_)
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.insertRecordsRaw(RawInsertRecordsRequest) with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001', but able to be retrieved via Kinetica.showSystemStatus(ShowSystemStatusRequest)) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(ClearTriggerRequest) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2328 of file KineticaFunctions.cs.

CreateTriggerByRangeResponse kinetica.Kinetica.createTriggerByRange ( string  request_id,
IList< string >  table_names,
string  column_name,
double  min,
double  max,
IDictionary< string, string >  options = null 
)
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.

Parameters
request_idUser-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
table_namesTables on which the trigger will be active.
column_nameName of a numeric column_name on which the trigger is activated.
minThe lower bound (inclusive) for the trigger range.
maxThe upper bound (inclusive) for the trigger range.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2368 of file KineticaFunctions.cs.

CreateTypeResponse kinetica.Kinetica.createType ( CreateTypeRequest  request_)
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.
To set a primary key on one or more columns include the property 'primary_key' on the desired column_names. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary keys that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2429 of file KineticaFunctions.cs.

CreateTypeResponse kinetica.Kinetica.createType ( string  type_definition,
string  label,
IDictionary< string, IList< string >>  properties = null,
IDictionary< string, string >  options = null 
)
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.
To set a primary key on one or more columns include the property 'primary_key' on the desired column_names. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary keys that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }

Parameters
type_definitiona JSON string describing the columns of the type to be registered.
labelA user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
propertiesEach 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).
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2497 of file KineticaFunctions.cs.

CreateUnionResponse kinetica.Kinetica.createUnion ( CreateUnionRequest  request_)
inline

Performs a union (concatenation) of one or more existing tables or views, the results of which are stored in a new view.

It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'. Though not explicitly unions, intersect and except are also available from this endpoint.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2524 of file KineticaFunctions.cs.

CreateUnionResponse kinetica.Kinetica.createUnion ( string  table_name,
IList< string >  table_names,
IList< IList< string >>  input_column_names,
IList< string >  output_column_names,
IDictionary< string, string >  options = null 
)
inline

Performs a union (concatenation) of one or more existing tables or views, the results of which are stored in a new view.

It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'. Though not explicitly unions, intersect and except are also available from this endpoint.

Parameters
table_nameName of the table to be created. Has the same naming restrictions as tables.
table_namesThe list of table names making up the union. Must contain the names of one or more existing tables.
input_column_namesThe list of columns from each of the corresponding input tables.
output_column_namesThe list of names of the columns to be stored in the union.
optionsOptional parameters.
  • collection_name Name of a collection which is to contain the union. If the collection provided is non-existent, the collection will be automatically created. If empty, then the union will be a top-level table.
  • materialize_on_gpu If 'true' then the columns of the union will be cached on the GPU. Values: true, false.
  • mode If 'merge_views' then this operation will merge (i.e. union) the provided views. All 'table_names' must be views from the same underlying base table. Values: union_all, union, union_distinct, except, intersect, merge_views.
  • ttl Sets the TTL of the table specified in . The value must be the desired TTL in minutes.
  • persist If true then the union will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false then the union will be a read-only, memory-only temporary table. Values: true, false.
Returns
Response object containing the result of the operation.

Definition at line 2598 of file KineticaFunctions.cs.

CreateUserExternalResponse kinetica.Kinetica.createUserExternal ( CreateUserExternalRequest  request_)
inline

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2619 of file KineticaFunctions.cs.

CreateUserExternalResponse kinetica.Kinetica.createUserExternal ( string  name,
IDictionary< string, string >  options 
)
inline

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

Parameters
nameName 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.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2638 of file KineticaFunctions.cs.

CreateUserInternalResponse kinetica.Kinetica.createUserInternal ( CreateUserInternalRequest  request_)
inline

Creates a new internal user (a user whose credentials are managed by the database system).

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2654 of file KineticaFunctions.cs.

CreateUserInternalResponse kinetica.Kinetica.createUserInternal ( string  name,
string  password,
IDictionary< string, string >  options 
)
inline

Creates a new internal user (a user whose credentials are managed by the database system).

Parameters
nameName 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.
passwordInitial password of the user to be created. May be an empty string for no password.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2676 of file KineticaFunctions.cs.

void kinetica.Kinetica.DecodeRawBinaryDataUsingSchemaString< T > ( string  schema_string,
IList< byte[]>  records_binary,
IList< T >  records 
)
inline

Given a schema string for a certain record type, decode binary data into distinct records (objects).

Template Parameters
TThe type of the records.
Parameters
schema_stringThe schema for the records.
records_binaryThe binary encoded data to be decoded.
recordsThe decoded objects/records.
Type Constraints
T :new() 

Definition at line 194 of file Kinetica.cs.

void kinetica.Kinetica.DecodeRawBinaryDataUsingSchemaString< T > ( IList< string >  schema_strings,
IList< IList< byte[]>>  lists_records_binary,
IList< IList< T >>  record_lists 
)
inline

Given a list of schema strings, decode binary data into distinct records (objects).

Template Parameters
TThe type of the records.
Parameters
schema_stringsThe schemas for the records.
lists_records_binaryThe binary encoded data to be decoded (the data is in a 2D list).
record_listsThe decoded objects/records in a 2d list.
Type Constraints
T :new() 

Definition at line 218 of file Kinetica.cs.

void kinetica.Kinetica.DecodeRawBinaryDataUsingTypeIDs< T > ( IList< string >  type_ids,
IList< byte[]>  records_binary,
IList< T >  records 
)
inline

Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects).

Template Parameters
TThe type of the records.
Parameters
type_idsThe IDs for each of the records' types.
records_binaryThe binary encoded data to be decoded.
recordsThe decoded objects/records.
Type Constraints
T :new() 

Definition at line 258 of file Kinetica.cs.

void kinetica.Kinetica.DecodeRawBinaryDataUsingTypeIDs< T > ( IList< string >  type_ids,
IList< IList< byte[]>>  lists_records_binary,
IList< IList< T >>  record_lists 
)
inline

Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects).

Template Parameters
TThe type of the records.
Parameters
type_idsThe IDs for each of the lists of records.
lists_records_binaryThe binary encoded data to be decoded in a 2d list.
record_listsThe decoded objects/records in a 2d list.
Type Constraints
T :new() 

Definition at line 287 of file Kinetica.cs.

DeleteProcResponse kinetica.Kinetica.deleteProc ( DeleteProcRequest  request_)
inline

Deletes a proc.

Any currently running instances of the proc will be killed.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2694 of file KineticaFunctions.cs.

DeleteProcResponse kinetica.Kinetica.deleteProc ( string  proc_name,
IDictionary< string, string >  options = null 
)
inline

Deletes a proc.

Any currently running instances of the proc will be killed.

Parameters
proc_nameName of the proc to be deleted. Must be the name of a currently existing proc.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2712 of file KineticaFunctions.cs.

DeleteRecordsResponse kinetica.Kinetica.deleteRecords ( DeleteRecordsRequest  request_)
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) or a single record identified by record_id options. Note that the two selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2735 of file KineticaFunctions.cs.

DeleteRecordsResponse kinetica.Kinetica.deleteRecords ( string  table_name,
IList< string >  expressions,
IDictionary< string, string >  options = null 
)
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) or a single record identified by record_id options. Note that the two selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Parameters
table_nameName of the table from which to delete records. The set must be a currently existing table and not a collection or a view.
expressionsA list of the actual predicates, one for each select; format should follow the guidelines provided /filter. Specifying one or more is mutually exclusive to specifying record_id in the .
optionsOptional parameters.
  • global_expression An optional global expression to reduce the search space of the .
  • record_id A record id identifying a single record, obtained at the time of /insert/records or by calling /get/records/fromcollection with the return_record_ids option.
Returns
Response object containing the result of the operation.

Definition at line 2783 of file KineticaFunctions.cs.

DeleteRoleResponse kinetica.Kinetica.deleteRole ( DeleteRoleRequest  request_)
inline

Deletes an existing role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2800 of file KineticaFunctions.cs.

DeleteRoleResponse kinetica.Kinetica.deleteRole ( string  name,
IDictionary< string, string >  options 
)
inline

Deletes an existing role.

Parameters
nameName of the role to be deleted. Must be an existing role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2817 of file KineticaFunctions.cs.

DeleteUserResponse kinetica.Kinetica.deleteUser ( DeleteUserRequest  request_)
inline

Deletes an existing user.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2832 of file KineticaFunctions.cs.

DeleteUserResponse kinetica.Kinetica.deleteUser ( string  name,
IDictionary< string, string >  options 
)
inline

Deletes an existing user.

Parameters
nameName of the user to be deleted. Must be an existing user.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 2849 of file KineticaFunctions.cs.

ExecuteProcResponse kinetica.Kinetica.executeProc ( ExecuteProcRequest  request_)
inline

Executes a proc.

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2865 of file KineticaFunctions.cs.

ExecuteProcResponse kinetica.Kinetica.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 
)
inline

Executes a proc.

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

Parameters
proc_nameName of the proc to execute. Must be the name of a currently existing proc.
_paramsA map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
bin_paramsA map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
input_table_namesNames 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.
input_column_namesMap 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.
output_table_namesNames 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.
optionsOptional parameters.
  • cache_input A comma-delimited list of table names from from which input data will be cached for use in subsequent calls to /execute/proc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the /show/proc/status option of /show/proc/status and all proc instances using the cached data have completed.
  • use_cached_input A comma-delimited list of run IDs (as returned from prior calls to /execute/proc) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in , but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used.
Returns
Response object containing the result of the operation.

Definition at line 2935 of file KineticaFunctions.cs.

FilterResponse kinetica.Kinetica.filter ( FilterRequest  request_)
inline

Filters data based on the specified expression.

The results are stored in a result set with the given .
For details see concepts.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 2967 of file KineticaFunctions.cs.

FilterResponse kinetica.Kinetica.filter ( string  table_name,
string  view_name,
string  expression,
IDictionary< string, string >  options = null 
)
inline

Filters data based on the specified expression.

The results are stored in a result set with the given view_name .
For details see concepts.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
table_nameName of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
expressionThe select expression to filter the specified table. For details see concepts.
optionsOptional parameters.
  • collection_name Name of a collection which is to contain the newly created view, otherwise the view will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
  • ttl Sets the TTL of the view specified in . The value must be the desired TTL in minutes.
Returns
Response object containing the result of the operation.

Definition at line 3020 of file KineticaFunctions.cs.

FilterByAreaResponse kinetica.Kinetica.filterByArea ( FilterByAreaRequest  request_)
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.
Note that if you call this endpoint using a table that has WKT data, the x_column_name and y_column_name settings are no longer required because the geospatial filter works automatically.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3049 of file KineticaFunctions.cs.

FilterByAreaResponse kinetica.Kinetica.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 
)
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.
Note that if you call this endpoint using a table that has WKT data, the x_column_name and y_column_name settings are no longer required because the geospatial filter works automatically.

Parameters
table_nameName of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
x_column_nameName of the column containing the x values to be filtered.
x_vectorList of x coordinates of the vertices of the polygon representing the area to be filtered.
y_column_nameName of the column containing the y values to be filtered.
y_vectorList of y coordinates of the vertices of the polygon representing the area to be filtered.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 3092 of file KineticaFunctions.cs.

FilterByBoxResponse kinetica.Kinetica.filterByBox ( FilterByBoxRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3121 of file KineticaFunctions.cs.

FilterByBoxResponse kinetica.Kinetica.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 
)
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.

Parameters
table_nameName of the table on which the bounding box operation will be performed. Must be an existing table.
view_nameOptional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables.
x_column_nameName of the column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
min_xLower bound for the column chosen by . Must be less than or equal to .
max_xUpper bound for . Must be greater than or equal to .
y_column_nameName of a column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
min_yLower bound for . Must be less than or equal to .
max_yUpper bound for . Must be greater than or equal to .
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 3167 of file KineticaFunctions.cs.

FilterByGeometryResponse kinetica.Kinetica.filterByGeometry ( FilterByGeometryRequest  request_)
inline

Applies a geometry filter against a spatial column named WKT in a given table, collection or view.

The filtering geometry is provided by .

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3195 of file KineticaFunctions.cs.

FilterByGeometryResponse kinetica.Kinetica.filterByGeometry ( string  table_name,
string  view_name,
string  column_name,
string  input_wkt,
string  operation,
IDictionary< string, string >  options = null 
)
inline

Applies a geometry filter against a spatial column named WKT in a given table, collection or view.

The filtering geometry is provided by input_wkt .

Parameters
table_nameName of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a column named WKT.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
column_nameName of the column to be used in the filter. Must be 'WKT'
input_wktA geometry in WKT format that will be used to filter the objects in .
operationThe geometric filtering operation to perform Values: contains, crosses, disjoint, equals, intersects, overlaps, touches, within.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 3228 of file KineticaFunctions.cs.

FilterByListResponse kinetica.Kinetica.filterByList ( FilterByListRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3265 of file KineticaFunctions.cs.

FilterByListResponse kinetica.Kinetica.filterByList ( string  table_name,
string  view_name,
IDictionary< string, IList< string >>  column_values_map,
IDictionary< string, string >  options = null 
)
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.

Parameters
table_nameName of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
column_values_mapList of values for the corresponding column in the table
optionsOptional parameters.
  • filter_mode String indicating the filter mode, either 'in_list' or 'not_in_list'. Values: in_list, not_in_list.
Returns
Response object containing the result of the operation.

Definition at line 3314 of file KineticaFunctions.cs.

FilterByRadiusResponse kinetica.Kinetica.filterByRadius ( FilterByRadiusRequest  request_)
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. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3347 of file KineticaFunctions.cs.

FilterByRadiusResponse kinetica.Kinetica.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 
)
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. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Parameters
table_nameName of the table on which the filter by radius operation will be performed. Must be an existing table.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
x_column_nameName of the column to be used for the x-coordinate (the longitude) of the center.
x_centerValue 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_nameName of the column to be used for the y-coordinate-the latitude-of the center.
y_centerValue 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.
radiusThe 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.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 3398 of file KineticaFunctions.cs.

FilterByRangeResponse kinetica.Kinetica.filterByRange ( FilterByRangeRequest  request_)
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).

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3435 of file KineticaFunctions.cs.

FilterByRangeResponse kinetica.Kinetica.filterByRange ( string  table_name,
string  view_name,
string  column_name,
double  lower_bound,
double  upper_bound,
IDictionary< string, string >  options = null 
)
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).

Parameters
table_nameName of the table on which the filter by range operation will be performed. Must be an existing table.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
column_nameName of a column on which the operation would be applied.
lower_boundValue of the lower bound (inclusive).
upper_boundValue of the upper bound (inclusive).
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 3475 of file KineticaFunctions.cs.

FilterBySeriesResponse kinetica.Kinetica.filterBySeries ( FilterBySeriesRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3510 of file KineticaFunctions.cs.

FilterBySeriesResponse kinetica.Kinetica.filterBySeries ( string  table_name,
string  view_name,
string  track_id,
IList< string >  target_track_ids,
IDictionary< string, string >  options = null 
)
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.

Parameters
table_nameName of the table on which the filter by track operation will be performed. Must be a currently existing table with track semantic type.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
track_idThe ID of the track which will act as the filtering points. Must be an existing track within the given table.
target_track_idsUp to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
optionsOptional parameters.
  • spatial_radius A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter.
  • time_radius A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter.
  • spatial_distance_metric A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. Values: euclidean, great_circle.
Returns
Response object containing the result of the operation.

Definition at line 3577 of file KineticaFunctions.cs.

FilterByStringResponse kinetica.Kinetica.filterByString ( FilterByStringRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3602 of file KineticaFunctions.cs.

FilterByStringResponse kinetica.Kinetica.filterByString ( string  table_name,
string  view_name,
string  expression,
string  mode,
IList< string >  column_names,
IDictionary< string, string >  options = null 
)
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.

Parameters
table_nameName of the table on which the filter operation will be performed. Must be an existing table, collection or view.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
expressionThe expression with which to filter the table.
modeThe string filtering mode to apply. See below for details. Values: search, equals, contains, starts_with, regex.
column_namesList of columns on which to apply the filter. Ignored for 'search' mode.
optionsOptional parameters.
  • case_sensitive If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Values: true, false.
Returns
Response object containing the result of the operation.

Definition at line 3645 of file KineticaFunctions.cs.

FilterByTableResponse kinetica.Kinetica.filterByTable ( FilterByTableRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3676 of file KineticaFunctions.cs.

FilterByTableResponse kinetica.Kinetica.filterByTable ( string  table_name,
string  view_name,
string  column_name,
string  source_table_name,
string  source_table_column_name,
IDictionary< string, string >  options = null 
)
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.

Parameters
table_nameName of the table whose data will be filtered. Must be an existing table.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
column_nameName of the column by whose value the data will be filtered from the table designated by .
source_table_nameName of the table whose data will be compared against in the table called . Must be an existing table.
source_table_column_nameName of the column in the whose values will be used as the filter for table . Must match the type of the .
optionsOptional parameters.
  • filter_mode String indicating the filter mode, either in_table or not_in_table. Values: in_table, not_in_table.
  • mode Mode - should be either spatial or normal. Values: normal, spatial.
  • buffer Buffer size, in meters. Only relevant for spatial mode.
  • buffer_method Method used to buffer polygons. Only relevant for spatial mode. Values: normal, geos.
  • max_partition_size Maximum number of points in a partition. Only relevant for spatial mode.
  • max_partition_score Maximum number of points * edges in a partition. Only relevant for spatial mode.
  • x_column_name Name of column containing x value of point being filtered in spatial mode.
  • y_column_name Name of column containing y value of point being filtered in spatial mode.
Returns
Response object containing the result of the operation.

Definition at line 3765 of file KineticaFunctions.cs.

FilterByValueResponse kinetica.Kinetica.filterByValue ( FilterByValueRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3798 of file KineticaFunctions.cs.

FilterByValueResponse kinetica.Kinetica.filterByValue ( string  table_name,
string  view_name,
bool  is_string,
double  _value,
string  value_str,
string  column_name,
IDictionary< string, string >  options = null 
)
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.

Parameters
table_nameName of an existing table on which to perform the calculation.
view_nameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
is_stringIndicates whether the value being searched for is string or numeric.
_valueThe value to search for.
value_strThe string value to search for.
column_nameName of a column on which the filter by value would be applied.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 3835 of file KineticaFunctions.cs.

static string kinetica.Kinetica.GetApiVersion ( )
inlinestatic

API Version

Returns
Version String for API

Definition at line 77 of file Kinetica.cs.

GetRecordsResponse<T> kinetica.Kinetica.getRecords< T > ( GetRecordsRequest  request_)
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 or json.
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.

Template Parameters
TThe type of object being retrieved.
Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 3871 of file KineticaFunctions.cs.

GetRecordsResponse<T> kinetica.Kinetica.getRecords< T > ( string  table_name,
long  offset = 0,
long  limit = 10000,
IDictionary< string, string >  options = null 
)
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 or json.
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.

Template Parameters
TThe type of object being retrieved.
Parameters
table_nameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
  • expression Optional filter expression to apply to the table.
  • fast_index_lookup Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. The default value is true.
  • sort_by Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
  • sort_order String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Values: ascending, descending.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 3947 of file KineticaFunctions.cs.

GetRecordsByColumnResponse kinetica.Kinetica.getRecordsByColumn ( GetRecordsByColumnRequest  request_)
inline

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset + limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.
Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 3983 of file KineticaFunctions.cs.

GetRecordsByColumnResponse kinetica.Kinetica.getRecordsByColumn ( string  table_name,
IList< string >  column_names,
long  offset,
long  limit,
IDictionary< string, string >  options = null 
)
inline

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset + limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.
Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
table_nameName of the table on which this operation will be performed. The table cannot be a parent set.
column_namesThe list of column values to retrieve.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
options
  • expression Optional filter expression to apply to the table.
  • sort_by Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
  • sort_order String indicating how the returned values should be sorted - ascending or descending. Default is 'ascending'. If sort_order is provided, sort_by has to be provided. Values: ascending, descending.
  • order_by Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.
Returns
Response object containing the result of the operation.

Definition at line 4063 of file KineticaFunctions.cs.

GetRecordsBySeriesResponse<T> kinetica.Kinetica.getRecordsBySeries< T > ( GetRecordsBySeriesRequest  request_)
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}(GetRecordsRequest) 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.

Template Parameters
TThe type of object being retrieved.
Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 4102 of file KineticaFunctions.cs.

GetRecordsBySeriesResponse<T> kinetica.Kinetica.getRecordsBySeries< T > ( string  table_name,
string  world_table_name,
int  offset = 0,
int  limit = 250,
IDictionary< string, string >  options = null 
)
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.

Template Parameters
TThe type of object being retrieved.
Parameters
table_nameName of the collection/table/view for which series/tracks will be fetched.
world_table_nameName 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.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA 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.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 4155 of file KineticaFunctions.cs.

GetRecordsFromCollectionResponse<T> kinetica.Kinetica.getRecordsFromCollection< T > ( GetRecordsFromCollectionRequest  request_)
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(DeleteRecordsRequest).
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.

Template Parameters
TThe type of object being retrieved.
Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 4188 of file KineticaFunctions.cs.

GetRecordsFromCollectionResponse<T> kinetica.Kinetica.getRecordsFromCollection< T > ( string  table_name,
long  offset = 0,
long  limit = 10000,
IDictionary< string, string >  options = null 
)
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.

Template Parameters
TThe type of object being retrieved.
Parameters
table_nameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
  • return_record_ids If 'true' then return the internal record ID along with each returned record. Default is 'false'. Values: true, false.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 4241 of file KineticaFunctions.cs.

GrantPermissionSystemResponse kinetica.Kinetica.grantPermissionSystem ( GrantPermissionSystemRequest  request_)
inline

Grants a system-level permission to a user or role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4263 of file KineticaFunctions.cs.

GrantPermissionSystemResponse kinetica.Kinetica.grantPermissionSystem ( string  name,
string  permission,
IDictionary< string, string >  options 
)
inline

Grants a system-level permission to a user or role.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role. Values: system_admin, system_write, system_read.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 4284 of file KineticaFunctions.cs.

GrantPermissionTableResponse kinetica.Kinetica.grantPermissionTable ( GrantPermissionTableRequest  request_)
inline

Grants a table-level permission to a user or role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4303 of file KineticaFunctions.cs.

GrantPermissionTableResponse kinetica.Kinetica.grantPermissionTable ( string  name,
string  permission,
string  table_name,
string  filter_expression,
IDictionary< string, string >  options 
)
inline

Grants a table-level permission to a user or role.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role. Values: table_admin, table_insert, table_update, table_delete, table_read.
table_nameName 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_expressionReserved for future use.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 4330 of file KineticaFunctions.cs.

GrantRoleResponse kinetica.Kinetica.grantRole ( GrantRoleRequest  request_)
inline

Grants membership in a role to a user or role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4352 of file KineticaFunctions.cs.

GrantRoleResponse kinetica.Kinetica.grantRole ( string  role,
string  member,
IDictionary< string, string >  options 
)
inline

Grants membership in a role to a user or role.

Parameters
roleName of the role in which membership will be granted. Must be an existing role.
memberName of the user or role that will be granted membership in . Must be an existing user or role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 4372 of file KineticaFunctions.cs.

HasProcResponse kinetica.Kinetica.hasProc ( HasProcRequest  request_)
inline

Checks the existence of a proc with the given name.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4389 of file KineticaFunctions.cs.

HasProcResponse kinetica.Kinetica.hasProc ( string  proc_name,
IDictionary< string, string >  options = null 
)
inline

Checks the existence of a proc with the given name.

Parameters
proc_nameName of the proc to check for existence.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 4407 of file KineticaFunctions.cs.

HasTableResponse kinetica.Kinetica.hasTable ( HasTableRequest  request_)
inline

Checks for the existence of a table with the given name.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4423 of file KineticaFunctions.cs.

HasTableResponse kinetica.Kinetica.hasTable ( string  table_name,
IDictionary< string, string >  options = null 
)
inline

Checks for the existence of a table with the given name.

Parameters
table_nameName of the table to check for existence.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 4441 of file KineticaFunctions.cs.

HasTypeResponse kinetica.Kinetica.hasType ( HasTypeRequest  request_)
inline

Check for the existence of a type.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4456 of file KineticaFunctions.cs.

HasTypeResponse kinetica.Kinetica.hasType ( string  type_id,
IDictionary< string, string >  options = null 
)
inline

Check for the existence of a type.

Parameters
type_idId of the type returned in response to /create/type request.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 4473 of file KineticaFunctions.cs.

InsertRecordsResponse kinetica.Kinetica.insertRecords< T > ( InsertRecordsRequest< T >  request_)
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.
The route_to_address option directs that inserted records should be targeted for a particular database node.

Template Parameters
TThe type of object being added.
Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4546 of file KineticaFunctions.cs.

InsertRecordsResponse kinetica.Kinetica.insertRecords< T > ( string  table_name,
IList< T >  data,
IDictionary< string, string >  options = null 
)
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.
The route_to_address option directs that inserted records should be targeted for a particular database node.

Template Parameters
TThe type of object being added.
Parameters
table_nameTable to which the records are to be added. Must be an existing table.
dataAn 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.
optionsOptional parameters.
  • update_on_existing_pk Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record. If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Values: true, false.
  • return_record_ids If true then return the internal record id along for each inserted record. Values: true, false.
  • route_to_address Route to a specific rank/tom. Option not suitable for tables using primary/shard keys
Returns
Response object containing the result of the operation.

Definition at line 4622 of file KineticaFunctions.cs.

InsertRecordsRandomResponse kinetica.Kinetica.insertRecordsRandom ( InsertRecordsRandomRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4647 of file KineticaFunctions.cs.

InsertRecordsRandomResponse kinetica.Kinetica.insertRecordsRandom ( string  table_name,
long  count,
IDictionary< string, IDictionary< string, double >>  options = null 
)
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.

Parameters
table_nameTable 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.
countNumber of records to generate.
optionsOptional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. The parameters that can be specified are: min, max, and interval. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map:
  • seed If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since , is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }
    • value Pass the seed value here.
  • all This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records.
    • min For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track semantic types, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 1). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [1, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • max For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track semantic types, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [1, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • interval If specified, then generate values for all columns linearly and evenly spaced with the given interval value starting at the minimum value (instead of generating random data). Any provided max value is disregarded. For string-type columns, the interval value is ignored but the string values would be generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). No nulls would be generated for nullable columns.
    • null_percentage If specified, then generate the given percentage of the count as nulls for all nullable columns. This option will be ignored for non-nullable columns. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
  • attr_name Set the following parameters for the column specified by the key. This overrides any parameter set by all.
    • min For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track semantic types, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 1). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [1, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • max For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track semantic types, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [1, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • interval If specified, then generate values for all columns linearly and evenly spaced with the given interval value starting at the minimum value (instead of generating random data). Any provided max value is disregarded. For string-type columns, the interval value is ignored but the string values would be generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). No nulls would be generated for nullable columns.
    • null_percentage If specified and if this column is nullable, then generate the given percentage of the count as nulls. This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
  • track_length This key-map pair is only valid for track type data sets (an error is thrown otherwise). No nulls would be generated for nullable columns.
    • min Minimum possible length for generated series; default is 100 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, min must be less than or equal to max.
    • max Maximum possible length for generated series; default is 500 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, max must be greater than or equal to min.
Returns
Response object containing the result of the operation.

Definition at line 4860 of file KineticaFunctions.cs.

InsertRecordsResponse kinetica.Kinetica.insertRecordsRaw ( RawInsertRecordsRequest  request_)
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.
The route_to_address option directs that inserted records should be targeted for a particular database node.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4508 of file KineticaFunctions.cs.

InsertSymbolResponse kinetica.Kinetica.insertSymbol ( InsertSymbolRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4887 of file KineticaFunctions.cs.

InsertSymbolResponse kinetica.Kinetica.insertSymbol ( string  symbol_id,
string  symbol_format,
byte[]  symbol_data,
IDictionary< string, string >  options = null 
)
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.

Parameters
symbol_idThe id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol
symbol_formatSpecifies the symbol format. Must be either 'svg' or 'svg_path'. Values: svg, svg_path.
symbol_dataThe 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'
optionsOptional parameters.
  • color If is 'svg' this is ignored. If is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.
Returns
Response object containing the result of the operation.

Definition at line 4937 of file KineticaFunctions.cs.

KillProcResponse kinetica.Kinetica.killProc ( KillProcRequest  request_)
inline

Kills a running proc instance.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4955 of file KineticaFunctions.cs.

KillProcResponse kinetica.Kinetica.killProc ( string  run_id = "",
IDictionary< string, string >  options = null 
)
inline

Kills a running proc instance.

Parameters
run_idThe run ID of the running proc instance. If the run ID is not found or the proc instance has already completed, this does nothing. If not specified, all running proc instances will be killed.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 4974 of file KineticaFunctions.cs.

LockTableResponse kinetica.Kinetica.lockTable ( LockTableRequest  request_)
inline

Manages global access to a table's data.

By default a table has a of unlock, indicating all operations are permitted. A user may request a read-only or a write-only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When is disable then no operations are permitted on the table. The lock status can be queried by setting to status.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 4998 of file KineticaFunctions.cs.

LockTableResponse kinetica.Kinetica.lockTable ( string  table_name,
string  lock_type = LockTableRequest.LockType.STATUS,
IDictionary< string, string >  options = null 
)
inline

Manages global access to a table's data.

By default a table has a lock_type of unlock, indicating all operations are permitted. A user may request a read-only or a write-only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lock_type is disable then no operations are permitted on the table. The lock status can be queried by setting lock_type to status.

Parameters
table_nameName of the table to be locked. It must be a currently existing table, collection, or view.
lock_typeThe type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. Values: status, disable, read-only, write-only, unlock.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5028 of file KineticaFunctions.cs.

RevokePermissionSystemResponse kinetica.Kinetica.revokePermissionSystem ( RevokePermissionSystemRequest  request_)
inline

Revokes a system-level permission from a user or role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5045 of file KineticaFunctions.cs.

RevokePermissionSystemResponse kinetica.Kinetica.revokePermissionSystem ( string  name,
string  permission,
IDictionary< string, string >  options 
)
inline

Revokes a system-level permission from a user or role.

Parameters
nameName of the user or role from which the permission will be revoked. Must be an existing user or role.
permissionPermission to revoke from the user or role. Values: system_admin, system_write, system_read.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5067 of file KineticaFunctions.cs.

RevokePermissionTableResponse kinetica.Kinetica.revokePermissionTable ( RevokePermissionTableRequest  request_)
inline

Revokes a table-level permission from a user or role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5086 of file KineticaFunctions.cs.

RevokePermissionTableResponse kinetica.Kinetica.revokePermissionTable ( string  name,
string  permission,
string  table_name,
IDictionary< string, string >  options 
)
inline

Revokes a table-level permission from a user or role.

Parameters
nameName of the user or role from which the permission will be revoked. Must be an existing user or role.
permissionPermission to revoke from the user or role. Values: table_admin, table_insert, table_update, table_delete, table_read.
table_nameName of the table to which the permission grants access. Must be an existing table, collection, or view.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5112 of file KineticaFunctions.cs.

RevokeRoleResponse kinetica.Kinetica.revokeRole ( RevokeRoleRequest  request_)
inline

Revokes membership in a role from a user or role.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5133 of file KineticaFunctions.cs.

RevokeRoleResponse kinetica.Kinetica.revokeRole ( string  role,
string  member,
IDictionary< string, string >  options 
)
inline

Revokes membership in a role from a user or role.

Parameters
roleName of the role in which membership will be revoked. Must be an existing role.
memberName of the user or role that will be revoked membership in . Must be an existing user or role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5154 of file KineticaFunctions.cs.

void kinetica.Kinetica.SetKineticaSourceClassToTypeMapping ( Type  objectType,
KineticaType  kineticaType 
)
inline

Saves an object class type to a KineticaType association.

If the class type already exists in the map, replaces the old KineticaType value.

Parameters
objectTypeThe type of the object.
kineticaTypeThe associated KinetiaType object.

Definition at line 178 of file Kinetica.cs.

ShowProcResponse kinetica.Kinetica.showProc ( ShowProcRequest  request_)
inline

Shows information about a proc.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5170 of file KineticaFunctions.cs.

ShowProcResponse kinetica.Kinetica.showProc ( string  proc_name = "",
IDictionary< string, string >  options = null 
)
inline

Shows information about a proc.

Parameters
proc_nameName 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.
optionsOptional parameters.
  • include_files If set to true, the files that make up the proc will be returned. If set to false, the files will not be returned. Values: true, false.
Returns
Response object containing the result of the operation.

Definition at line 5198 of file KineticaFunctions.cs.

ShowProcStatusResponse kinetica.Kinetica.showProcStatus ( ShowProcStatusRequest  request_)
inline

Shows the statuses of running or completed proc instances.

Results are grouped by run ID (as returned from Kinetica.executeProc(ExecuteProcRequest)) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5217 of file KineticaFunctions.cs.

ShowProcStatusResponse kinetica.Kinetica.showProcStatus ( string  run_id = "",
IDictionary< string, string >  options = null 
)
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).

Parameters
run_idThe run ID of a specific running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned.
optionsOptional parameters.
  • clear_complete If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Values: true, false.
Returns
Response object containing the result of the operation.

Definition at line 5252 of file KineticaFunctions.cs.

ShowSecurityResponse kinetica.Kinetica.showSecurity ( ShowSecurityRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5269 of file KineticaFunctions.cs.

ShowSecurityResponse kinetica.Kinetica.showSecurity ( IList< string >  names,
IDictionary< string, string >  options 
)
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.

Parameters
namesA 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.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5289 of file KineticaFunctions.cs.

ShowSystemPropertiesResponse kinetica.Kinetica.showSystemProperties ( ShowSystemPropertiesRequest  request_)
inline

Returns server configuration and version related information to the caller.

The admin tool uses it to present server related information to the user.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5306 of file KineticaFunctions.cs.

ShowSystemPropertiesResponse kinetica.Kinetica.showSystemProperties ( IDictionary< string, string >  options = null)
inline

Returns server configuration and version related information to the caller.

The admin tool uses it to present server related information to the user.

Parameters
optionsOptional parameters.
  • properties A list of comma separated names of properties requested. If not specified, all properties will be returned.
Returns
Response object containing the result of the operation.

Definition at line 5332 of file KineticaFunctions.cs.

ShowSystemStatusResponse kinetica.Kinetica.showSystemStatus ( ShowSystemStatusRequest  request_)
inline

Provides server configuration and health related status to the caller.

The admin tool uses it to present server related information to the user.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5348 of file KineticaFunctions.cs.

ShowSystemStatusResponse kinetica.Kinetica.showSystemStatus ( IDictionary< string, string >  options = null)
inline

Provides server configuration and health related status to the caller.

The admin tool uses it to present server related information to the user.

Parameters
optionsOptional parameters, currently unused.
Returns
Response object containing the result of the operation.

Definition at line 5366 of file KineticaFunctions.cs.

ShowSystemTimingResponse kinetica.Kinetica.showSystemTiming ( ShowSystemTimingRequest  request_)
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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5382 of file KineticaFunctions.cs.

ShowSystemTimingResponse kinetica.Kinetica.showSystemTiming ( IDictionary< string, string >  options = null)
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.

Parameters
optionsOptional parameters, currently unused.
Returns
Response object containing the result of the operation.

Definition at line 5400 of file KineticaFunctions.cs.

ShowTableResponse kinetica.Kinetica.showTable ( ShowTableRequest  request_)
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 sizes (objects and elements) of each table are returned (in and ), along with the total number of objects in the requested table (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 description, type id, schema, type label, type properties, and additional information including TTL.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5436 of file KineticaFunctions.cs.

ShowTableResponse kinetica.Kinetica.showTable ( string  table_name,
IDictionary< string, string >  options = null 
)
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 sizes (objects and elements) of each table are returned (in and ), along with the total number of objects in the requested table (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 description, type id, schema, type label, type properties, and additional information including TTL.

Parameters
table_nameName of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned.
optionsOptional parameters.
  • get_sizes If true then the table sizes will be returned; blank, otherwise. Values: true, false.
  • show_children If is a collection, then true will return information about the children of the collection, and false will return information about the collection itself. If is a table or view, show_children must be false. If is empty, then show_children must be true. Values: true, false.
  • no_error_if_not_exists If false will return an error if the provided does not exist. If true then it will return an empty result. Values: true, false.
Returns
Response object containing the result of the operation.

Definition at line 5513 of file KineticaFunctions.cs.

ShowTableMetadataResponse kinetica.Kinetica.showTableMetadata ( ShowTableMetadataRequest  request_)
inline

Retrieves the user provided metadata for the specified tables.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5529 of file KineticaFunctions.cs.

ShowTableMetadataResponse kinetica.Kinetica.showTableMetadata ( IList< string >  table_names,
IDictionary< string, string >  options = null 
)
inline

Retrieves the user provided metadata for the specified tables.

Parameters
table_namesTables whose metadata will be fetched. All provided tables must exist, or an error is returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5547 of file KineticaFunctions.cs.

ShowTablesByTypeResponse kinetica.Kinetica.showTablesByType ( ShowTablesByTypeRequest  request_)
inline

Gets names of the tables whose type matches the given criteria.

Each table has a particular type. This type is made out of the type label, schema of the table, and the semantic type of the table. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5567 of file KineticaFunctions.cs.

ShowTablesByTypeResponse kinetica.Kinetica.showTablesByType ( string  type_id,
string  label,
IDictionary< string, string >  options = null 
)
inline

Gets names of the tables whose type matches the given criteria.

Each table has a particular type. This type is made out of the type label, schema of the table, and the semantic type of the table. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters
type_idType id returned by a call to /create/type.
labelOptional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5592 of file KineticaFunctions.cs.

ShowTriggersResponse kinetica.Kinetica.showTriggers ( ShowTriggersRequest  request_)
inline

Retrieves information regarding the specified triggers or all existing triggers currently active.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5609 of file KineticaFunctions.cs.

ShowTriggersResponse kinetica.Kinetica.showTriggers ( IList< string >  trigger_ids,
IDictionary< string, string >  options = null 
)
inline

Retrieves information regarding the specified triggers or all existing triggers currently active.

Parameters
trigger_idsList of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5628 of file KineticaFunctions.cs.

ShowTypesResponse kinetica.Kinetica.showTypes ( ShowTypesRequest  request_)
inline

Retrieves information for the specified data type.

Given a type ID, the database returns the data type schema, the label, and the semantic type along with the type ID. If the user provides any combination of label and semantic type, then the database returns the pertinent information for all data types that match the input criteria.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5648 of file KineticaFunctions.cs.

ShowTypesResponse kinetica.Kinetica.showTypes ( string  type_id,
string  label,
IDictionary< string, string >  options = null 
)
inline

Retrieves information for the specified data type.

Given a type ID, the database returns the data type schema, the label, and the semantic type along with the type ID. If the user provides any combination of label and semantic type, then the database returns the pertinent information for all data types that match the input criteria.

Parameters
type_idType Id returned in response to a call to /create/type.
labelOption string that was supplied by user in a call to /create/type.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5681 of file KineticaFunctions.cs.

UpdateRecordsResponse kinetica.Kinetica.updateRecords< T > ( UpdateRecordsRequest< T >  request_)
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 .

Template Parameters
TThe type of object being added.
Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5761 of file KineticaFunctions.cs.

UpdateRecordsResponse kinetica.Kinetica.updateRecords< T > ( string  table_name,
IList< string >  expressions,
IList< IDictionary< string, string >>  new_values_maps,
IList< T >  data = null,
IDictionary< string, string >  options = null 
)
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 .

Template Parameters
TThe type of object being added.
Parameters
table_nameTable to be updated. Must be a currently existing table and not a collection or view.
expressionsA list of the actual predicates, one for each update; format should follow the guidelines /filter.
new_values_mapsList 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 .
dataAn 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.
optionsOptional parameters.
  • global_expression An optional global expression to reduce the search space of the predicates listed in .
  • bypass_safety_checks When set to 'true', all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Values: true, false.
  • update_on_existing_pk Can be used to customize behavior when the updated primary key value already exists, as described in /insert/records. Values: true, false.
  • record_id ID of a single record to be updated (returned in the call to /insert/records or /get/records/fromcollection).
Returns
Response object containing the result of the operation.

Definition at line 5853 of file KineticaFunctions.cs.

UpdateRecordsBySeriesResponse kinetica.Kinetica.updateRecordsBySeries ( UpdateRecordsBySeriesRequest  request_)
inline

Updates the view specified by to include full series (track) information from the for the series (tracks) present in the .

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5878 of file KineticaFunctions.cs.

UpdateRecordsBySeriesResponse kinetica.Kinetica.updateRecordsBySeries ( string  table_name,
string  world_table_name,
string  view_name = "",
IList< string >  reserved = null,
IDictionary< string, string >  options = null 
)
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 .

Parameters
table_nameName of the view on which the update operation will be performed. Must be an existing view.
world_table_nameName of the table containing the complete series (track) information.
view_nameOptional name of the view containing the series (tracks) which have to be updated.
reserved
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 5903 of file KineticaFunctions.cs.

UpdateRecordsResponse kinetica.Kinetica.updateRecordsRaw ( RawUpdateRecordsRequest  request_)
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 .

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5720 of file KineticaFunctions.cs.

VisualizeImageResponse kinetica.Kinetica.visualizeImage ( VisualizeImageRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5926 of file KineticaFunctions.cs.

VisualizeImageResponse kinetica.Kinetica.visualizeImage ( IList< string >  table_names,
IList< string >  world_table_names,
string  x_column_name,
string  y_column_name,
IList< IList< string >>  track_ids,
double  min_x,
double  max_x,
double  min_y,
double  max_y,
int  width,
int  height,
string  projection,
long  bg_color,
IDictionary< string, IList< string >>  style_options,
IDictionary< string, string >  options = null 
)
inline

Parameters
table_names
world_table_names
x_column_name
y_column_name
track_ids
min_x
max_x
min_y
max_y
width
height
projectionValues: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
bg_color
style_options
  • do_points Values: true, false.
  • do_shapes Values: true, false.
  • do_tracks Values: true, false.
  • do_symbology Values: true, false.
  • pointcolors
  • pointsizes
  • pointshapes Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
  • shapelinewidths
  • shapelinecolors
  • shapefillcolors
  • tracklinewidths
  • tracklinecolors
  • trackmarkersizes
  • trackmarkercolors
  • trackmarkershapes Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
  • trackheadcolors
  • trackheadsizes
  • trackheadshapes Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
options
Returns
Response object containing the result of the operation.

Definition at line 6043 of file KineticaFunctions.cs.

VisualizeImageClassbreakResponse kinetica.Kinetica.visualizeImageClassbreak ( VisualizeImageClassbreakRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 6079 of file KineticaFunctions.cs.

VisualizeImageClassbreakResponse kinetica.Kinetica.visualizeImageClassbreak ( IList< string >  table_names,
IList< string >  world_table_names,
string  x_column_name,
string  y_column_name,
IList< IList< string >>  track_ids,
string  cb_column_name1,
IList< string >  cb_vals1,
IList< string >  cb_column_name2,
IList< IList< string >>  cb_vals2,
double  min_x,
double  max_x,
double  min_y,
double  max_y,
int  width,
int  height,
string  projection,
long  bg_color,
IDictionary< string, IList< string >>  style_options,
IDictionary< string, string >  options = null 
)
inline

Parameters
table_names
world_table_names
x_column_name
y_column_name
track_ids
cb_column_name1
cb_vals1
cb_column_name2
cb_vals2
min_x
max_x
min_y
max_y
width
height
projectionValues: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
bg_color
style_options
  • do_points Values: true, false.
  • do_shapes Values: true, false.
  • do_tracks Values: true, false.
  • do_symbology Values: true, false.
  • pointcolors
  • pointsizes
  • pointshapes Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
  • shapelinewidths
  • shapelinecolors
  • shapefillcolors
  • tracklinewidths
  • tracklinecolors
  • trackmarkersizes
  • trackmarkercolors
  • trackmarkershapes Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
  • trackheadcolors
  • trackheadsizes
  • trackheadshapes Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
options
Returns
Response object containing the result of the operation.

Definition at line 6200 of file KineticaFunctions.cs.

VisualizeImageHeatmapResponse kinetica.Kinetica.visualizeImageHeatmap ( VisualizeImageHeatmapRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 6252 of file KineticaFunctions.cs.

VisualizeImageHeatmapResponse kinetica.Kinetica.visualizeImageHeatmap ( IList< string >  table_names,
string  x_column_name,
string  y_column_name,
string  value_column_name,
double  min_x,
double  max_x,
double  min_y,
double  max_y,
int  width,
int  height,
string  projection,
IDictionary< string, string >  style_options,
IDictionary< string, string >  options = null 
)
inline

Parameters
table_names
x_column_name
y_column_name
value_column_name
min_x
max_x
min_y
max_y
width
height
projectionValues: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
style_options
  • colormap Values: jet, hot, hsv, gray, blues, greens, greys, oranges, purples, reds, viridis.
  • blur_radius
  • bg_color
  • gradient_start_color
  • gradient_end_color
options
Returns
Response object containing the result of the operation.

Definition at line 6307 of file KineticaFunctions.cs.

VisualizeImageLabelsResponse kinetica.Kinetica.visualizeImageLabels ( VisualizeImageLabelsRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 6343 of file KineticaFunctions.cs.

VisualizeImageLabelsResponse kinetica.Kinetica.visualizeImageLabels ( string  table_name,
string  x_column_name,
string  y_column_name,
string  x_offset,
string  y_offset,
string  text_string,
string  font,
string  text_color,
string  text_angle,
string  text_scale,
string  draw_box,
string  draw_leader,
string  line_width,
string  line_color,
string  fill_color,
string  leader_x_column_name,
string  leader_y_column_name,
double  min_x,
double  max_x,
double  min_y,
double  max_y,
int  width,
int  height,
string  projection = VisualizeImageLabelsRequest.Projection.PLATE_CARREE,
IDictionary< string, string >  options = null 
)
inline

Parameters
table_name
x_column_name
y_column_name
x_offset
y_offset
text_string
font
text_color
text_angle
text_scale
draw_box
draw_leader
line_width
line_color
fill_color
leader_x_column_name
leader_y_column_name
min_x
max_x
min_y
max_y
width
height
projectionValues: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
options
Returns
Response object containing the result of the operation.

Definition at line 6385 of file KineticaFunctions.cs.

VisualizeVideoResponse kinetica.Kinetica.visualizeVideo ( VisualizeVideoRequest  request_)
inline

Creates raster images of data in the given table based on provided input parameters.

Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (, , ), the collection of table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images. The operation is synchronous, meaning that a response will not be returned until the images for all the frames of the video are fully available.
Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.
For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL:
http://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0
and the last frame could be retrieved with:
http://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19
The response payload provides, among other things, the number of frames which were created.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 6479 of file KineticaFunctions.cs.

VisualizeVideoResponse kinetica.Kinetica.visualizeVideo ( IList< string >  table_names,
IList< string >  world_table_names,
IList< IList< string >>  track_ids,
string  x_column_name,
string  y_column_name,
double  min_x,
double  max_x,
double  min_y,
double  max_y,
int  width,
int  height,
string  projection,
long  bg_color,
IList< IList< double >>  time_intervals,
string  video_style,
string  session_key,
IDictionary< string, IList< string >>  style_options,
IDictionary< string, string >  options = null 
)
inline

Creates raster images of data in the given table based on provided input parameters.

Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bg_color , width , height ), the collection of table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images. The operation is synchronous, meaning that a response will not be returned until the images for all the frames of the video are fully available.
Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in session_key of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.
For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL:
http://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0
and the last frame could be retrieved with:
http://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19
The response payload provides, among other things, the number of frames which were created.

Parameters
table_namesNames of the tables containing the data for various layers of the resulting video.
world_table_namesOptional name of the tables containing the data for the entire track when the contains only part of the track data, but the entire track has to be rendered. The number of tables should match the number of tables in the
track_idsTracks from the to be rendered.
x_column_nameName of the column containing the x coordinates.
y_column_nameName of the column containing the y coordinates.
min_xLower bound for the x values.
max_xUpper bound for the x values.
min_yLower bound for the y values.
max_yUpper bound for the y values.
widthWidth of the generated image.
heightHeight of the generated image.
projectionSpatial Reference System (i.e. EPSG Code). Values: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
bg_colorBackground color of the generated image.
time_intervals
video_style
session_keyUser Provided session key that is later used to retrieve the generated video from the WMS.
style_optionsStyling options for the image.
  • do_points Rasterize point data toggle. Values: true, false.
  • do_shapes Rasterize shapes toggle. Values: true, false.
  • do_tracks Rasterize tracks toggle. Values: true, false.
  • pointcolors RGB color value in hex for the points.
  • pointsizes Size of points.
  • pointshapes Shape of the point. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
  • shapelinewidths Width of the lines.
  • shapelinecolors RGB color values in hex for the line.
  • shapefillcolors RGB color values in hex for the fill color of the shapes. Use '-1' for no fill.
  • tracklinewidths Width of the track lines. '0' implies do not draw track lines.
  • tracklinecolors RGB color values for the track lines.
  • trackmarkersizes Size of the track point markers.
  • trackmarkercolors Color of the track point markers.
  • trackmarkershapes Shape of track point markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
  • trackheadcolors Color of track head markers.
  • trackheadsizes Size of track head markers.
  • trackheadshapes Shape of track head markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 6649 of file KineticaFunctions.cs.

VisualizeVideoHeatmapResponse kinetica.Kinetica.visualizeVideoHeatmap ( VisualizeVideoHeatmapRequest  request_)
inline

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 6689 of file KineticaFunctions.cs.

VisualizeVideoHeatmapResponse kinetica.Kinetica.visualizeVideoHeatmap ( IList< string >  table_names,
string  x_column_name,
string  y_column_name,
double  min_x,
double  max_x,
double  min_y,
double  max_y,
IList< IList< double >>  time_intervals,
int  width,
int  height,
string  projection,
string  video_style,
string  session_key,
IDictionary< string, string >  style_options,
IDictionary< string, string >  options = null 
)
inline

Parameters
table_names
x_column_name
y_column_name
min_x
max_x
min_y
max_y
time_intervals
width
height
projectionValues: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
video_style
session_key
style_options
  • colormap Values: jet, hot, hsv, gray, blues, greens, greys, oranges, purples, reds.
  • blur_radius
  • bg_color
  • gradient_start_color
  • gradient_end_color
options
Returns
Response object containing the result of the operation.

Definition at line 6746 of file KineticaFunctions.cs.

Member Data Documentation

const string kinetica.Kinetica.API_VERSION = "6.0.1.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.

Property Documentation

int kinetica.Kinetica.ThreadCount = false
getset

Thread Count

Definition at line 107 of file Kinetica.cs.

string kinetica.Kinetica.Url
getset

URL for Kinetica Server (including "http:" and port)

Definition at line 82 of file Kinetica.cs.

string kinetica.Kinetica.Username
getset

Optional: User Name for Kinetica security

Definition at line 87 of file Kinetica.cs.

bool kinetica.Kinetica.UseSnappy = null
getset

Use Snappy

Definition at line 102 of file Kinetica.cs.


The documentation for this class was generated from the following files: