Aliases

An alias is a table-specific derived field, in which a path expression is assigned to a name that is declared in the schema. In an object query, the alias name can be used in the query or fields parameters. In an aggregate query, the alias name can be used in the query or grouping parameters. Each occurrence of an alias name is replaced by its expression text, analogous to a macro.

Alias names must begin with a ‘$’, must be at least 2 characters in length, and secondary characters can be letters, digits, or underscores (‘_’). Alias names must also be unique within the application.

Below is an example alias declaration:

<table name="Message">

<aliases>

<alias name="$SalesEmails" expression="Sender.Person.WHERE(Department:sales)"/>

<aliases>

...

</table>

Here, the alias named $SalesEmails is assigned the expression Sender.Person.WHERE(Department:sales). If the following object query is submitted:

GET /Email/Message/_query?q=$SalesEmails.LastName:powell&range=0

The alias name $Sender it replaced with its expression text, which causes the query to be parsed as:

GET /Email/Message/_query?q=Sender.Person.WHERE(Department:sales).LastName:powell&range=0

Because the expression text is expanded and evaluated in the context where it is used, alias declarations are not evaluated at schema definition time. When used in queries, an alias will generate an error if its expansion results in an invalid query.