Query Builder

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

The Query Builder dialog
The Query Builder dialog

Summary

The Query Builder dialog enables you to create a query for targeting specific objects in the design document by simple construction of a string of ANDed and/or ORed conditions. 

For more information about Query Language, click here. For more information about Query Functions, click here.

Access

The dialog can be accessed in the following ways:

  • From the PCB Filter panel, click the Builder button.
  • From the PCB Rules and Constraints Editor dialog, in each specific design rule, click Query Builder (if available).

Options/Controls

  • Show All Levels - use the drop-down to control the visual display of levels in the structured string of conditions. This essentially expands/collapses the display of brackets. Adding brackets creates a new level and you can display levels 1-5. Alternatively, click on the expand () or contract () symbols to show the next level(s) or hide the current level (and all levels below), respectively. 

  •  - use to remove brackets around the presently selected condition (decreasing indent). This allows you to create precedence for certain logically ANDed or logically ORed conditions.

  •  - use to add brackets around the presently selected condition (increasing indent). This allows you to create precedence for certain logically ANDed or logically ORed conditions.

  •  - to move a selected condition up in the query string being built. For a condition that has sub-levels (i.e. a bracketed condition), any condition in the level structure can be moved. When levels are expanded, a condition can be moved up through the levels. When levels are collapsed, a condition will be moved over the level structure.

  •  - to move a selected condition down in the query string being built. For a condition that has sub-levels (i.e. a bracketed condition), any condition in the level structure can be moved. When levels are expanded, a condition can be moved down through the levels. When levels are collapsed, a condition will be moved over the level structure.

  •  - use to expand symbols to show the next level(s).

  •  - use to contract symbols to hide the current level (and all levels below).

  •  - use to delete the selected condition.

  • Condition Type/Operator - use this region to specify the condition(s) required to target the set of objects needed. Initially, the entry in the Condition Type/Operator column will be Add first condition. Click once on this entry to open a drop-down list of condition types. The list is sensitive to wherever the dialog was launched from. If you are building a query for a particular design rule within the PCB Rules And Constraints Editor dialog, the condition list will only reflect condition types possible for that particular rule type.
  • Condition Value - choose the first condition then click in the Condition Value column to access a drop-down list of possible values for that condition type. As you define a condition, a preview of the currently built query is shown in the Query Preview region.

Tips

  • Add further conditions to narrow down your target set of design objects as required. Conditions can be ANDed or ORed together. The default logical operator is AND.
  • To change the logical operator between conditions, click on the AND or OR entry in the Condition Type/Operator column then select the required operator. The preview of the query will update accordingly.
  • The Query Builder dialog (Building Query from Board ) is a simpler method of constructing a query using sensitive condition types and values that only allow you to build using relevant 'building blocks.' For advanced query construction with full keyword specification and operator syntax use the Query Helper dialog.
  • You can adjust any condition in your query string at any time by clicking on the entry for that condition in the Condition Type/Operator column then choosing the required new condition from the available entries in the drop-down list. The preview of the query will update accordingly.
  • Use Ctrl+Up Arrow and Ctrl+Down Arrow keyboard shortcuts to move the selected condition entry up or down in the structure. 
  • Use Ctrl+Right Arrow and Ctrl+Left Arrow keyboard shortcuts to increase or decrease the indent at the selected position in the structure (add/remove brackets).
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content