Schematic Capture Query Functions

At a Glance

This article introduces the schematic query functions available in Altium Designer, with a focus on how the Query Helper dialog works with the underlying query engine in the Schematic editors. It explains that queries are built from specific keywords and syntax to help you precisely target objects by type, properties, or both, and points you to the reference pages for schematic and schematic library query language keywords, including fields, membership checks, and object type checks. It also highlights where to get help on individual keywords directly in the tool, making this a useful starting point if you want to better understand how to scope and find the exact objects you need. Keep reading to quickly find the references and guidance that can help you work more effectively.

- Learn what schematic queries are and how they are used to target specific objects in Altium Designer.
- See the main categories of available query keywords, including fields, membership checks, and object type checks.
- Find out how to access keyword-specific help and where to go for broader query language information.
Go Deeper with AI:

Schematic query functions in the Query Helper dialog
Schematic query functions in the Query Helper dialog

Underlying Altium Designer's Schematic and PCB editors is a powerful query engine. By entering queries into this engine, you can logically scope precisely those objects you require.

A query is a string you enter using specific keywords and syntax, which will return the targeted objects. There are many keywords available, allowing you to target objects by their type, their properties, or both.

For a detailed overview of using the query language, see Working with the Query Language.

The reference pages listed below detail the query language keywords available in schematic and schematic library documents in Altium Designer.

  • For help on a specific query keyword, you can highlight (or click inside) any given keyword - in the Query Helper or a Filter panel then press F1 to access its section.

  • Learn more about the PCB editor query language keywords.

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Contents
Feature Availability

The features available to you depend on which Altium solution you have – Altium Develop, Altium Agile Teams, Altium Agile Enterprise, or Altium Designer (on active term).

If you don’t see a documented feature in your actual software, contact Altium Sales to find out more.

Legacy Documentation

Altium Designer documentation is no longer versioned. If you need to access documentation for older versions of Altium Designer, visit the Legacy Documentation section of the Other Installers page.