View source

QueryProcessor

Vector processor that queries a layer

Implements the VectorProcessor protocol.

PARAMETER	DESCRIPTION
layer_name	Layer name TYPE: str
query_string	Query string based on the pandas query syntax TYPE: str
new_layer_name	New layer name TYPE: str | None DEFAULT: None

from_config classmethod

Creates a query processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: QueryProcessorConfig

RETURNS	DESCRIPTION
QueryProcessor	Query processor

__call__

Queries the layer.

PARAMETER	DESCRIPTION
vector	Vector TYPE: Vector

RETURNS	DESCRIPTION
vector	Vector TYPE: Vector

---

QueryProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of QueryProcessor

Create the configuration from a config file

• Use null instead of None

Example

You can create the configuration from a config file.

config.yaml

package: 'aviary'
name: 'QueryProcessor'
config:
  layer_name: 'my_layer'
  query_string: 'area > 1'
  new_layer_name: 'my_new_layer'

ATTRIBUTE	DESCRIPTION
layer_name	Layer name TYPE: str
query_string	Query string based on the pandas query syntax TYPE: str
new_layer_name	New layer name - defaults to None TYPE: str | None