Search Query Reference

This document is a reference guide for the syntax, operators, and conventions used in the Workspace hardware design search language. Search queries are based on a familiar field:value syntax, and can be used to perform quick, simple searches through to constructing powerful and precise queries.

Search Syntax and Guide

The below reference information is grouped by types of search targets (components, connections, etc), with each section including usage category sub-types, usage examples, and corresponding example queries.

Component Search

Use Category Application Example Query

Basics

Find a known component by its Designator.

R14

Find a specific IC component by Designator. designator:U7

Find components by their Name/Comment (eg: ERJ-2RKF1002X, or "Capacitor 100nF +/-20% 50V 0402"]).

comment:ERJ-2RKF1002X

Find components by their Value parameter (eg: 100nF, or 4.7k).

value:100nF

Find components in a specific physical package (eg: QFN-48).

package:0402

Find components that use a specific PCB footprint name. footprint:RESC0402

Identifiers

Find components that are Surface Mount Devices (SMD).

mounting:smd

Find all Through-Hole Technology (THT) components.

mounting:tht

Types

Find all passive components (resistors, capacitors, inductors).

type:passive

Find all active components (ICs, transistors, diodes).

type:active

Find all components classified as connectors.

type:connector

Connections Find components that contain a specific pin name or number. pin:SCLK
Find components that contain pins with a specified direction. (eg: input, output, IO, etc). Also finds Ports with the specified direction. direction:output

Parametric

Find components with a specific property or parameter (eg: Tolerance) of any value.

has:tolerance

Find components where a parameter has a specific value

tolerance:1%

Find components where a numeric parameter is in a range. Filter. Note that parameter names with a space character must be in quotes. 

"Voltage Rating":[3V to 5.5V]

Find components on the Top layer with a specific power rating parameter. Filter

power:63mW layer:Top

Net Search

Use Category Application Example Query
Basics Find a known net by name. GND
Find a specific power net by name (eg: VCC, GND, VSENSE). net:VCC3
Classes Find all nets that belong to a net class. netclass:analog
Find the nets of a specific differential pair. diffpair:USB_SYS
Find all net pairs in the differential pair class. diffpairclass:USB

Connectivity

Use Category Application Example Query

Simple Search

Find component U3 and everything connected to it. Logical connection paths are also shown, where passive devices between active devices (eg: terminating resistors and coupling capacitors) are bypassed.

connectsTo:U3

Find the net 'SYS_CLK' and everything connected to it.

connectsTo:SYS_CLK

Advanced Search

Find component U3 and everything directly connected to it. Only physical (same-net) connections are shown – logical connections between active devices are not included. connectsTo.Direct:U3
Find component U3 and both physical and logical connections to it, but exclude connections to power rails. connectsTo.noPower:U3
Find component U3 and the physical (same-net) connections to it, but exclude connections to power rails. ConnectsTo.Direct:U3 ConnectsTo.NoPower:U3
Find the specific net connected to pin 5 of component U12. connectsTo:U12.5
Find the specific net connected to the 'D_CLK' input of component U12. connectsTo:U12.D_CLK

Find CAN bus nets on specific PCB layers (eg:L3 and Bottom). Filter

net:can* layer:Bottom layer:L3

Design Objects

Use Category Application Example Query

General Types

Find objects of a specific type [eg: pad, via, track].

object:pad

Find specific objects on a particular net (eg: vias in ground net). Filter object:via net:GND
Advanced Find tracks (traces) on PCB mid layers. (ie: not Top or Bottom layers). Filter

object:track -layer:Top -layer:Bottom

Find all pins designated as outputs. Filter direction:output object:pin
Find all pads with the rectangular shape type. Filter object:pad shape:rectangle

Logic & Range Filters

Use Category Application Example Query
Wildcards Find all nets whose name includes multiple characters after 'VCC' (eg: VCC1, VCC_Digital, VCC_Analog). net:VCC*
Find all components whose designators include a single character after 'C1' (ie: Capacitors C11 to C19) C1?
Logic Combinations Find Capacitors on the Top layer. Note that a space between search expressions is an implicit AND. type:Capacitor AND layer:Top
Find components using either the 0402 or 0603 package. Note that an OR logic expression should be enclosed in parentheses when used with AND logic. package:0402 OR package:0603
Show all connections to U1, but do not include those to the GND layer. Note that the '-' character is equivalent to the 'NOT' logic qualifier (-term:value). connectsto:U1 NOT Layer:GND
Parentheses Logic Find components using either the 0402 or 0603 package. package:(0402 OR 0603)
Find tracks (traces) on PCB mid layers. (ie: not Top or Bottom layers). object:track -layer:(Top or Bottom)
Ranges Find PCB tracks longer than a specified length. Note that the '>' character replaces the term's colon. object:Track tracklength>100mm
Find PCB pads with hole sizes greater than or equal to a specified diameter. object:Pad holesize>=0.6mm
Find resistors that have a value in a specified range. Note the use of square brackets. R* Value:[100k to 200k]
Find PCB nets with lengths from 1mm to 1.5mm. Will include connections (pads, vias, pins etc). NetLength:[1mm to 1.5mm]

Hierarchical & Grouping Search

Use Category Application Example Query

Logical Groups

Find all components in the 'DecouplingCaps' component class.

componentClass:DecouplingCaps

Find all nets belonging to the 'DDR_DATA' net class.

netClass:DDR_DATA

Physical Groups

Find all entities on a specified PCB layer (eg: Mid 3).

layer:"Mid 3"

Find all components within the 'RF_Shield' room on the PCB.

room:RF_Shield

Physical Design

Use Category Application Example Query

Physical Properties

Find high-speed nets with traces longer than 50mm. Filter

netClass:HighSpeed netlength>50mm

Show board traces (tracks) wider than 10 mil. Filter

object:track trackwidth>10mil

Find vias with a drill hole size smaller than 8 mil. Filter

object:via holesize<8mil

Document Searches

Use Category Application Example Query

Document Objects

Find all objects on a design PCB document (eg: 'Module1'). document:module1.pcbdoc
Find all objects on the 'Power' schematic document. sheet:power.schdoc
Find resistors on a specified schematic. Filter sheet:power.schdoc type:resistor

Library Management

Use Category Application Example Query

Status

Find all components that have a PCB footprint but no 3D model. Filter

has:footprint -has:model3d

Find any component that does not have a simulation model.

-has:simulation_model

Parts Source Find used components from a specific library source (eg: Workspace, Internal parts stock, project.IntLib). Library_Path:”Company Stock”.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Feature Availability

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

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

Content