Skip to main content

​
◆ getRecords< T >() [1/2]

GetRecordsResponse< T > kinetica.Kinetica.getRecords< T > (GetRecordsRequestrequest_)
 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 and views. 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.

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

Definition at line 40629 of file KineticaFunctions.cs.

​
◆ getRecords< T >() [2/2]

GetRecordsResponse< T > kinetica.Kinetica.getRecords< T > (stringtable_name,
longoffset = 0,
longlimit = -9999,
IDictionary< string, string >options = null )
 inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables and views. 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.

Template Parameters
TThe type of object being retrieved.
Parameters
table_nameName of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
offsetA 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.
limitA 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 and limit to request subsequent pages of results. The default value is -9999.
options
  • EXPRESSION: Filter expression to apply to the table.
  • FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values:The default value is TRUE.
  • SORT_BY: Column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
  • SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:The default value is ASCENDING.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 40780 of file KineticaFunctions.cs.

​
◆ GetRecordsAsync< T >() [1/2]

async System.Threading.Tasks.Task< GetRecordsResponse< T > > kinetica.Kinetica.GetRecordsAsync< T > (GetRecordsRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

(async)

This operation can be performed on tables and views. 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.

Template Parameters
TThe type of object being retrieved.
Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 40665 of file KineticaFunctions.cs.

​
◆ GetRecordsAsync< T >() [2/2]

async System.Threading.Tasks.Task< GetRecordsResponse< T > > kinetica.Kinetica.GetRecordsAsync< T > (stringtable_name,
longoffset = 0,
longlimit = -9999,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

(async)

This operation can be performed on tables and views. 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.

Template Parameters
TThe type of object being retrieved.
Parameters
table_nameName of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
offsetA 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.
limitA 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 and limit to request subsequent pages of results. The default value is -9999.
options
  • EXPRESSION: Filter expression to apply to the table.
  • FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values:The default value is TRUE.
  • SORT_BY: Column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
  • SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:The default value is ASCENDING.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 40888 of file KineticaFunctions.cs.