|
TableOperationsTQueryRecords(String, Boolean, Int32, Int32, RecordRestriction) Method
|
Queries database and returns modeled table records for the specified sorting and paging parameters.
Namespace: GSF.Data.ModelAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.249-beta+56964f8aed6f3f2e54faec1539f7ce0ba6548fdf
Syntaxpublic IEnumerable<T> QueryRecords(
string sortField,
bool ascending,
int page,
int pageSize,
RecordRestriction restriction = null
)
Public Function QueryRecords (
sortField As String,
ascending As Boolean,
page As Integer,
pageSize As Integer,
Optional restriction As RecordRestriction = Nothing
) As IEnumerable(Of T)
public:
IEnumerable<T>^ QueryRecords(
String^ sortField,
bool ascending,
int page,
int pageSize,
RecordRestriction^ restriction = nullptr
)
member QueryRecords :
sortField : string *
ascending : bool *
page : int *
pageSize : int *
?restriction : RecordRestriction
(* Defaults:
let _restriction = defaultArg restriction null
*)
-> IEnumerable<'T>
function QueryRecords(sortField, ascending, page, pageSize, restriction);
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.
- restriction RecordRestriction (Optional)
- Record restriction to apply, if any.
Return Value
IEnumerableTAn 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 any of the restriction parameters reference a table field that is modeled with
either an EncryptDataAttribute or FieldDataTypeAttribute, then the function
GetInterpretedFieldValue(String, Object) will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
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.
See Also