Search templates, filters, and script constraints
When you construct a pattern for a structural search you are basically writing a script. To simplify your scripting process, DataGrip offers you a list of predefined search templates that you can use as prototypes for your search pattern.
On how to access the list of the existing search and replace templates, see the structural search and replace section.
Each search or replace template consists of variables
$variable_name$ to which you can add a condition (filter) to narrow your search results. Filters depend on a variable in your search template.
The Count filter specifies a number of occurrences.
If you do not set the Count filter explicitly, the IDE looks for only one template match. In other words, when the Count filter is not applied, the default values for the filter are
min = 1 and
max = 1.
[0,∞] to the variable and searches for the specified range of numbers.
The Reference filter lets you reference some other search template in the variable.
The reference will always contain the name of a preconfigured or saved pattern, and you can use auto-completion to fill out this field.
The Type filter adds a type of the value or expression that is expected for the specified variable.
To find the type category, use the name of the category in square brackets (for example,
To find a specific type, use the name of the type as a filter value (for example,
int). Also, you can use regular expression in filter values (for example,
varchar\(.*\)). To enable regular expression, select the Regex checkbox in filter settings.
UNKNOWNis used for expressions the type of which cannot be identified.
INTEGERis a numeric data type for a range from -2147483648 to 2147483647 (for example,
REALis a numeric data type for floating precision number data from -3.40E + 38 to 3.40E + 38 (for example,
STRINGis a string data type that includes all corresponding types like CHAR, VARCHAR, TEXT and others (for example,
BOOLEANis a boolean type that can be
DATE_TIMEis a combination of a date and time. Format:
DATEis a type for dates. Format: YYYY-MM-DD.
TIMEis a type for time. Format: hh:mm:ss.
TIMESTAMPis a date and time type that is stored as the number of seconds since the Unix epoch ('1970-01-01 00:00:00' UTC). Format: YYYY-MM-DD hh:mm:ss.
INTERVALis a type that stores the quantity of time between two datetime values (for example,
now() - INTERVAL '1 year 3 hours 20 minutes').
BYTESis a data type that allows whole numbers from 0 to 255.
ARRAYis a composite data type that consists of zero or more elements of a specified data type (for example,
COLLECTIONis an ordered group of elements, all of the same type.
TABLEis a data type that stores a result set for later processing.
RECORDis a data type that allows to create a new data type with the desired column structure.
SETOFis a return type to return a result set.
The Text filter checks the variable against regular expressions or plain text.
For example, the
var\d value for the
text filter in the
expression context will find all the variables that start with
var and have one digit afterwards.
The Script filter adds Groovy script constraints to the search pattern. Script constraints are used when you search for certain language constructs.
All variables used in a pattern can be accessed from script constraints. When you add a script constraint to your variable, DataGrip matches it against the PSI tree, this variable is in fact a node in the PSI tree.