Skip to main content

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

GetRecordsFromCollectionResponse< T > kinetica.Kinetica.getRecordsFromCollection< T > (GetRecordsFromCollectionRequestrequest_)
 inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

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 views using this operation.(DEPRECATED)

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 41527 of file KineticaFunctions.cs.

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

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

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

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 views using this operation.(DEPRECATED)

Template Parameters
TThe type of object being retrieved.
Parameters
table_nameName of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The 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 offset and limit to request subsequent pages of results. The default value is -9999.
options
  • RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table. The default value is ”.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.
Type Constraints
T :new() 

Definition at line 41643 of file KineticaFunctions.cs.

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

async System.Threading.Tasks.Task< GetRecordsFromCollectionResponse< T > > kinetica.Kinetica.GetRecordsFromCollectionAsync< T > (GetRecordsFromCollectionRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Retrieves records from a collection.

(async)

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

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 views using this operation.(DEPRECATED)

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 41561 of file KineticaFunctions.cs.

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

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

Retrieves records from a collection.

(async)

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

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 views using this operation.(DEPRECATED)

Template Parameters
TThe type of object being retrieved.
Parameters
table_nameName of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The 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 offset and limit to request subsequent pages of results. The default value is -9999.
options
  • RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table. The default value is ”.
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 41723 of file KineticaFunctions.cs.