A set of parameters for Kinetica.getRecordsByColumn. More...
Inheritance diagram for kinetica.GetRecordsByColumnRequest:
Collaboration diagram for kinetica.GetRecordsByColumnRequest:
Classes | |
| struct | Encoding |
| A set of string constants for the parameter encoding. More... | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
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 or view on which this operation will be performed, in [schema_name. More... | |
| IList< string > | column_names = new List<string>() [get, set] |
| The list of column values to retrieve. More... | |
| long | offset = 0 [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 = -9999 [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 = Encoding.BINARY [get, set] |
| Specifies the encoding for returned records; either BINARY or JSON. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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... | |
Detailed Description
A set of parameters for Kinetica.getRecordsByColumn.
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.
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 39 of file GetRecordsByColumn.cs.
Constructor & Destructor Documentation
◆ GetRecordsByColumnRequest() [1/3]
|
inline |
Constructs a GetRecordsByColumnRequest object with default parameters.
Definition at line 249 of file GetRecordsByColumn.cs.
◆ GetRecordsByColumnRequest() [2/3]
|
inline |
Constructs a GetRecordsByColumnRequest object with the specified parameters.
- Parameters
-
table_name Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. 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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999. options - EXPRESSION: Optional filter expression to apply to the table.
- 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.
- ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
Definition at line 353 of file GetRecordsByColumn.cs.
◆ GetRecordsByColumnRequest() [3/3]
|
inline |
Constructs a GetRecordsByColumnRequest object with the specified parameters.
- Parameters
-
table_name Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. 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 has_more_records to see if more records exist in the result to be fetched, and offset & limit 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 - EXPRESSION: Optional filter expression to apply to the table.
- 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.
- ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
Definition at line 483 of file GetRecordsByColumn.cs.
Property Documentation
◆ column_names
|
getset |
The list of column values to retrieve.
Definition at line 131 of file GetRecordsByColumn.cs.
◆ encoding
|
getset |
◆ limit
|
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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
Definition at line 153 of file GetRecordsByColumn.cs.
◆ offset
|
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 138 of file GetRecordsByColumn.cs.
◆ options
|
getset |
- EXPRESSION: Optional filter expression to apply to the table.
- 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.
- ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
The default value is an empty Dictionary.
Definition at line 245 of file GetRecordsByColumn.cs.
◆ table_name
|
getset |
Name of the table or view on which this operation will be performed, in [schema_name.
]table_name format, using standard name resolution rules.
An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
Definition at line 128 of file GetRecordsByColumn.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/GetRecordsByColumn.cs
