Skip to content

Filtering.md

Latest commit

 

History

History
170 lines (119 loc) · 4.49 KB

Filtering.md

File metadata and controls

170 lines (119 loc) · 4.49 KB

Filter Syntax

Rapidex can use non concrete (text) filters for data listing.

Filter Syntax

The filter syntax is a string that can be used to filter data in a list. The basic syntax is as follows:

FieldName Operator Value

or

(FieldName Operator Value) and/or (FieldName Operator Value)

Parentheses are used to group conditions and can be nested, and the and and or keywords are used to combine multiple conditions. The following operators are supported:

Simple / Direct Operators

Operator Description Alternative Status
= Equals eq
!= Not equals <>, ne, noteq
> Greater than gt
< Less than lt
>= Greater than or equal to ge, gte
<= Less than or equal to le, lte
between between in and equal to two values
:= In a list (seperated by comma) in, contains, anyof
!: Not in a list notin, notcontains, noneof
! Not not
~ Like (wildcard: *) like
!~ Not like (wildcard: *) notlike
is null Is null isnull, = null
is not null Is not null isnotnull, != null

Simple / Direct Operators

Operator Description Alternative Status Sample
any() Any record available in relation (list) ? Not available MyEntity.RelationField.any()
Related Reverse relation with parent entity description relation Releated = Quote/123/Items (Entity a with id 123, have MyField relation. Get this (my type) releated detail entities.)

Predefined Field Names

Field Name Description Status
Caption For entity caption field (Name, Title eg)
All Entity wide search Not available yet

Predefined Values

Value Description Status
true Boolean true
false Boolean false
null Null value
today Current date
now Current date and time
yesterday Yesterday's date
tomorrow Tomorrow's date
thisweek This week's start date
lastweek Last week's start date
nextweek Next week's start date
lastmonth Last month's start date
thismonth Next month's start date
nextmonth Next month's date
lastyear Last year's start date
nextyear Next year's start date

Templates

Same filter & filter propositions have templates. See: Layouts / RelationX2N's; filter property

Template Description Status Sample
@parentId Releated parent id (Master / details) Not available ParentQuote = @parentId

Using Strings and DateTimes

Strings with spaces can be use with quotes (') or without quotes (should use with url encoding).

DateTimes should be in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format.

Planned Features

Feature Description Status
Nested filters (MyEntity.ReferencedField.Field = ABC) Is empty Not available yet
Relation supported filters (MyEntity.RelationField.any() eg) Not available yet

Samples

Simple Filter

Name = John%20Doe

or

Name = 'John Doe'

Date between '2025-01-01' and '2025-12-31'

Filter with Parentheses

(Name = John%20Doe) and (Age > 30)

(Name = John%20Doe) & (Age > 30)

Filter with Nested Parentheses

((Name = John%20Doe) and (Age > 30)) or ((Name = Jane%20Doe) and (Age < 25))

((Name = John%20Doe) & (Age > 30)) | ((Name = Jane%20Doe) & (Age < 25))

Using in Operator

:=, in, contains, anyof are same operators

age := 10,11,12

or

age in 10,11,12

Using isnull operator

is null, isnull, = null are same operators

MyField isnull

Using lastyear keyword

Date >= lastyear

Filter with search any caption field

Caption is a special field name that can be used to search for any primary field in the entity. Example: Name, Title, Subject, FullName etc.

See: DbEntityMetadata.Caption property

Caption~*Mytext*

Using Filters in Code

abc