The Filter by attribute tool returns a subset of a dataset based on a query. The output is a new dataset containing only the records that meet the condition specified in the query.
Examples
The Filter by attribute tool can be used in scenarios such as the following:
- Filter out records that do not have a geometry.
- Retain only the records that have a specific ZIP code.
Parameters
The following table outlines the parameters used in the Filter by attribute tool:
| Parameter | Description |
|---|---|
Input dataset | The dataset to be filtered. |
Filter expression | The SQL query that will be used to filter the input dataset. |
Usage notes
Use the Input dataset parameter to identify the dataset to be filtered.
To filter a dataset, use the Filter expression parameter to specify an expression that identifies the records you want to maintain. The expression must return a Boolean value. Records that meet the conditions of the expression will return true and will be maintained in the result. Records that do not meet the conditions of the expression will return false and will be excluded from the result.
Outputs
The tool output is a dataset containing only the records that met the condition specified in the filter expression. The output dataset will contain all fields from the input dataset.
Limitations
The following are known limitations of the Filter by attribute tool:
- If you are filtering date or date only fields, the following expression types will be processed in coordinated universal time (UTC): is this month, is this year, in the last, and not in the last. All other expression types will be processed in the time zone of your browser.
- If you are using the Expression or Group expression option for building a query and a string field is selected, the choice list will populate with a list of unique values based on the preview records only. This is not a complete list of unique values in the source dataset.
- If you are using the SQL expression option for building a query, the following limitations apply:
- Fields of type Boolean are not supported. To filter using Boolean fields, use the Expression or Group expression options.
- Fields of type geometry can only be used to filter for IS Null or IS NOT Null.
- The tool returns a single dataset that contains the records that matched the specified expression. The records that do not meet the specified expression will not be returned. To create a dataset containing the records that were excluded, run the tool again using the same input dataset and the inverse of the query you used the first time.
Licensing requirements
The following licensing and configurations are required:
- Creator or Professional user type
- Publisher, Facilitator, or Administrator role, or an equivalent custom role
To learn more about Data Pipelines requirements, see Requirements.