Skip to content

FB4D Reference TQueryParamsHelper

Christoph Schneider edited this page Aug 14, 2024 · 8 revisions

Class Helper TQueryParamsHelper

This class helper extends TQueryParams (TDictionary<string, TStringDynArray>) and can be used for both databases (RT-DB and Firestore). It helps to setup the QueryParams.

class function CreateQueryParams(CheckThisInstanceFirst: TQueryParams =
  nil): TQueryParams;
function AddOrderBy(const FieldName: string): TQueryParams;
function AddOrderByType(const TypeName: string): TQueryParams;
function AddLimitToFirst(LimitToFirst: integer): TQueryParams;
function AddLimitToLast(LimitToLast: integer): TQueryParams;
function AddOrderByAndEqualTo(const FieldName,
  FilterValue: string): TQueryParams; overload;
function AddOrderByAndEqualTo(const FieldName: string;
  FilterValue: integer): TQueryParams; overload;
function AddOrderByAndEqualTo(const FieldName: string;
  FilterValue: extended): TQueryParams; overload;
function AddTransaction(
  Transaction: TFirestoreReadTransaction): TQueryParams;
function AddPageSize(PageSize: integer): TQueryParams;
function AddPageToken(const PageToken: string): TQueryParams;

Example application for Realtime Database:

TQueryParams.CreateQueryParams.AddOrderBy(ColumnName: string).AddLimitToFirst(NumberOfResults: integer);

Example application for Firestore Cloud Database:

TQueryParams.CreateQueryParams.AddTransaction(ReadTransaction: TFirestoreReadTransaction).AddPageSize(NumberOfResults: integer);

Clone this wiki locally