TableOperationsTSearchRecordsAsync Method

public IAsyncEnumerable<T> SearchRecordsAsync(
	string? sortField,
	bool ascending,
	CancellationToken cancellationToken,
	StringComparison comparison = StringComparison.OrdinalIgnoreCase,
	params IRecordFilter?[]? recordFilters
)

Public Function SearchRecordsAsync ( 
	sortField As String,
	ascending As Boolean,
	cancellationToken As CancellationToken,
	Optional comparison As StringComparison = StringComparison.OrdinalIgnoreCase,
	ParamArray recordFilters As IRecordFilter()
) As IAsyncEnumerable(Of T)

public:
IAsyncEnumerable<T>^ SearchRecordsAsync(
	String^ sortField, 
	bool ascending, 
	CancellationToken cancellationToken, 
	StringComparison comparison = StringComparison::OrdinalIgnoreCase, 
	... array<IRecordFilter^>^ recordFilters
)

function SearchRecordsAsync(sortField, ascending, cancellationToken, comparison, ... recordFilters);

Parameters

sortField  String

Field name to order-by.

ascending  Boolean

Sort ascending flag; set to false for descending.

cancellationToken  CancellationToken

Propagates notification that operations should be canceled.

comparison  StringComparison  (Optional)

StringComparison to use when searching string fields; defaults to ordinal ignore case.

recordFilters  IRecordFilter

Record Filters to be applied.

Return Value

This function searches records locally after query from database, this way Search functionality will work even with fields that are modeled with the EncryptDataAttribute and use restrictions not being = or =/=. Primary keys for this function will not be cached server-side and this function will be slower and more expensive than similar calls to QueryRecords(String, Boolean, Int32, Int32, IRecordFilter). Usage should be restricted to cases searching for field data that has been modeled with the EncryptDataAttribute.

This function does not paginate records, instead a full list of search records is returned. User can cache returned records and page through them using the GetPageOfRecordsAsync(IAsyncEnumerableT, Int32, Int32) function. As a result, usage should be restricted to smaller data sets.

Reference