Skip to content

Commit 16d3dd6

Browse files
committed
developmental review of odata filter syntax reference
1 parent 5a76d4b commit 16d3dd6

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

articles/azure-web-pubsub/reference-odata-filter.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ ms.date: 11/11/2022
1010

1111
# OData filter syntax in Azure Web PubSub service
1212

13-
In Azure Web PubSub service, the **filter** parameter specifies inclusion or exclusion criteria for the connections to send messages to. This article describes the OData syntax of **filter** and provides examples.
13+
Azure Web PubSub's **filter** parameter defines inclusion or exclusion criteria for sending messages to connections.
1414

15-
The complete syntax is described in the [formal grammar](#formal-grammar).
15+
This article provides the following:
1616

17-
There is also a browsable [syntax diagram](https://aka.ms/awps/filter-syntax-diagram) that allows you to interactively explore the grammar and the relationships between its rules.
17+
- A description of the OData syntax of the **filter** parameter with examples.
18+
- A [formal grammar](#formal-grammar) that describes the complete syntax.
19+
- A browsable [syntax diagram](https://aka.ms/awps/filter-syntax-diagram) to let you interactively explore grammar rules.
1820

1921
## Syntax
2022

@@ -35,27 +37,21 @@ boolean_expression ::= logical_expression
3537
| '(' boolean_expression ')'
3638
```
3739

38-
An interactive syntax diagram is also available:
40+
An interactive syntax diagram is available at, [OData syntax diagram for Azure Web PubSub service](https://aka.ms/awps/filter-syntax-diagram).
3941

40-
> [!div class="nextstepaction"]
41-
> [OData syntax diagram for Azure Web PubSub service](https://aka.ms/awps/filter-syntax-diagram)
42-
43-
> [!NOTE]
44-
> See [formal grammar section](#formal-grammar) for the complete EBNF.
42+
For the complete EBNF, see [formal grammar section](#formal-grammar) .
4543

4644
### Identifiers
4745

48-
The filter syntax is used to filter out the connections matching the filter expression to send messages to.
49-
50-
Azure Web PubSub supports below identifiers:
46+
Using the filter syntax, you can control sending messages to connections matching the identifier criteria. Azure Web PubSub supports below identifiers:
5147

5248
| Identifier | Description | Note | Examples
5349
| --- | --- | -- | --
5450
| `userId` | The userId of the connection. | Case insensitive. It can be used in [string operations](#supported-operations). | `userId eq 'user1'`
5551
| `connectionId` | The connectionId of the connection. | Case insensitive. It can be used in [string operations](#supported-operations). | `connectionId ne '123'`
5652
| `groups` | The collection of groups the connection is currently in. | Case insensitive. It can be used in [collection operations](#supported-operations). | `'group1' in groups`
5753

58-
Identifiers are used to refer to the property value of a connection. Azure Web PubSub supports 3 identifiers matching the property name of the connection model. and supports identifiers `userId` and `connectionId` in string operations, supports identifier `groups` in [collection operations](#supported-operations). For example, to filter out connections with userId `user1`, we specify the filter as `userId eq 'user1'`. Read through the below sections for more samples using the filter.
54+
Identifiers refer to the property value of a connection. Azure Web PubSub supports three identifiers matching the property name of the connection model. and supports identifiers `userId` and `connectionId` in string operations, supports identifier `groups` in [collection operations](#supported-operations). For example, to filter out connections with userId `user1`, we specify the filter as `userId eq 'user1'`. Read through the below sections for more samples using the filter.
5955

6056
### Boolean expressions
6157

@@ -69,6 +65,9 @@ The types of Boolean expressions include:
6965
- Boolean expressions in parentheses. Using parentheses can help to explicitly determine the order of operations in a filter. For more information on the default precedence of the OData operators, see [operator precedence section](#operator-precedence).
7066

7167
### Supported operations
68+
69+
The filter syntac supports the following operations:
70+
7271
| Operator | Description | Example
7372
| --- | --- | ---
7473
| **Logical Operators**
@@ -136,7 +135,7 @@ not (length(userId) gt 5)
136135

137136
### Filter size limitations
138137

139-
There are limits to the size and complexity of filter expressions that you can send to Azure Web PubSub service. The limits are based roughly on the number of clauses in your filter expression. A good guideline is that if you have over 100 clauses, you are at risk of exceeding the limit. We recommend designing your application in such a way that it doesn't generate filters of unbounded size.
138+
There are limits to the size and complexity of filter expressions that you can send to Azure Web PubSub service. The limits are based roughly on the number of clauses in your filter expression. A good guideline is that if you have over 100 clauses, you are at risk of exceeding the limit. To avoid exceeding the limit, design your application so that it doesn't generate filters of unbounded size.
140139

141140
## Examples
142141

@@ -164,7 +163,7 @@ There are limits to the size and complexity of filter expressions that you can s
164163

165164
## Formal grammar
166165

167-
We can describe the subset of the OData language supported by Azure Web PubSub service using an EBNF ([Extended Backus-Naur Form](https://en.wikipedia.org/wiki/Extended_Backus–Naur_form)) grammar. Rules are listed "top-down", starting with the most complex expressions, and breaking them down into more primitive expressions. At the top is the grammar rule for `$filter` that correspond to specific parameter `filter` of the Azure Azure Web PubSub service `Send*` REST APIs:
166+
We can describe the subset of the OData language supported by Azure Web PubSub service using an EBNF ([Extended Backus-Naur Form](https://en.wikipedia.org/wiki/Extended_Backus–Naur_form)) grammar. Rules are listed "top-down", starting with the most complex expressions, then breaking them down into more primitive expressions. At the top is the grammar rule for `$filter` that corresponds to specific parameter `filter` of the Azure Azure Web PubSub service `Send*` REST APIs:
168167

169168

170169
```

0 commit comments

Comments
 (0)