|
Kinetica C# API
Version 7.0.19.0
|
|
Kinetica C# API
Version 7.0.19.0
|
A set of parameters for Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}). More...
Inheritance diagram for kinetica.GetRecordsByColumnRequest: Collaboration diagram for kinetica.GetRecordsByColumnRequest:Classes | |
| struct | Encoding |
| Specifies the encoding for returned records; either 'binary' or 'json'. More... | |
| struct | Options |
| |
Public Member Functions | |
| GetRecordsByColumnRequest () | |
| Constructs a GetRecordsByColumnRequest object with default parameters. More... | |
| GetRecordsByColumnRequest (string table_name, IList< string > column_names, long?offset=null, long?limit=null, IDictionary< string, string > options=null) | |
| Constructs a GetRecordsByColumnRequest object with the specified parameters. More... | |
| GetRecordsByColumnRequest (string table_name, IList< string > column_names, long?offset=null, long?limit=null, string encoding=null, IDictionary< string, string > options=null) | |
| Constructs a GetRecordsByColumnRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | table_name [get, set] |
| Name of the table on which this operation will be performed. More... | |
| IList< string > | column_names [get, set] |
| The list of column values to retrieve. More... | |
| long | offset = new List<string>() [get, set] |
| A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More... | |
| long | limit = 0 [get, set] |
| A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. More... | |
| string | encoding = -9999 [get, set] |
| Specifies the encoding for returned records; either 'binary' or 'json'. More... | |
| IDictionary< string, string > | options = Encoding.BINARY [get, set] |
| |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}).
For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as Kinetica.createProjection(string,string,IList{string},IDictionary{string, string}).
When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If table_name is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
Definition at line 47 of file GetRecordsByColumn.cs.
|
inline |
Constructs a GetRecordsByColumnRequest object with default parameters.
Definition at line 316 of file GetRecordsByColumn.cs.
|
inline |
Constructs a GetRecordsByColumnRequest object with the specified parameters.
| table_name | Name of the table on which this operation will be performed. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. The table cannot be a parent set. |
| column_names | The list of column values to retrieve. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999. |
| options |
|
Definition at line 409 of file GetRecordsByColumn.cs.
|
inline |
Constructs a GetRecordsByColumnRequest object with the specified parameters.
| table_name | Name of the table on which this operation will be performed. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. The table cannot be a parent set. |
| column_names | The list of column values to retrieve. |
| offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999. |
| encoding | Specifies the encoding for returned records; either 'binary' or 'json'. Supported values: The default value is BINARY. |
| options |
|
Definition at line 531 of file GetRecordsByColumn.cs.
|
getset |
The list of column values to retrieve.
Definition at line 208 of file GetRecordsByColumn.cs.
|
getset |
Specifies the encoding for returned records; either 'binary' or 'json'.
Supported values:
The default value is BINARY.
Definition at line 245 of file GetRecordsByColumn.cs.
|
getset |
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999.
Definition at line 227 of file GetRecordsByColumn.cs.
|
getset |
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.
Definition at line 214 of file GetRecordsByColumn.cs.
|
getset |
SORT_BY: Optional column that the data should be sorted by. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ''. SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:
The default value is ASCENDING. ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. CONVERT_WKTS_TO_WKBS: If true, then WKT string columns will be returned as WKB bytes. Supported values:
The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 311 of file GetRecordsByColumn.cs.
|
getset |
Name of the table on which this operation will be performed.
An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. The table cannot be a parent set.
Definition at line 205 of file GetRecordsByColumn.cs.
1.8.5 
