Altium Designer Documentation

Query Helper (SCH)

Created: September 27, 2017 | Updated: January 29, 2019

The Query Helper dialog
The Query Helper dialog

Summary

The Query Helper dialog offers a number of tools to help write search expressions. A query is a string you enter using specific keywords and syntax that will return the targeted objects. There are many keywords available that allow you to target objects by their type, their properties, or both. Use the top section of the dialog to compose a query expression, using the available schematic and system functions. The middle region of the dialog provides a range of operators for use when constructing an expression.

For more information about queries, see the Query Language Reference page.

Access

This dialog can be accessed in the following ways:

Options/Controls

Query

Use this top section of the dialog to compose a query expression, using the available schematic and system functions. In the text box, you can review and/or further edit the search expression. Type directly into the text box to edit the search expression. To search for specific keywords to add, begin typing. While you are typing, the dialog will offer a drop-down menu of available keywords that match the text that you have written so far. Click a keyword to auto-finish typing your selection.

Syntax Buttons

The mid-section of the dialog includes syntax buttons that provide a range of operators for use when constructing an expression. For more information on the individual function of each syntax button, visit the Query Operators page. Use the Check Syntax button (bottom left of the dialog) to verify that an expression is syntactically correct.

Categories

  • Library Functions - select to view available Library Functions. For more information on the available library functions, visit the Library Query Functions page.
  • System Functions - select to view available System Functions. For more information on the available system functions, visit the System Query Functions page.
  • Name - displays the name of the function.
  • Description - displays a brief description of the function.
  • Mask - use this field to search for keywords from both the Name and Description fields. Enter an asterisk (*) then begin typing the desired keyword and the field will narrow down any available options based on your input. For example, entering *para in the Mask field will display several keywords that apply to parameters, while *par will pick up keywords for both parameters and parts.

Other Buttons

  • Check Syntax - tests that the syntax in your expression is correct and will run your query without error.
  • OK - load the Query section of the Libraries Search dialog with the query, ready to proceed with the search.
  • Cancel - exit the dialog without saving any changes.
Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: