- Generated on Sat Nov 23 2019 13:42:23 for Kinetica C# API by
1.8.13
|
Kinetica C# API
Version 6.2.0.1
|
API to talk to Kinetica Database More...
Classes | |
| class | Options |
| Connection Options More... | |
Public Member Functions | |||
| Kinetica (string url_str, Options options=null) | |||
| API Constructor More... | |||
| void | AddTableType (string table_name, Type obj_type) | ||
| Given a table name, add its record type to enable proper encoding of records for insertion or updates. More... | |||
| void | SetKineticaSourceClassToTypeMapping (Type objectType, KineticaType kineticaType) | ||
| Saves an object class type to a KineticaType association. More... | |||
| void | DecodeRawBinaryDataUsingRecordType< T > (KineticaType record_type, IList< byte[]> records_binary, IList< T > records) | ||
| Given a KineticaType object for a certain record type, decode binary data into distinct records (objects). More... | |||
| void | DecodeRawBinaryDataUsingSchemaString< T > (string schema_string, IList< byte[]> records_binary, IList< T > records) | ||
| Given a schema string for a certain record type, decode binary data into distinct records (objects). More... | |||
| void | DecodeRawBinaryDataUsingSchemaString< T > (IList< string > schema_strings, IList< IList< byte[]>> lists_records_binary, IList< IList< T >> record_lists) | ||
| Given a list of schema strings, decode binary data into distinct records (objects). More... | |||
| void | DecodeRawBinaryDataUsingTypeIDs< T > (IList< string > type_ids, IList< byte[]> records_binary, IList< T > records) | ||
| Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects). More... | |||
| void | DecodeRawBinaryDataUsingTypeIDs< T > (IList< string > type_ids, IList< IList< byte[]>> lists_records_binary, IList< IList< T >> record_lists) | ||
| Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects). More... | |||
| AdminAlterJobsResponse | adminAlterJobs (AdminAlterJobsRequest request_) | ||
| Perform the requested action on a list of one or more job(s). More... | |||
| AdminAlterJobsResponse | adminAlterJobs (IList< int > job_ids, string action, IDictionary< string, string > options=null) | ||
| Perform the requested action on a list of one or more job(s). More... | |||
| AdminOfflineResponse | adminOffline (AdminOfflineRequest request_) | ||
| Take the system offline. More... | |||
| AdminOfflineResponse | adminOffline (bool offline, IDictionary< string, string > options=null) | ||
| Take the system offline. More... | |||
| AdminShowAlertsResponse | adminShowAlerts (AdminShowAlertsRequest request_) | ||
| Retrieves a list of the most recent alerts generated. More... | |||
| AdminShowAlertsResponse | adminShowAlerts (int num_alerts, IDictionary< string, string > options=null) | ||
| Retrieves a list of the most recent alerts generated. More... | |||
| AdminShowJobsResponse | adminShowJobs (AdminShowJobsRequest request_) | ||
| Get a list of the current jobs in GPUdb. More... | |||
| AdminShowJobsResponse | adminShowJobs (IDictionary< string, string > options=null) | ||
| Get a list of the current jobs in GPUdb. More... | |||
| AdminShowShardsResponse | adminShowShards (AdminShowShardsRequest request_) | ||
| Show the mapping of shards to the corresponding rank and tom. More... | |||
| AdminShowShardsResponse | adminShowShards (IDictionary< string, string > options=null) | ||
| Show the mapping of shards to the corresponding rank and tom. More... | |||
| AdminShutdownResponse | adminShutdown (AdminShutdownRequest request_) | ||
| Exits the database server application. More... | |||
| AdminShutdownResponse | adminShutdown (string exit_type, string authorization, IDictionary< string, string > options=null) | ||
| Exits the database server application. More... | |||
| AdminVerifyDbResponse | adminVerifyDb (AdminVerifyDbRequest request_) | ||
| Verify database is in a consistent state. More... | |||
| AdminVerifyDbResponse | adminVerifyDb (IDictionary< string, string > options=null) | ||
| Verify database is in a consistent state. More... | |||
| AggregateConvexHullResponse | aggregateConvexHull (AggregateConvexHullRequest request_) | ||
| Calculates and returns the convex hull for the values in a table specified by . More... | |||
| AggregateConvexHullResponse | aggregateConvexHull (string table_name, string x_column_name, string y_column_name, IDictionary< string, string > options=null) | ||
| Calculates and returns the convex hull for the values in a table specified by table_name . More... | |||
| AggregateGroupByResponse | aggregateGroupBy (AggregateGroupByRequest request_) | ||
| Calculates unique combinations (groups) of values for the given columns in a given table/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... | |||
| AggregateMinMaxGeometryResponse | aggregateMinMaxGeometry (AggregateMinMaxGeometryRequest request_) | ||
| Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More... | |||
| AggregateMinMaxGeometryResponse | aggregateMinMaxGeometry (string table_name, string column_name, IDictionary< string, string > options=null) | ||
| Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More... | |||
| AggregateStatisticsResponse | aggregateStatistics (AggregateStatisticsRequest request_) | ||
| Calculates the requested statistics of the given column(s) in a given table. More... | |||
| AggregateStatisticsResponse | aggregateStatistics (string table_name, string column_name, string stats, IDictionary< string, string > options=null) | ||
| Calculates the requested statistics of the given column(s) in a given table. More... | |||
| AggregateStatisticsByRangeResponse | aggregateStatisticsByRange (AggregateStatisticsByRangeRequest request_) | ||
| Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More... | |||
| AggregateStatisticsByRangeResponse | aggregateStatisticsByRange (string table_name, string select_expression, string column_name, string value_column_name, string stats, double start, double end, double interval, IDictionary< string, string > options=null) | ||
| Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More... | |||
| AggregateUniqueResponse | aggregateUnique (AggregateUniqueRequest request_) | ||
| Returns all the unique values from a particular column (specified by ) of a particular table or collection (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 or collection (specified by table_name ). More... | |||
| AggregateUnpivotResponse | aggregateUnpivot (AggregateUnpivotRequest request_) | ||
| Rotate the column values into rows values. More... | |||
| AggregateUnpivotResponse | aggregateUnpivot (string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, IDictionary< string, string > options=null) | ||
| Rotate the column values into rows values. More... | |||
| AlterSystemPropertiesResponse | alterSystemProperties (AlterSystemPropertiesRequest request_) | ||
| The Kinetica.alterSystemProperties(IDictionary<string, string>,IDictionary<string, string>) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More... | |||
| AlterSystemPropertiesResponse | alterSystemProperties (IDictionary< string, string > property_updates_map, IDictionary< string, string > options=null) | ||
| The Kinetica.alterSystemProperties(IDictionary<string, string>,IDictionary<string, string>) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More... | |||
| AlterTableResponse | alterTable (AlterTableRequest request_) | ||
| Apply various modifications to a table, view, or collection. More... | |||
| AlterTableResponse | alterTable (string table_name, string action, string _value, IDictionary< string, string > options=null) | ||
| Apply various modifications to a table, view, or collection. More... | |||
| 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=null) | ||
| Alters a user. More... | |||
| AppendRecordsResponse | appendRecords (AppendRecordsRequest request_) | ||
| Append (or insert) all records from a source table (specified by ) to a particular target table (specified by ). More... | |||
| AppendRecordsResponse | appendRecords (string table_name, string source_table_name, IDictionary< string, string > field_map, IDictionary< string, string > options=null) | ||
| Append (or insert) all records from a source table (specified by source_table_name ) to a particular target table (specified by table_name ). More... | |||
| ClearTableResponse | clearTable (ClearTableRequest request_) | ||
| Clears (drops) one or all tables in the database cluster. More... | |||
| ClearTableResponse | clearTable (string table_name="", string authorization="", IDictionary< string, string > options=null) | ||
| Clears (drops) one or all tables in the database cluster. More... | |||
| ClearTableMonitorResponse | clearTableMonitor (ClearTableMonitorRequest request_) | ||
| Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary<string, string>). More... | |||
| ClearTableMonitorResponse | clearTableMonitor (string topic_id, IDictionary< string, string > options=null) | ||
| Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary<string, string>). More... | |||
| ClearTriggerResponse | clearTrigger (ClearTriggerRequest request_) | ||
| Clears or cancels the trigger identified by the specified handle. More... | |||
| ClearTriggerResponse | clearTrigger (string trigger_id, IDictionary< string, string > options=null) | ||
| Clears or cancels the trigger identified by the specified handle. More... | |||
| CreateJobResponse | createJob (CreateJobRequest request_) | ||
| Create a job which will run asynchronously. More... | |||
| CreateJobResponse | createJob (string endpoint, string request_encoding, byte[] data, string data_str, IDictionary< string, string > options=null) | ||
| Create a job which will run asynchronously. More... | |||
| CreateJoinTableResponse | createJoinTable (CreateJoinTableRequest request_) | ||
| Creates a table that is the result of a SQL JOIN. More... | |||
| CreateJoinTableResponse | createJoinTable (string join_table_name, IList< string > table_names, IList< string > column_names, IList< string > expressions=null, IDictionary< string, string > options=null) | ||
| Creates a table that is the result of a SQL JOIN. More... | |||
| CreateMaterializedViewResponse | createMaterializedView (CreateMaterializedViewRequest request_) | ||
| Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name. More... | |||
| CreateMaterializedViewResponse | createMaterializedView (string table_name, IDictionary< string, string > options=null) | ||
| Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name. More... | |||
| CreateProcResponse | createProc (CreateProcRequest request_) | ||
| Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More... | |||
| CreateProcResponse | createProc (string proc_name, string execution_mode=CreateProcRequest.ExecutionMode.DISTRIBUTED, IDictionary< string, byte[]> files=null, string command="", IList< string > args=null, IDictionary< string, string > options=null) | ||
| Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More... | |||
| CreateProjectionResponse | createProjection (CreateProjectionRequest request_) | ||
| Creates a new projection of an existing table. More... | |||
| CreateProjectionResponse | createProjection (string table_name, string projection_name, IList< string > column_names, IDictionary< string, string > options=null) | ||
| Creates a new projection of an existing table. More... | |||
| CreateRoleResponse | createRole (CreateRoleRequest request_) | ||
| Creates a new role. More... | |||
| CreateRoleResponse | createRole (string name, IDictionary< string, string > options=null) | ||
| Creates a new role. More... | |||
| CreateTableResponse | createTable (CreateTableRequest request_) | ||
| Creates a new table or collection. More... | |||
| CreateTableResponse | createTable (string table_name, string type_id, IDictionary< string, string > options=null) | ||
| Creates a new table or collection. More... | |||
| CreateTableMonitorResponse | createTableMonitor (CreateTableMonitorRequest request_) | ||
| Creates a monitor that watches for 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_) | ||
| Merges data from one or more tables with comparable data types into a new table. More... | |||
| CreateUnionResponse | createUnion (string table_name, IList< string > table_names, IList< IList< string >> input_column_names, IList< string > output_column_names, IDictionary< string, string > options=null) | ||
| Merges data from one or more tables with comparable data types into a new table. More... | |||
| CreateUserExternalResponse | createUserExternal (CreateUserExternalRequest request_) | ||
| Creates a new external user (a user whose credentials are managed by an external LDAP). More... | |||
| CreateUserExternalResponse | createUserExternal (string name, IDictionary< string, string > options=null) | ||
| Creates a new external user (a user whose credentials are managed by an external LDAP). More... | |||
| CreateUserInternalResponse | createUserInternal (CreateUserInternalRequest request_) | ||
| Creates a new internal user (a user whose credentials are managed by the database system). More... | |||
| CreateUserInternalResponse | createUserInternal (string name, string password, IDictionary< string, string > options=null) | ||
| Creates a new internal user (a user whose credentials are managed by the database system). More... | |||
| 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=null) | ||
| Deletes an existing role. More... | |||
| DeleteUserResponse | deleteUser (DeleteUserRequest request_) | ||
| Deletes an existing user. More... | |||
| DeleteUserResponse | deleteUser (string name, IDictionary< string, string > options=null) | ||
| Deletes an existing user. More... | |||
| ExecuteProcResponse | executeProc (ExecuteProcRequest request_) | ||
| Executes a proc. More... | |||
| ExecuteProcResponse | executeProc (string proc_name, IDictionary< string, string > _params=null, IDictionary< string, byte[]> bin_params=null, IList< string > input_table_names=null, IDictionary< string, IList< string >> input_column_names=null, IList< string > output_table_names=null, IDictionary< string, string > options=null) | ||
| Executes a proc. More... | |||
| FilterResponse | filter (FilterRequest request_) | ||
| Filters data based on the specified expression. More... | |||
| FilterResponse | filter (string table_name, string view_name, string expression, IDictionary< string, string > options=null) | ||
| Filters data based on the specified expression. More... | |||
| FilterByAreaResponse | filterByArea (FilterByAreaRequest request_) | ||
| Calculates which objects from a table are within a named area of interest (NAI/polygon). More... | |||
| FilterByAreaResponse | filterByArea (string table_name, string view_name, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null) | ||
| Calculates which objects from a table are within a named area of interest (NAI/polygon). More... | |||
| FilterByAreaGeometryResponse | filterByAreaGeometry (FilterByAreaGeometryRequest request_) | ||
| Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More... | |||
| FilterByAreaGeometryResponse | filterByAreaGeometry (string table_name, string view_name, string column_name, IList< double > x_vector, IList< double > y_vector, IDictionary< string, string > options=null) | ||
| Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More... | |||
| FilterByBoxResponse | filterByBox (FilterByBoxRequest request_) | ||
| Calculates how many objects within the given table lie in a rectangular box. More... | |||
| FilterByBoxResponse | filterByBox (string table_name, string view_name, string x_column_name, double min_x, double max_x, string y_column_name, double min_y, double max_y, IDictionary< string, string > options=null) | ||
| Calculates how many objects within the given table lie in a rectangular box. More... | |||
| FilterByBoxGeometryResponse | filterByBoxGeometry (FilterByBoxGeometryRequest request_) | ||
| Calculates which geospatial geometry objects from a table intersect a rectangular box. More... | |||
| FilterByBoxGeometryResponse | filterByBoxGeometry (string table_name, string view_name, string column_name, double min_x, double max_x, double min_y, double max_y, IDictionary< string, string > options=null) | ||
| Calculates which geospatial geometry objects from a table intersect a rectangular box. More... | |||
| FilterByGeometryResponse | filterByGeometry (FilterByGeometryRequest request_) | ||
| Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More... | |||
| FilterByGeometryResponse | filterByGeometry (string table_name, string view_name, string column_name, string input_wkt, string operation, IDictionary< string, string > options=null) | ||
| Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More... | |||
| FilterByListResponse | filterByList (FilterByListRequest request_) | ||
| Calculates which records from a table have values in the given list for the corresponding column. More... | |||
| FilterByListResponse | filterByList (string table_name, string view_name, IDictionary< string, IList< string >> column_values_map, IDictionary< string, string > options=null) | ||
| Calculates which records from a table have values in the given list for the corresponding column. More... | |||
| FilterByRadiusResponse | filterByRadius (FilterByRadiusRequest request_) | ||
| Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More... | |||
| FilterByRadiusResponse | filterByRadius (string table_name, string view_name, string x_column_name, double x_center, string y_column_name, double y_center, double radius, IDictionary< string, string > options=null) | ||
| Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More... | |||
| FilterByRadiusGeometryResponse | filterByRadiusGeometry (FilterByRadiusGeometryRequest request_) | ||
| Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More... | |||
| FilterByRadiusGeometryResponse | filterByRadiusGeometry (string table_name, string view_name, string column_name, double x_center, double y_center, double radius, IDictionary< string, string > options=null) | ||
| Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More... | |||
| FilterByRangeResponse | filterByRange (FilterByRangeRequest request_) | ||
| Calculates which objects from a table have a column that is within the given bounds. More... | |||
| FilterByRangeResponse | filterByRange (string table_name, string view_name, string column_name, double lower_bound, double upper_bound, IDictionary< string, string > options=null) | ||
| Calculates which objects from a table have a column that is within the given bounds. More... | |||
| FilterBySeriesResponse | filterBySeries (FilterBySeriesRequest request_) | ||
| Filters objects matching all points of the given track (works only on track type data). More... | |||
| FilterBySeriesResponse | filterBySeries (string table_name, string view_name, string track_id, IList< string > target_track_ids, IDictionary< string, string > options=null) | ||
| Filters objects matching all points of the given track (works only on track type data). More... | |||
| FilterByStringResponse | filterByString (FilterByStringRequest request_) | ||
| Calculates which objects from a table, collection, or view match a string expression for the given string columns. More... | |||
| FilterByStringResponse | filterByString (string table_name, string view_name, string expression, string mode, IList< string > column_names, IDictionary< string, string > options=null) | ||
| Calculates which objects from a table, collection, or view match a string expression for the given string columns. More... | |||
| FilterByTableResponse | filterByTable (FilterByTableRequest request_) | ||
| Filters objects in one table based on objects in another table. More... | |||
| FilterByTableResponse | filterByTable (string table_name, string view_name, string column_name, string source_table_name, string source_table_column_name, IDictionary< string, string > options=null) | ||
| Filters objects in one table based on objects in another table. More... | |||
| FilterByValueResponse | filterByValue (FilterByValueRequest request_) | ||
| Calculates which objects from a table has a particular value for a particular column. More... | |||
| FilterByValueResponse | filterByValue (string table_name, string view_name, bool is_string, double _value, string value_str, string column_name, IDictionary< string, string > options=null) | ||
| Calculates which objects from a table has a particular value for a particular column. More... | |||
| GetJobResponse | getJob (GetJobRequest request_) | ||
| |||
| GetJobResponse | getJob (int job_id, IDictionary< string, string > options=null) | ||
| |||
| 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 from the requested column(s). 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 from the requested column(s). More... | |||
| GetRecordsBySeriesResponse< T > | getRecordsBySeries< T > (GetRecordsBySeriesRequest request_) | ||
| Retrieves the complete series/track records from the given based on the partial track information contained in the . More... | |||
| GetRecordsBySeriesResponse< T > | getRecordsBySeries< T > (string table_name, string world_table_name, int offset=0, int limit=250, IDictionary< string, string > options=null) | ||
| Retrieves the complete series/track records from the given world_table_name based on the partial track information contained in the table_name . More... | |||
| GetRecordsFromCollectionResponse< T > | getRecordsFromCollection< T > (GetRecordsFromCollectionRequest request_) | ||
| Retrieves records from a collection. More... | |||
| GetRecordsFromCollectionResponse< T > | getRecordsFromCollection< T > (string table_name, long offset=0, long limit=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=null) | ||
| Grants a system-level permission to a user or role. More... | |||
| GrantPermissionTableResponse | grantPermissionTable (GrantPermissionTableRequest request_) | ||
| Grants a table-level permission to a user or role. More... | |||
| GrantPermissionTableResponse | grantPermissionTable (string name, string permission, string table_name, string filter_expression="", IDictionary< string, string > options=null) | ||
| Grants a table-level permission to a user or role. More... | |||
| GrantRoleResponse | grantRole (GrantRoleRequest request_) | ||
| Grants membership in a role to a user or role. More... | |||
| GrantRoleResponse | grantRole (string role, string member, IDictionary< string, string > options=null) | ||
| Grants membership in a role to a user or role. More... | |||
| HasProcResponse | hasProc (HasProcRequest request_) | ||
| Checks the existence of a proc with the given name. More... | |||
| HasProcResponse | hasProc (string proc_name, IDictionary< string, string > options=null) | ||
| Checks the existence of a proc with the given name. More... | |||
| HasTableResponse | hasTable (HasTableRequest request_) | ||
| Checks for the existence of a table with the given name. More... | |||
| HasTableResponse | hasTable (string table_name, IDictionary< string, string > options=null) | ||
| Checks for the existence of a table with the given name. More... | |||
| HasTypeResponse | hasType (HasTypeRequest request_) | ||
| Check for the existence of a type. More... | |||
| HasTypeResponse | hasType (string type_id, IDictionary< string, string > options=null) | ||
| Check for the existence of a type. More... | |||
| InsertRecordsResponse | insertRecordsRaw (RawInsertRecordsRequest request_) | ||
| Adds multiple records to the specified table. More... | |||
| InsertRecordsResponse | insertRecords< T > (InsertRecordsRequest< T > request_) | ||
| Adds multiple records to the specified table. More... | |||
| InsertRecordsResponse | insertRecords< T > (string table_name, IList< T > data, IDictionary< string, string > options=null) | ||
| Adds multiple records to the specified table. More... | |||
| 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... | |||
| MergeRecordsResponse | mergeRecords (MergeRecordsRequest request_) | ||
| Create a new empty result table (specified by ), and insert all records from source tables (specified by ) based on the field mapping information (specified by ). More... | |||
| MergeRecordsResponse | mergeRecords (string table_name, IList< string > source_table_names, IList< IDictionary< string, string >> field_maps, IDictionary< string, string > options=null) | ||
| Create a new empty result table (specified by table_name ), and insert all records from source tables (specified by source_table_names ) based on the field mapping information (specified by field_maps ). More... | |||
| RevokePermissionSystemResponse | revokePermissionSystem (RevokePermissionSystemRequest request_) | ||
| Revokes a system-level permission from a user or role. More... | |||
| RevokePermissionSystemResponse | revokePermissionSystem (string name, string permission, IDictionary< string, string > options=null) | ||
| Revokes a system-level permission from a user or role. More... | |||
| RevokePermissionTableResponse | revokePermissionTable (RevokePermissionTableRequest request_) | ||
| Revokes a table-level permission from a user or role. More... | |||
| RevokePermissionTableResponse | revokePermissionTable (string name, string permission, string table_name, IDictionary< string, string > options=null) | ||
| Revokes a table-level permission from a user or role. More... | |||
| RevokeRoleResponse | revokeRole (RevokeRoleRequest request_) | ||
| Revokes membership in a role from a user or role. More... | |||
| RevokeRoleResponse | revokeRole (string role, string member, IDictionary< string, string > options=null) | ||
| Revokes membership in a role from a user or role. More... | |||
| 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=null) | ||
| 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 tables, views, and collections. More... | |||
| ShowTableResponse | showTable (string table_name, IDictionary< string, string > options=null) | ||
| Retrieves detailed information about tables, views, and collections. More... | |||
| ShowTableMetadataResponse | showTableMetadata (ShowTableMetadataRequest request_) | ||
| Retrieves the user provided metadata for the specified tables. More... | |||
| ShowTableMetadataResponse | showTableMetadata (IList< string > table_names, IDictionary< string, string > options=null) | ||
| Retrieves the user provided metadata for the specified tables. More... | |||
| ShowTablesByTypeResponse | showTablesByType (ShowTablesByTypeRequest request_) | ||
| Gets names of the tables whose type matches the given criteria. More... | |||
| ShowTablesByTypeResponse | showTablesByType (string type_id, string label, IDictionary< string, string > options=null) | ||
| Gets names of the tables whose type matches the given criteria. More... | |||
| ShowTriggersResponse | showTriggers (ShowTriggersRequest request_) | ||
| Retrieves information regarding the specified triggers or all existing triggers currently active. More... | |||
| ShowTriggersResponse | showTriggers (IList< string > trigger_ids, IDictionary< string, string > options=null) | ||
| Retrieves information regarding the specified triggers or all existing triggers currently active. More... | |||
| ShowTypesResponse | showTypes (ShowTypesRequest request_) | ||
| Retrieves information for the specified data type ID or type label. More... | |||
| ShowTypesResponse | showTypes (string type_id, string label, IDictionary< string, string > options=null) | ||
| Retrieves information for the specified data type ID or type label. More... | |||
| UpdateRecordsResponse | updateRecordsRaw (RawUpdateRecordsRequest request_) | ||
| Runs multiple predicate-based updates in a single call. More... | |||
| UpdateRecordsResponse | updateRecords< T > (UpdateRecordsRequest< T > request_) | ||
| Runs multiple predicate-based updates in a single call. More... | |||
| UpdateRecordsResponse | updateRecords< T > (string table_name, IList< string > expressions, IList< IDictionary< string, string >> new_values_maps, IList< T > data=null, IDictionary< string, string > options=null) | ||
| Runs multiple predicate-based updates in a single call. More... | |||
| UpdateRecordsBySeriesResponse | updateRecordsBySeries (UpdateRecordsBySeriesRequest request_) | ||
| Updates the view specified by to include full series (track) information from the for the series (tracks) present in the . More... | |||
| UpdateRecordsBySeriesResponse | updateRecordsBySeries (string table_name, string world_table_name, string view_name="", IList< string > reserved=null, IDictionary< string, string > options=null) | ||
| Updates the view specified by table_name to include full series (track) information from the world_table_name for the series (tracks) present in the view_name . More... | |||
| VisualizeImageChartResponse | visualizeImageChart (VisualizeImageChartRequest request_) | ||
| Scatter plot is the only plot type currently supported. More... | |||
| VisualizeImageChartResponse | visualizeImageChart (string table_name, IList< string > x_column_names, IList< string > y_column_names, double min_x, double max_x, double min_y, double max_y, int width, int height, string bg_color, IDictionary< string, IList< string >> style_options, IDictionary< string, string > options=null) | ||
| Scatter plot is the only plot type currently supported. More... | |||
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.2.0.1" |
Properties | |
| string | Url [get] |
| URL for Kinetica Server (including "http:" and port) as a string More... | |
| Uri | URL [get] |
| URL for Kinetica Server (including "http:" and port) More... | |
| string | Username [get] |
| Optional: User Name for Kinetica security More... | |
| bool | UseSnappy = null [get, set] |
| Use Snappy More... | |
| int | ThreadCount = false [get, set] |
| Thread Count More... | |
API to talk to Kinetica Database
Definition at line 40 of file Kinetica.cs.
|
inline |
API Constructor
| url_str | URL for Kinetica Server (including "http:" and port) |
| options | Optional connection options |
Definition at line 128 of file Kinetica.cs.
|
inline |
Given a table name, add its record type to enable proper encoding of records for insertion or updates.
| table_name | Name of the table. |
| obj_type | The type associated with the table. |
Definition at line 158 of file Kinetica.cs.
|
inline |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
| request_ | Request object containing the parameters for the operation. |
Definition at line 37 of file KineticaFunctions.cs.
|
inline |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
| job_ids | Jobs to be modified. |
| action | Action to be performed on the jobs specified by job_ids. Supported values: |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 69 of file KineticaFunctions.cs.
|
inline |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
| request_ | Request object containing the parameters for the operation. |
Definition at line 87 of file KineticaFunctions.cs.
|
inline |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
| offline | Set to true if desired state is offline. Supported values: |
| options | Optional parameters.
|
Definition at line 135 of file KineticaFunctions.cs.
|
inline |
Retrieves a list of the most recent alerts generated.
The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest
| request_ | Request object containing the parameters for the operation. |
Definition at line 152 of file KineticaFunctions.cs.
|
inline |
Retrieves a list of the most recent alerts generated.
The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest
| num_alerts | Number of most recent alerts to request. The response will return alerts, or less if there are less in the system. A value of 0 returns all stored alerts. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 175 of file KineticaFunctions.cs.
|
inline |
Get a list of the current jobs in GPUdb.
| request_ | Request object containing the parameters for the operation. |
Definition at line 190 of file KineticaFunctions.cs.
|
inline |
Get a list of the current jobs in GPUdb.
| options | Optional parameters.
|
Definition at line 224 of file KineticaFunctions.cs.
|
inline |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
| request_ | Request object containing the parameters for the operation. |
Definition at line 241 of file KineticaFunctions.cs.
|
inline |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 260 of file KineticaFunctions.cs.
|
inline |
Exits the database server application.
| request_ | Request object containing the parameters for the operation. |
Definition at line 274 of file KineticaFunctions.cs.
|
inline |
Exits the database server application.
| exit_type | Reserved for future use. User can pass an empty string. |
| authorization | No longer used. User can pass an empty string. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 294 of file KineticaFunctions.cs.
|
inline |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
| request_ | Request object containing the parameters for the operation. |
Definition at line 314 of file KineticaFunctions.cs.
|
inline |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
| options | Optional parameters.
|
Definition at line 371 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the convex hull for the values in a table specified by .
| request_ | Request object containing the parameters for the operation. |
Definition at line 387 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the convex hull for the values in a table specified by table_name .
| table_name | Name of table on which the operation will be performed. Must be an existing table. It cannot be a collection. |
| x_column_name | Name of the column containing the x coordinates of the points for the operation being performed. |
| y_column_name | Name of the column containing the y coordinates of the points for the operation being performed. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 413 of file KineticaFunctions.cs.
|
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.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the and parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected ( is 0 and is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of is an unrestricted-length string.
| request_ | Request object containing the parameters for the operation. |
Definition at line 508 of file KineticaFunctions.cs.
|
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.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of column_names is an unrestricted-length string.
| table_name | Name of the table on which the operation will be performed. Must be an existing table/view/collection. |
| column_names | List of one or more column names, expressions, and aggregate expressions. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 1000. |
| options | Optional parameters.
|
Definition at line 843 of file KineticaFunctions.cs.
|
inline |
Performs a histogram calculation given a table, a column, and an interval function.
The is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.
| request_ | Request object containing the parameters for the operation. |
Definition at line 878 of file KineticaFunctions.cs.
|
inline |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.
| table_name | Name of the table on which the operation will be performed. Must be an existing table or collection. |
| column_name | Name of a column or an expression of one or more column names over which the histogram will be calculated. |
| start | Lower end value of the histogram interval, inclusive. |
| end | Upper end value of the histogram interval, inclusive. |
| interval | The size of each bin within the start and end parameters. |
| options | Optional parameters.
|
Definition at line 929 of file KineticaFunctions.cs.
|
inline |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| request_ | Request object containing the parameters for the operation. |
Definition at line 963 of file KineticaFunctions.cs.
|
inline |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| table_name | Name of the table on which the operation will be performed. Must be an existing table or collection. |
| column_names | List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns. |
| k | The number of mean points to be determined by the algorithm. |
| tolerance | Stop iterating when the distances between successive points is less than the given tolerance. |
| options | Optional parameters.
|
Definition at line 1023 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum values of a particular column in a table.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1043 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum values of a particular column in a table.
| table_name | Name of the table on which the operation will be performed. Must be an existing table. |
| column_name | Name of a column or an expression of one or more column on which the min-max will be calculated. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 1064 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1083 of file KineticaFunctions.cs.
|
inline |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
| table_name | Name of the table on which the operation will be performed. Must be an existing table. |
| column_name | Name of a geospatial geometry column on which the min-max will be calculated. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 1105 of file KineticaFunctions.cs.
|
inline |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight_column_name to be specified in . The weighted average is then defined as the sum of the products of times the weight_column_name values divided by the sum of the weight_column_name values.
Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1168 of file KineticaFunctions.cs.
|
inline |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight_column_name to be specified in options . The weighted average is then defined as the sum of the products of column_name times the weight_column_name values divided by the sum of the weight_column_name values.
Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of column_name x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.
| table_name | Name of the table on which the statistics operation will be performed. |
| column_name | Name of the primary column for which the statistics are to be calculated. |
| stats | Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
|
| options | Optional parameters.
|
Definition at line 1340 of file KineticaFunctions.cs.
|
inline |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in . The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.
There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1387 of file KineticaFunctions.cs.
|
inline |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in options . The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.
There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, options bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| table_name | Name of the table on which the ranged-statistics operation will be performed. |
| select_expression | For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''. |
| column_name | Name of the binning-column used to divide the set samples into bins. |
| value_column_name | Name of the value-column for which statistics are to be computed. |
| stats | A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum. |
| start | The lower bound of the binning-column. |
| end | The upper bound of the binning-column. |
| interval | The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval*i, start+interval*(i+1)). |
| options | Map of optional parameters:
|
Definition at line 1476 of file KineticaFunctions.cs.
|
inline |
Returns all the unique values from a particular column (specified by ) of a particular table or collection (specified by ).
If is a numeric column the values will be in . Otherwise if is a string column the values will be in . The results can be paged via the and parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the , the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if is a collection or when the value of is an unrestricted-length string.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1550 of file KineticaFunctions.cs.
|
inline |
Returns all the unique values from a particular column (specified by column_name ) of a particular table or collection (specified by table_name ).
If column_name is a numeric column the values will be in . Otherwise if column_name is a string column the values will be in . The results can be paged via the offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options , the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the column_name , the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if table_name is a collection or when the value of column_name is an unrestricted-length string.
| table_name | Name of an existing table/collection on which the operation will be performed. |
| column_name | Name of the column or an expression containing one or more column names on which the unique function would be applied. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000. |
| options | Optional parameters.
|
Definition at line 1754 of file KineticaFunctions.cs.
|
inline |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 1790 of file KineticaFunctions.cs.
|
inline |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| table_name | Name of the table on which the operation will be performed. Must be an existing table/view. |
| column_names | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. |
| variable_column_name | Specifies the variable/parameter column name. The default value is ''. |
| value_column_name | Specifies the value column name. The default value is ''. |
| pivoted_columns | List of one or more values typically the column names of the input table. All the columns in the source table must have the same data type. |
| options | Optional parameters.
|
Definition at line 1969 of file KineticaFunctions.cs.
|
inline |
The Kinetica.alterSystemProperties(IDictionary<string, string>,IDictionary<string, string>) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.
Commands are given through the whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
| request_ | Request object containing the parameters for the operation. |
Definition at line 2000 of file KineticaFunctions.cs.
|
inline |
The Kinetica.alterSystemProperties(IDictionary<string, string>,IDictionary<string, string>) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.
Commands are given through the property_updates_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
| property_updates_map | Map containing the properties of the system to be updated. Error if empty.
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 2197 of file KineticaFunctions.cs.
|
inline |
Apply various modifications to a table, view, or collection.
The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
Allow homogeneous tables within a collection.
Manage a table's columns–a column can be added, removed, or have its type and properties modified.
Set or unset compression for a column.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2256 of file KineticaFunctions.cs.
|
inline |
Apply various modifications to a table, view, or collection.
The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
Allow homogeneous tables within a collection.
Manage a table's columns–a column can be added, removed, or have its type and properties modified.
Set or unset compression for a column.
| table_name | Table on which the operation will be performed. Must be an existing table, view, or collection. |
| action | Modification operation to be applied Supported values:
|
| _value | The value of the modification. May be a column name, 'true' or 'false', a TTL, or the global access mode depending on . |
| options | Optional parameters.
|
Definition at line 2612 of file KineticaFunctions.cs.
|
inline |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2633 of file KineticaFunctions.cs.
|
inline |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
| table_names | Names of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned. |
| metadata_map | A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 2661 of file KineticaFunctions.cs.
|
inline |
Alters a user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2679 of file KineticaFunctions.cs.
|
inline |
Alters a user.
| name | Name of the user to be altered. Must be an existing user. |
| action | Modification operation to be applied to the user. Supported values:
|
| _value | The value of the modification, depending on . |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 2710 of file KineticaFunctions.cs.
|
inline |
Append (or insert) all records from a source table (specified by ) to a particular target table (specified by ).
The field map (specified by ) holds the user specified map of target table column names with their mapped source column names.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2734 of file KineticaFunctions.cs.
|
inline |
Append (or insert) all records from a source table (specified by source_table_name ) to a particular target table (specified by table_name ).
The field map (specified by field_map ) holds the user specified map of target table column names with their mapped source column names.
| table_name | The table name for the records to be appended. Must be an existing table. |
| source_table_name | The source table name to get records from. Must be an existing table name. |
| field_map | Contains the mapping of column names from the target table (specified by ) as the keys, and corresponding column names or expressions (e.g., 'col_name+1') from the source table (specified by ). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions. |
| options | Optional parameters.
|
Definition at line 2858 of file KineticaFunctions.cs.
|
inline |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2880 of file KineticaFunctions.cs.
|
inline |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
| table_name | Name of the table to be cleared. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''. |
| authorization | No longer used. User can pass an empty string. The default value is ''. |
| options | Optional parameters.
|
Definition at line 2930 of file KineticaFunctions.cs.
|
inline |
Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary<string, string>).
| request_ | Request object containing the parameters for the operation. |
Definition at line 2948 of file KineticaFunctions.cs.
|
inline |
Deactivates a table monitor previously created with Kinetica.createTableMonitor(string,IDictionary<string, string>).
| topic_id | The topic ID returned by /create/tablemonitor. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 2968 of file KineticaFunctions.cs.
|
inline |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 2986 of file KineticaFunctions.cs.
|
inline |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
| trigger_id | ID for the trigger to be deactivated. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 3007 of file KineticaFunctions.cs.
|
inline |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by Kinetica.getJob(int,IDictionary<string, string>).
| request_ | Request object containing the parameters for the operation. |
Definition at line 3027 of file KineticaFunctions.cs.
|
inline |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by Kinetica.getJob(int,IDictionary<string, string>).
| endpoint | Indicates which endpoint to execute, e.g. '/alter/table'. |
| request_encoding | The encoding of the request payload for the job. Supported values: The default value is BINARY. |
| data | Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then must be binary or snappy. |
| data_str | JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then must be json. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 3086 of file KineticaFunctions.cs.
|
inline |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3111 of file KineticaFunctions.cs.
|
inline |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
| join_table_name | Name of the join table to be created. Has the same naming restrictions as tables. |
| table_names | The list of table names composing the join. Corresponds to a SQL statement FROM clause. |
| column_names | List of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions composing the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables. |
| expressions | An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 3300 of file KineticaFunctions.cs.
|
inline |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains , which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3331 of file KineticaFunctions.cs.
|
inline |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains , which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| table_name | Name of the table to be created that is the top-level table of the materialized view. |
| options | Optional parameters.
|
Definition at line 3451 of file KineticaFunctions.cs.
|
inline |
Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.
For details on UDFs, see: User-Defined Functions
| request_ | Request object containing the parameters for the operation. |
Definition at line 3471 of file KineticaFunctions.cs.
|
inline |
Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.
For details on UDFs, see: User-Defined Functions
| proc_name | Name of the proc to be created. Must not be the name of a currently existing proc. |
| execution_mode | The execution mode of the proc. Supported values:
|
| files | A map of the files that make up the proc. The keys of the map are file names, and the values are the binary contents of the files. The file names may include subdirectory names (e.g. 'subdir/file') but must not resolve to a directory above the root for the proc. The default value is an empty Dictionary. |
| command | The command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc and may be any command that can be resolved from that directory. It need not refer to a file actually in that directory; for example, it could be 'java' if the proc is a Java application; however, any necessary external programs must be preinstalled on every database node. If the command refers to a file in that directory, it must be preceded with './' as per Linux convention. If not specified, and exactly one file is provided in , that file will be invoked. The default value is ''. |
| args | An array of command-line arguments that will be passed to when the proc is executed. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 3547 of file KineticaFunctions.cs.
|
inline |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.getRecordsByColumn(string,IList<string>,long,long,IDictionary<string, string>).
A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3589 of file KineticaFunctions.cs.
|
inline |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.getRecordsByColumn(string,IList<string>,long,long,IDictionary<string, string>).
A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.
| table_name | Name of the existing table on which the projection is to be applied. |
| projection_name | Name of the projection to be created. Has the same naming restrictions as tables. |
| column_names | List of columns from to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax 'column_name as alias'. |
| options | Optional parameters.
|
Definition at line 3791 of file KineticaFunctions.cs.
|
inline |
Creates a new role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3810 of file KineticaFunctions.cs.
|
inline |
Creates a new role.
| name | Name of the role to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 3830 of file KineticaFunctions.cs.
|
inline |
Creates a new table or collection.
If a new table is being created, the type of the table is given by , which must 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 and set the is_collection option to true; will be ignored.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3857 of file KineticaFunctions.cs.
|
inline |
Creates a new table or collection.
If a new table is being created, the type of the table is given by type_id , which must 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.
| table_name | Name of the table to be created. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions. |
| type_id | ID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true. |
| options | Optional parameters.
|
Definition at line 4044 of file KineticaFunctions.cs.
|
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(string,IDictionary<string, string>).
| request_ | Request object containing the parameters for the operation. |
Definition at line 4072 of file KineticaFunctions.cs.
|
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>).
| table_name | Name of the table to monitor. Must not refer to a collection. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4102 of file KineticaFunctions.cs.
|
inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of Kinetica.createTriggerByRange(string,IList<string>,string,double,double,IDictionary<string, string>).) Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>) with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via Kinetica.showSystemStatus(IDictionary<string, string>)) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary<string, string>) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 4135 of file KineticaFunctions.cs.
|
inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of Kinetica.createTriggerByRange(string,IList<string>,string,double,double,IDictionary<string, string>).) Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>) with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via Kinetica.showSystemStatus(IDictionary<string, string>)) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary<string, string>) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_id | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| table_names | Names of the tables on which the trigger will be activated and maintained. |
| x_column_name | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. |
| x_vector | The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region. |
| y_column_name | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. |
| y_vector | The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4187 of file KineticaFunctions.cs.
|
inline |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>) with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via Kinetica.showSystemStatus(IDictionary<string, string>)) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary<string, string>) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 4226 of file KineticaFunctions.cs.
|
inline |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>) with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via Kinetica.showSystemStatus(IDictionary<string, string>)) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary<string, string>) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_id | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| table_names | Tables on which the trigger will be active. |
| column_name | Name of a numeric column_name on which the trigger is activated. |
| min | The lower bound (inclusive) for the trigger range. |
| max | The upper bound (inclusive) for the trigger range. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4267 of file KineticaFunctions.cs.
|
inline |
Creates a new type describing the layout or schema of a table.
The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.
A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
| request_ | Request object containing the parameters for the operation. |
Definition at line 4330 of file KineticaFunctions.cs.
|
inline |
Creates a new type describing the layout or schema of a table.
The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.
A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
| type_definition | a JSON string describing the columns of the type to be registered. |
| label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
| properties | Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type). Valid values are:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4626 of file KineticaFunctions.cs.
|
inline |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| request_ | Request object containing the parameters for the operation. |
Definition at line 4676 of file KineticaFunctions.cs.
|
inline |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| table_name | Name of the table to be created. Has the same naming restrictions as tables. |
| table_names | The list of table names to merge. Must contain the names of one or more existing tables. |
| input_column_names | The list of columns from each of the corresponding input tables. |
| output_column_names | The list of names of the columns to be stored in the output table. |
| options | Optional parameters.
|
Definition at line 4903 of file KineticaFunctions.cs.
|
inline |
Creates a new external user (a user whose credentials are managed by an external LDAP).
| request_ | Request object containing the parameters for the operation. |
Definition at line 4924 of file KineticaFunctions.cs.
|
inline |
Creates a new external user (a user whose credentials are managed by an external LDAP).
| name | Name of the user to be created. Must exactly match the user's name in the external LDAP, prefixed with a . Must not be the same name as an existing user. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4944 of file KineticaFunctions.cs.
|
inline |
Creates a new internal user (a user whose credentials are managed by the database system).
| request_ | Request object containing the parameters for the operation. |
Definition at line 4960 of file KineticaFunctions.cs.
|
inline |
Creates a new internal user (a user whose credentials are managed by the database system).
| name | Name of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role. |
| password | Initial password of the user to be created. May be an empty string for no password. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 4983 of file KineticaFunctions.cs.
|
inline |
Given a KineticaType object for a certain record type, decode binary data into distinct records (objects).
| T | The type of the records. |
| record_type | The type for the records. |
| records_binary | The binary encoded data to be decoded. |
| records | The decoded objects/records. |
| T | : | new() |
Definition at line 200 of file Kinetica.cs.
|
inline |
Given a schema string for a certain record type, decode binary data into distinct records (objects).
| T | The type of the records. |
| schema_string | The schema for the records. |
| records_binary | The binary encoded data to be decoded. |
| records | The decoded objects/records. |
| T | : | new() |
Definition at line 221 of file Kinetica.cs.
|
inline |
Given a list of schema strings, decode binary data into distinct records (objects).
| T | The type of the records. |
| schema_strings | The schemas for the records. |
| lists_records_binary | The binary encoded data to be decoded (the data is in a 2D list). |
| record_lists | The decoded objects/records in a 2d list. |
| T | : | new() |
Definition at line 245 of file Kinetica.cs.
|
inline |
Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects).
| T | The type of the records. |
| type_ids | The IDs for each of the records' types. |
| records_binary | The binary encoded data to be decoded. |
| records | The decoded objects/records. |
| T | : | new() |
Definition at line 285 of file Kinetica.cs.
|
inline |
Given IDs of records types registered with Kinetica, decode binary data into distinct records (objects).
| T | The type of the records. |
| type_ids | The IDs for each of the lists of records. |
| lists_records_binary | The binary encoded data to be decoded in a 2d list. |
| record_lists | The decoded objects/records in a 2d list. |
| T | : | new() |
Definition at line 314 of file Kinetica.cs.
|
inline |
Deletes a proc.
Any currently running instances of the proc will be killed.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5001 of file KineticaFunctions.cs.
|
inline |
Deletes a proc.
Any currently running instances of the proc will be killed.
| proc_name | Name of the proc to be deleted. Must be the name of a currently existing proc. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 5020 of file KineticaFunctions.cs.
|
inline |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5044 of file KineticaFunctions.cs.
|
inline |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
| table_name | Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view. |
| expressions | A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more is mutually exclusive to specifying record_id in the . |
| options | Optional parameters.
|
Definition at line 5119 of file KineticaFunctions.cs.
|
inline |
Deletes an existing role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5136 of file KineticaFunctions.cs.
|
inline |
Deletes an existing role.
| name | Name of the role to be deleted. Must be an existing role. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 5154 of file KineticaFunctions.cs.
|
inline |
Deletes an existing user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5169 of file KineticaFunctions.cs.
|
inline |
Deletes an existing user.
| name | Name of the user to be deleted. Must be an existing user. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 5187 of file KineticaFunctions.cs.
|
inline |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5203 of file KineticaFunctions.cs.
|
inline |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
| proc_name | Name of the proc to execute. Must be the name of a currently existing proc. |
| _params | A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary. |
| bin_params | A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary. |
| input_table_names | Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table. If no table names are specified, no data will be passed to the proc. The default value is an empty List. |
| input_column_names | Map of table names from to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from is not included, all columns from that table will be passed to the proc. The default value is an empty Dictionary. |
| output_table_names | Names of the tables to which output data from the proc will be written. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from , excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 5291 of file KineticaFunctions.cs.
|
inline |
Filters data based on the specified expression.
The results are stored in a result set with the given .
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5324 of file KineticaFunctions.cs.
|
inline |
Filters data based on the specified expression.
The results are stored in a result set with the given view_name .
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| table_name | Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| expression | The select expression to filter the specified table. For details see Expressions. |
| options | Optional parameters.
|
Definition at line 5387 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name passed in as part of the input.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5411 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.
| table_name | Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| x_column_name | Name of the column containing the x values to be filtered. |
| x_vector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| y_column_name | Name of the column containing the y values to be filtered. |
| y_vector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
Definition at line 5462 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name passed in as part of the input.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5492 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.
| table_name | Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. The default value is ''. |
| column_name | Name of the geospatial geometry column to be filtered. |
| x_vector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| y_vector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
Definition at line 5540 of file KineticaFunctions.cs.
|
inline |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a is passed in as part of the input payload.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5571 of file KineticaFunctions.cs.
|
inline |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.
| table_name | Name of the table on which the bounding box operation will be performed. Must be an existing table. |
| view_name | Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables. The default value is ''. |
| x_column_name | Name of the column on which to perform the bounding box query. Must be a valid numeric column. |
| min_x | Lower bound for the column chosen by . Must be less than or equal to . |
| max_x | Upper bound for . Must be greater than or equal to . |
| y_column_name | Name of a column on which to perform the bounding box query. Must be a valid numeric column. |
| min_y | Lower bound for . Must be less than or equal to . |
| max_y | Upper bound for . Must be greater than or equal to . |
| options | Optional parameters.
|
Definition at line 5626 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a is passed in as part of the input payload.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5658 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.
| table_name | Name of the table on which the bounding box operation will be performed. Must be an existing table. |
| view_name | Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view. The default value is ''. |
| column_name | Name of the geospatial geometry column to be filtered. |
| min_x | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to . |
| max_x | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to . |
| min_y | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to . |
| max_y | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to . |
| options | Optional parameters.
|
Definition at line 5712 of file KineticaFunctions.cs.
|
inline |
Applies a geometry filter against a geospatial geometry column in a given table, collection or view.
The filtering geometry is provided by .
| request_ | Request object containing the parameters for the operation. |
Definition at line 5741 of file KineticaFunctions.cs.
|
inline |
Applies a geometry filter against a geospatial geometry column in a given table, collection or view.
The filtering geometry is provided by input_wkt .
| table_name | Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_name | Name of the column to be used in the filter. Must be a geospatial geometry column. |
| input_wkt | A geometry in WKT format that will be used to filter the objects in . The default value is ''. |
| operation | The geometric filtering operation to perform Supported values:
|
| options | Optional parameters.
|
Definition at line 5837 of file KineticaFunctions.cs.
|
inline |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3
and y = 0.0" would not be returned because the values in the given lists do not correspond.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5874 of file KineticaFunctions.cs.
|
inline |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a view_name is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3
and y = 0.0" would not be returned because the values in the given lists do not correspond.
| table_name | Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_values_map | List of values for the corresponding column in the table |
| options | Optional parameters.
|
Definition at line 5950 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e.
circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| request_ | Request object containing the parameters for the operation. |
Definition at line 5980 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e.
circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view_name is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| table_name | Name of the table on which the filter by radius operation will be performed. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| x_column_name | Name of the column to be used for the x-coordinate (the longitude) of the center. |
| x_center | Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180. |
| y_column_name | Name of the column to be used for the y-coordinate-the latitude-of the center. |
| y_center | Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90. |
| radius | The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| options | Optional parameters.
|
Definition at line 6039 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.
circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a is passed in as part of the request.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6071 of file KineticaFunctions.cs.
|
inline |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.
circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view_name is passed in as part of the request.
| table_name | Name of the table on which the filter by radius operation will be performed. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. The default value is ''. |
| column_name | Name of the geospatial geometry column to be filtered. |
| x_center | Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180. |
| y_center | Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90. |
| radius | The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| options | Optional parameters.
|
Definition at line 6123 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by is added to the view if its column is within [, ] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| request_ | Request object containing the parameters for the operation. |
Definition at line 6162 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by table_name is added to the view view_name if its column is within [lower_bound , upper_bound ] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| table_name | Name of the table on which the filter by range operation will be performed. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_name | Name of a column on which the operation would be applied. |
| lower_bound | Value of the lower bound (inclusive). |
| upper_bound | Value of the upper bound (inclusive). |
| options | Optional parameters.
|
Definition at line 6213 of file KineticaFunctions.cs.
|
inline |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6248 of file KineticaFunctions.cs.
|
inline |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| table_name | Name of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| track_id | The ID of the track which will act as the filtering points. Must be an existing track within the given table. |
| target_track_ids | Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set. |
| options | Optional parameters.
|
Definition at line 6337 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table, collection, or view match a string expression for the given string columns.
The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6362 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table, collection, or view match a string expression for the given string columns.
The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.
| table_name | Name of the table on which the filter operation will be performed. Must be an existing table, collection or view. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| expression | The expression with which to filter the table. |
| mode | The string filtering mode to apply. See below for details. Supported values:
|
| column_names | List of columns on which to apply the filter. Ignored for 'search' mode. |
| options | Optional parameters.
|
Definition at line 6464 of file KineticaFunctions.cs.
|
inline |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6495 of file KineticaFunctions.cs.
|
inline |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a view_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| table_name | Name of the table whose data will be filtered. Must be an existing table. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| column_name | Name of the column by whose value the data will be filtered from the table designated by . |
| source_table_name | Name of the table whose data will be compared against in the table called . Must be an existing table. |
| source_table_column_name | Name of the column in the whose values will be used as the filter for table . Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the . |
| options | Optional parameters.
|
Definition at line 6643 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6676 of file KineticaFunctions.cs.
|
inline |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| table_name | Name of an existing table on which to perform the calculation. |
| view_name | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. |
| is_string | Indicates whether the value being searched for is string or numeric. |
| _value | The value to search for. The default value is 0. |
| value_str | The string value to search for. The default value is ''. |
| column_name | Name of a column on which the filter by value would be applied. |
| options | Optional parameters.
|
Definition at line 6726 of file KineticaFunctions.cs.
|
inlinestatic |
|
inline |
| request_ | Request object containing the parameters for the operation. |
Definition at line 6747 of file KineticaFunctions.cs.
|
inline |
| job_id | A unique identifier for the job whose status and result is to be fetched. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 6764 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
This operation supports paging through the data via the and parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
| T | The type of object being retrieved. |
| request_ | Request object containing the parameters for the operation. |
| T | : | new() |
Definition at line 6793 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
| T | The type of object being retrieved. |
| table_name | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000. |
| options |
|
| T | : | new() |
Definition at line 6897 of file KineticaFunctions.cs.
|
inline |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the and parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.createProjection(string,string,IList<string>,IDictionary<string, string>).
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 6936 of file KineticaFunctions.cs.
|
inline |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.createProjection(string,string,IList<string>,IDictionary<string, string>).
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| table_name | Name of the table on which this operation will be performed. The table cannot be a parent set. |
| column_names | The list of column values to retrieve. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned (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 |
|
Definition at line 7050 of file KineticaFunctions.cs.
|
inline |
Retrieves the complete series/track records from the given based on the partial track information contained in the .
This operation supports paging through the data via the and parameters.
In contrast to Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>) this returns records grouped by series/track. So if is 0 and is 5 this operation would return the first 5 series/tracks in . Each series/track will be returned sorted by their TIMESTAMP column.
| T | The type of object being retrieved. |
| request_ | Request object containing the parameters for the operation. |
| T | : | new() |
Definition at line 7089 of file KineticaFunctions.cs.
|
inline |
Retrieves the complete series/track records from the given world_table_name based on the partial track information contained in the table_name .
This operation supports paging through the data via the offset and limit parameters.
In contrast to Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>) this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in table_name . Each series/track will be returned sorted by their TIMESTAMP column.
| T | The type of object being retrieved. |
| table_name | Name of the collection/table/view for which series/tracks will be fetched. |
| world_table_name | Name of the table containing the complete series/track information to be returned for the tracks present in the . Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank. |
| offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250. |
| options | Optional parameters. The default value is an empty Dictionary. |
| T | : | new() |
Definition at line 7143 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords(string,IList<string>,IDictionary<string, string>).
This operation supports paging through the data via the and parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
| T | The type of object being retrieved. |
| request_ | Request object containing the parameters for the operation. |
| T | : | new() |
Definition at line 7177 of file KineticaFunctions.cs.
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords(string,IList<string>,IDictionary<string, string>).
This operation supports paging through the data via the offset and limit parameters.
Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.
| T | The type of object being retrieved. |
| table_name | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000. |
| options |
|
| T | : | new() |
Definition at line 7243 of file KineticaFunctions.cs.
|
inline |
Grants a system-level permission to a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7265 of file KineticaFunctions.cs.
|
inline |
Grants a system-level permission to a user or role.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role. Supported values:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7305 of file KineticaFunctions.cs.
|
inline |
Grants a table-level permission to a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7324 of file KineticaFunctions.cs.
|
inline |
Grants a table-level permission to a user or role.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role. Supported values:
|
| table_name | Name of the table to which the permission grants access. Must be an existing table, collection, or view. If a collection, the permission also applies to tables and views in the collection. |
| filter_expression | Reserved for future use. The default value is ''. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7379 of file KineticaFunctions.cs.
|
inline |
Grants membership in a role to a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7401 of file KineticaFunctions.cs.
|
inline |
Grants membership in a role to a user or role.
| role | Name of the role in which membership will be granted. Must be an existing role. |
| member | Name of the user or role that will be granted membership in . Must be an existing user or role. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7422 of file KineticaFunctions.cs.
|
inline |
Checks the existence of a proc with the given name.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7439 of file KineticaFunctions.cs.
|
inline |
Checks the existence of a proc with the given name.
| proc_name | Name of the proc to check for existence. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7458 of file KineticaFunctions.cs.
|
inline |
Checks for the existence of a table with the given name.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7474 of file KineticaFunctions.cs.
|
inline |
Checks for the existence of a table with the given name.
| table_name | Name of the table to check for existence. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7493 of file KineticaFunctions.cs.
|
inline |
Check for the existence of a type.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7508 of file KineticaFunctions.cs.
|
inline |
Check for the existence of a type.
| type_id | Id of the type returned in response to /create/type request. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 7526 of file KineticaFunctions.cs.
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| T | The type of object being added. |
| request_ | Request object containing the parameters for the operation. |
Definition at line 7593 of file KineticaFunctions.cs.
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| T | The type of object being added. |
| table_name | Table to which the records are to be added. Must be an existing table. |
| data | An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if is json. |
| options | Optional parameters.
|
Definition at line 7687 of file KineticaFunctions.cs.
|
inline |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7712 of file KineticaFunctions.cs.
|
inline |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
| table_name | Table to which random records will be added. Must be an existing table. Also, must be an individual table, not a collection of tables, nor a view of a table. |
| count | Number of records to generate. |
| options | Optional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map:
|
Definition at line 7963 of file KineticaFunctions.cs.
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7558 of file KineticaFunctions.cs.
|
inline |
Adds a symbol or icon (i.e.
an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
| request_ | Request object containing the parameters for the operation. |
Definition at line 7990 of file KineticaFunctions.cs.
|
inline |
Adds a symbol or icon (i.e.
an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
| symbol_id | The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol |
| symbol_format | Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values: |
| symbol_data | The actual symbol data. If is 'svg' then this should be the raw bytes representing an svg file. If is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z' |
| options | Optional parameters.
|
Definition at line 8051 of file KineticaFunctions.cs.
|
inline |
Kills a running proc instance.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8069 of file KineticaFunctions.cs.
|
inline |
Kills a running proc instance.
| run_id | The 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. The default value is ''. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 8089 of file KineticaFunctions.cs.
|
inline |
Manages global access to a table's data.
By default a table has a of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When is no_access then no operations are permitted on the table. The lock status can be queried by setting to status.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8113 of file KineticaFunctions.cs.
|
inline |
Manages global access to a table's data.
By default a table has a lock_type of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lock_type is no_access then no operations are permitted on the table. The lock status can be queried by setting lock_type to status.
| table_name | Name of the table to be locked. It must be a currently existing table, collection, or view. |
| lock_type | The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. Supported values:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 8172 of file KineticaFunctions.cs.
|
inline |
Create a new empty result table (specified by ), and insert all records from source tables (specified by ) based on the field mapping information (specified by ).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by ) holds the user-specified maps of target table column names to source table columns. The array of must match one-to-one with the , e.g., there's a map present in for each table listed in .
| request_ | Request object containing the parameters for the operation. |
Definition at line 8209 of file KineticaFunctions.cs.
|
inline |
Create a new empty result table (specified by table_name ), and insert all records from source tables (specified by source_table_names ) based on the field mapping information (specified by field_maps ).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by field_maps ) holds the user-specified maps of target table column names to source table columns. The array of field_maps must match one-to-one with the source_table_names , e.g., there's a map present in field_maps for each table listed in source_table_names .
| table_name | The new result table name for the records to be merged. Must NOT be an existing table. |
| source_table_names | The list of source table names to get the records from. Must be existing table names. |
| field_maps | Contains a list of source/target column mappings, one mapping for each source table listed in being merged into the target table specified by . Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column. |
| options | Optional parameters.
|
Definition at line 8338 of file KineticaFunctions.cs.
|
inline |
Revokes a system-level permission from a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8388 of file KineticaFunctions.cs.
|
inline |
Revokes a system-level permission from a user or role.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role. Supported values:
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 8430 of file KineticaFunctions.cs.
|
inline |
Revokes a table-level permission from a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8449 of file KineticaFunctions.cs.
|
inline |
Revokes a table-level permission from a user or role.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role. Supported values:
|
| table_name | Name of the table to which the permission grants access. Must be an existing table, collection, or view. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 8503 of file KineticaFunctions.cs.
|
inline |
Revokes membership in a role from a user or role.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8524 of file KineticaFunctions.cs.
|
inline |
Revokes membership in a role from a user or role.
| role | Name of the role in which membership will be revoked. Must be an existing role. |
| member | Name of the user or role that will be revoked membership in . Must be an existing user or role. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 8546 of file KineticaFunctions.cs.
|
inline |
Saves an object class type to a KineticaType association.
If the class type already exists in the map, replaces the old KineticaType value.
| objectType | The type of the object. |
| kineticaType | The associated KinetiaType object. |
Definition at line 184 of file Kinetica.cs.
|
inline |
Shows information about a proc.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8562 of file KineticaFunctions.cs.
|
inline |
Shows information about a proc.
| proc_name | Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ''. |
| options | Optional parameters.
|
Definition at line 8604 of file KineticaFunctions.cs.
|
inline |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from Kinetica.executeProc(string,IDictionary<string, string>,IDictionary<string, byte[]>,IList<string>,IDictionary<string, IList<string>>,IList<string>,IDictionary<string, string>)) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
| request_ | Request object containing the parameters for the operation. |
Definition at line 8623 of file KineticaFunctions.cs.
|
inline |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from Kinetica.executeProc(string,IDictionary<string, string>,IDictionary<string, byte[]>,IList<string>,IDictionary<string, IList<string>>,IList<string>,IDictionary<string, string>)) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
| run_id | The run ID of a specific 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. The default value is ''. |
| options | Optional parameters.
|
Definition at line 8670 of file KineticaFunctions.cs.
|
inline |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8687 of file KineticaFunctions.cs.
|
inline |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
| names | A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 8708 of file KineticaFunctions.cs.
|
inline |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8725 of file KineticaFunctions.cs.
|
inline |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
| options | Optional parameters.
|
Definition at line 8752 of file KineticaFunctions.cs.
|
inline |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8768 of file KineticaFunctions.cs.
|
inline |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
| options | Optional parameters, currently unused. The default value is an empty Dictionary. |
Definition at line 8786 of file KineticaFunctions.cs.
|
inline |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
| request_ | Request object containing the parameters for the operation. |
Definition at line 8802 of file KineticaFunctions.cs.
|
inline |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
| options | Optional parameters, currently unused. The default value is an empty Dictionary. |
Definition at line 8820 of file KineticaFunctions.cs.
|
inline |
Retrieves detailed information about tables, views, and collections.
If specifies a table or view, information specific to that entity will be returned.
If specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).
If is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.
If is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.
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 ).
| request_ | Request object containing the parameters for the operation. |
Definition at line 8862 of file KineticaFunctions.cs.
|
inline |
Retrieves detailed information about tables, views, and collections.
If table_name specifies a table or view, information specific to that entity will be returned.
If table_name specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).
If table_name is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.
If table_name is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.
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 ).
| table_name | Name of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned. |
| options | Optional parameters.
|
Definition at line 9019 of file KineticaFunctions.cs.
|
inline |
Retrieves the user provided metadata for the specified tables.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9035 of file KineticaFunctions.cs.
|
inline |
Retrieves the user provided metadata for the specified tables.
| table_names | Tables whose metadata will be fetched. All provided tables must exist, or an error is returned. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 9054 of file KineticaFunctions.cs.
|
inline |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9073 of file KineticaFunctions.cs.
|
inline |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
| type_id | Type id returned by a call to /create/type. |
| label | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 9098 of file KineticaFunctions.cs.
|
inline |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9115 of file KineticaFunctions.cs.
|
inline |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| trigger_ids | List of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 9135 of file KineticaFunctions.cs.
|
inline |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9153 of file KineticaFunctions.cs.
|
inline |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
| type_id | Type Id returned in response to a call to /create/type. |
| label | Option string that was supplied by user in a call to /create/type. |
| options | Optional parameters.
|
Definition at line 9206 of file KineticaFunctions.cs.
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in . There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 ==
'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and
(attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through .
| T | The type of object being added. |
| request_ | Request object containing the parameters for the operation. |
Definition at line 9286 of file KineticaFunctions.cs.
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in new_values_maps . There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 ==
'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and
(attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options .
| T | The type of object being added. |
| table_name | Table to be updated. Must be a currently existing table and not a collection or view. |
| expressions | A list of the actual predicates, one for each update; format should follow the guidelines /filter. |
| new_values_maps | List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of . |
| data | An optional list of new binary-avro encoded records to insert, one for each update. If one of does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List. |
| options | Optional parameters.
|
Definition at line 9432 of file KineticaFunctions.cs.
|
inline |
Updates the view specified by to include full series (track) information from the for the series (tracks) present in the .
| request_ | Request object containing the parameters for the operation. |
Definition at line 9457 of file KineticaFunctions.cs.
|
inline |
Updates the view specified by table_name to include full series (track) information from the world_table_name for the series (tracks) present in the view_name .
| table_name | Name of the view on which the update operation will be performed. Must be an existing view. |
| world_table_name | Name of the table containing the complete series (track) information. |
| view_name | Optional name of the view containing the series (tracks) which have to be updated. The default value is ''. |
| reserved | The default value is an empty List. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 9485 of file KineticaFunctions.cs.
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in . There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a collection or a result view.
This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 ==
'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and
(attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through .
| request_ | Request object containing the parameters for the operation. |
Definition at line 9245 of file KineticaFunctions.cs.
|
inline |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the field.
| request_ | Request object containing the parameters for the operation. |
Definition at line 9937 of file KineticaFunctions.cs.
|
inline |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the field.
| table_name | Name of the table containing the data to be drawn as a chart. |
| x_column_names | Names of the columns containing the data mapped to the x axis of a chart. |
| y_column_names | Names of the columns containing the data mapped to the y axis of a chart. |
| min_x | Lower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| max_x | Upper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| min_y | Lower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| max_y | Upper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| width | Width of the generated image in pixels. |
| height | Height of the generated image in pixels. |
| bg_color | Background color of the generated image. |
| style_options | Rendering style options for a chart.
|
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 10168 of file KineticaFunctions.cs.
| const string kinetica.Kinetica.API_VERSION = "6.2.0.1" |
Definition at line 19 of file KineticaFunctions.cs.
| const int kinetica.Kinetica.END_OF_SET = -9999 |
No Limit
Definition at line 45 of file Kinetica.cs.
|
getset |
Thread Count
Definition at line 112 of file Kinetica.cs.
|
get |
URL for Kinetica Server (including "http:" and port) as a string
Definition at line 82 of file Kinetica.cs.
|
get |
URL for Kinetica Server (including "http:" and port)
Definition at line 87 of file Kinetica.cs.
|
get |
Optional: User Name for Kinetica security
Definition at line 92 of file Kinetica.cs.
|
getset |
Use Snappy
Definition at line 107 of file Kinetica.cs.
1.8.13