|
ITableOperationsQueryRecords(String, Boolean, Int32, Int32, String) Method
|
Queries database and returns modeled table records for the specified sorting, paging and search parameters.
Search executed against fields modeled with
SearchableAttribute.
Namespace: GSF.Data.ModelAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.249-beta+56964f8aed6f3f2e54faec1539f7ce0ba6548fdf
SyntaxIEnumerable QueryRecords(
string sortField,
bool ascending,
int page,
int pageSize,
string searchText
)
Function QueryRecords (
sortField As String,
ascending As Boolean,
page As Integer,
pageSize As Integer,
searchText As String
) As IEnumerable
IEnumerable^ QueryRecords(
String^ sortField,
bool ascending,
int page,
int pageSize,
String^ searchText
)
abstract QueryRecords :
sortField : string *
ascending : bool *
page : int *
pageSize : int *
searchText : string -> IEnumerable
function QueryRecords(sortField, ascending, page, pageSize, searchText);
View SourceParameters
- sortField String
- Field name to order-by.
- ascending Boolean
- Sort ascending flag; set to false for descending.
- page Int32
- Page number of records to return (1-based).
- pageSize Int32
- Current page size.
- searchText String
- Text to search.
Return Value
IEnumerableAn enumerable of modeled table row instances for queried records.
Remarks
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call ClearPrimaryKeyCache to manually clear cache
when table contents are known to have changed.
If the specified sortField has been marked with EncryptDataAttribute,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
This is a convenience call to QueryRecords(String, Boolean, Int32, Int32, RecordRestriction) where restriction
is generated by GetSearchRestriction(String) using searchText.
See Also