QUERY Function

Summary

The QUERY Expression Function in AdaptableQL supports referencing Named Queries in Expressions

The QUERY Expression Function enables referencing Named Queries inside Expressions.

Note

A Named Query is a Boolean Expression that has been named and saved into Query State for subsequent re-use

The referenced Query is identified by its name and it is evaluated on the fly by AdapTableQL.

So the Expression below could be saved as a Named Query called 'Big Orders'

 [ItemCount] > 30 OR [OrderCost] > 500

And this Named Query can now be referenced as follows:

 QUERY("Big Orders") AND [Currency] = 'USD'

AdapTableQL: QUERY Expression Function

Fork Fork

This Example demonstrates how to use the QUERY Expression Function
A Named Query is provided called 'Popular Frameworks' with the Expression: [github_watchers] > 2000 OR [github_stars] > 14500
This Named Query is then referenced in 3 places (using the QUERY keyword):
- A Custom Report has the Expression: QUERY("Popular Frameworks")
- A Format Column Condition has the Expression: QUERY("Popular Frameworks") AND [has_wiki]
- A Row Change Alert has the Expression: QUERY("Popular Frameworks") AND [language]="JavaScript"

Try It Out

Edit the Named Query (through the Query Section in Settings Panel) and see how the Style changes
Change Has Wiki in rows with JavaScript and see the Alert appear; do the same in rows with TypeScript and not there is no Alert

import {AdaptableOptions} from '@adaptabletools/adaptable';
import {WebFramework} from './rowData';

export const adaptableOptions: AdaptableOptions<WebFramework> = {
  primaryKey: 'id',
  adaptableId: 'QUERY Expression Function',
  initialState: {
    Dashboard: {
      ModuleButtons: ['FormatColumn', 'SettingsPanel'],
      Tabs: [
        {
          Name: 'Expressions',
          Toolbars: ['Alert', 'Export', 'GridFilter'],
        },
      ],
    },
    Theme: {CurrentTheme: 'dark'},
    NamedQuery: {
      NamedQueries: [
        {
          Name: 'Popular Frameworks',
          BooleanExpression:
            '[github_watchers] > 2000 OR [github_stars] > 14500',
        },
      ],
    },
    Alert: {
      AlertDefinitions: [
        {
          Name: 'alert-frameworks-javascript',
          Scope: {
            All: true,
          },
          MessageType: 'Warning',
          Rule: {
            BooleanExpression:
              'QUERY("Popular Frameworks") AND [language]="JavaScript" ',
          },
          AlertProperties: {
            DisplayNotification: true,
          },
        },
      ],
    },
    Export: {
      Reports: [
        {
          Name: 'Popular',
          ReportColumnScope: 'AllColumns',
          ReportRowScope: 'ExpressionRows',
          Query: {
            BooleanExpression: 'QUERY("Popular Frameworks")',
          },
        },
      ],
      CurrentReport: 'Popular',
    },
    FormatColumn: {
      FormatColumns: [
        {
          Name: 'style-frameworks-wiki',
          Scope: {All: true},
          Rule: {
            BooleanExpression: 'QUERY("Popular Frameworks") AND [has_wiki]',
          },
          Style: {
            ForeColor: 'White',
            BackColor: 'Brown',
          },
        },
      ],
    },
    Layout: {
      CurrentLayout: 'Standard Layout',
      Layouts: [
        {
          Name: 'Standard Layout',
          TableColumns: [
            'name',
            'language',
            'github_watchers',
            'github_stars',
            'has_wiki',
            'open_issues_count',
            'closed_issues_count',
            'open_pr_count',
            'closed_pr_count',
            'has_projects',
            'has_pages',
            'week_issue_change',
            'updated_at',
            'pushed_at',
            'description',
          ],
          AutoSizeColumns: true,
        },
      ],
    },
  },
};

Find Out More

See Named Queries for more information and an accompanying demo

PreviousAdvanced Expressions NextVAR Function