Clause (TQL): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
5,955 edits
No edit summary
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
5,955 edits
No edit summary
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
A TQL query statement consists of a command, either [[Select (TQL)|Select]] or Update, and a list of clauses. The clauses provide further specification of the query statement, or a refinement, spatially or property wise.
A [[TQL]] query statement consists of a command, either [[Select (TQL)|Select]] or [[Update (TQL)|Update]], and a list of clauses. The clauses provide further specification of the query statement, or a refinement, spatially or property wise.
 
A clause consists of a clause parameter and a clause value, where currently the only supported operator between the parameter and value is ''IS''.
A clause consists of a clause parameter and a clause value, where currently the only supported operator between the parameter and value is ''IS''.


==List of Clause Parameters==
===Spatial===
====Spatial====
These parameters can be used to limit the search polygon that is used to query [[Building]]s.
These parameters can be used to limit the search polygon, that is used to query [[building]]s.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Area (TQL Param)}}
{{: Area (TQL Param)}}
Line 24: Line 24:
}}
}}


====Attribute====
===Attribute===
These parameters are related to attributes.
These parameters are related to [[Attribute]]s.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Attribute (TQL Param)}}
{{: Attribute (TQL Param)}}
Line 34: Line 34:
}}
}}


====Grid====
===Grid===
These parameters are specifically related to grids.
These parameters are specifically related to grids.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
Line 40: Line 40:
{{: Grid with attribute (TQL Param)}}
{{: Grid with attribute (TQL Param)}}
{{: Gridtype (TQL Param)}}
{{: Gridtype (TQL Param)}}
{{: Resulttype (TQL Param)}}
{{: Gridvalue (TQL Param)}}
{{: Gridvalue (TQL Param)}}
{{: Mingridvalue (TQL Param)}}
{{: Mingridvalue (TQL Param)}}
{{: Maxgridvalue (TQL Param)}}
{{: Maxgridvalue (TQL Param)}}
{{: Overlay (TQL Param)}}
{{: Timeframe (TQL Param)}}
{{: Timeframe (TQL Param)}}
}}
}}


====Item====
===Item===
These parameter can be used to consider only a specific [[item]] of that kind.
These parameters filter for specific types of [[Item]]s.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Address (TQL Param)}}
{{: Address (TQL Param)}}
{{: Area (TQL Param)}}
{{: Area (TQL Param)}}
{{: Building (TQL Param)}}
{{: Building (TQL Param)}}
{{: Building with attribute (TQL Param)}}
{{: Function (TQL Param)}}
{{: Function (TQL Param)}}
{{: Global (TQL Param)}}
{{: Global (TQL Param)}}
Line 68: Line 69:
}}
}}


====Net====
===Net===
These parameter are specific to [[network]] related [[item]]s. Some can also be used to limit the selected [[Building]]s.
These parameters are specific to [[Network]] related [[Item]]s. Some can also be used to limit the selected [[Building]]s.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Net line (TQL Param)}}
{{: Net line (TQL Param)}}
Line 78: Line 79:
}}
}}


====Property====
===Property===
These parameters are mostly related to [[building]] properties to filter on, but also include properties related to and shared with other items, such as [[Stakeholder]]s.
These parameters primarily filter [[Building]] properties, though some apply to other items like [[Stakeholder]]s.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Category (TQL Param)}}
{{: Category (TQL Param)}}
{{: Categorymult (TQL Param)}}
{{: Categorymult (TQL Param)}}
{{: Crs (TQL Param)}}
{{: Functionmult (TQL Param)}}
{{: Functionmult (TQL Param)}}
{{: Iteration (TQL Param)}}
{{: Key (TQL Param)}}
{{: Layertype (TQL Param)}}
{{: Layertype (TQL Param)}}
{{: Map (TQL Param)}}
{{: Map (TQL Param)}}
Line 94: Line 98:
}}
}}


{{article end
|api=* [[Api session query]]
}}
{{TQL param nav}}
{{TQL param nav}}

Latest revision as of 11:17, 15 July 2026

A TQL query statement consists of a command, either Select or Update, and a list of clauses. The clauses provide further specification of the query statement, or a refinement, spatially or property wise.

A clause consists of a clause parameter and a clause value, where currently the only supported operator between the parameter and value is IS.

Spatial

These parameters can be used to limit the search polygon that is used to query Buildings.

Param Value Description Limits search polygon
AREA Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Area with ID. true
AREA_WITH_ATTRIBUTE Attribute Area with non zero Attribute value. true
BUFFER decimal Buffer the limiting search Polygon with this value. true
GRIDVALUE decimal Only include Grid Overlay cells that have a value equal to the one specified. true
LAYERTYPE Layer,
X, Y, XA, YA		 Only include Buildings and Terrains that are part of this Layer. true
MAP Map Type,
X, Y, XA, YA		 Only Items present in this Map Type. true
MAXGRIDVALUE decimal Only include Grid Overlay cells that have a value smaller than the one specified. true
MINGRIDVALUE decimal Only include Grid Overlay cells that have a value larger than or equal to the one specified. true
NEIGHBORHOOD Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Neighborhood with ID. true
NEIGHBORHOOD_WITH_ATTRIBUTE Attribute Neighborhood with non zero Attribute value. true
STAKEHOLDER Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Stakeholder with ID.
Only include Plots that are owned by the stakeholder with this ID.
Only include Items that are related to this stakeholder.		 true
STAKEHOLDERTYPE Stakeholder Type Stakeholder Type with this value.
Only include Plots that are owned by this type of Stakeholder.		 true
TERRAIN Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Terrain of Terrain Type with ID. true
TERRAIN_WITH_ATTRIBUTE Attribute Terrain is of Terrain Type with non zero Attribute value. true
ZONE Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Zone with ID. true
ZONE_WITH_ATTRIBUTE Attribute Zone with non zero Attribute value. true

Attribute

These parameters are related to Attributes.

Param Value Description Limits search polygon
ATTRIBUTE Attribute The Attribute used for Buildings to obtain a value. false
ATTRIBUTE_MIN decimal Only include Buildings that have an Attribute value larger than or equal to this value. false
ATTRIBUTE_MAX decimal Only include Buildings that have an Attribute value smaller than this value. false
ATTRIBUTE_MULT Attribute Multiply the calculated value with the value of this Attribute for a Building. false
INDEX positive integer,
X, Y, XA, YA		 Allows to specify which value in an Attribute' s value array to select. false

Grid

These parameters are specifically related to grids.

Param Value Description Limits search polygon
GRID Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Grid of Grid Overlay with ID. false
GRID_WITH_ATTRIBUTE Attribute Grid of Grid Overlay with non zero Attribute value. false
GRIDTYPE Grid Type,
X, Y, XA, YA		 Grid of Grid Overlay with specified type. true
RESULTTYPE Result type,
X, Y, XA, YA		 Grid of Grid Overlay with specified Result type. true
GRIDVALUE decimal Only include Grid Overlay cells that have a value equal to the one specified. true
MINGRIDVALUE decimal Only include Grid Overlay cells that have a value larger than or equal to the one specified. true
MAXGRIDVALUE decimal Only include Grid Overlay cells that have a value smaller than the one specified. true
TIMEFRAME timeframe,
X, Y, XA, YA		 Specifies which Timeframe to select when processing a particular Grid. false

Item

These parameters filter for specific types of Items.

Param Value Description Limits search polygon
ADDRESS Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Address with ID. false
AREA Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Area with ID. true
BUILDING Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Building with ID. false
BUILDING_WITH_ATTRIBUTE Attribute Building with non zero Attribute value. false
FUNCTION Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Function with ID. false
GLOBAL Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Global with ID. false
GRID Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Grid of Grid Overlay with ID. false
INDICATOR Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Indicator with ID. false
LEVEE Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Levee with ID. false
MEASURE Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Measure with ID. false
NEIGHBORHOOD Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Neighborhood with ID. true
OVERLAY Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Overlay with ID. false
PANEL Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Panel with ID. false
RELATION Relation Changes the context of a selected Item to another related Item. false
STAKEHOLDER Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Stakeholder with ID.
Only include Plots that are owned by the stakeholder with this ID.
Only include Items that are related to this stakeholder.		 true
TERRAIN Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Terrain of Terrain Type with ID. true
ZONE Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Zone with ID. true

Net

These parameters are specific to Network related Items. Some can also be used to limit the selected Buildings.

Param Value Description Limits search polygon
NET_LINE Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Net Line with ID. false
NET_TYPE Net type,
X, Y, XA, YA		 Only Net Items of this Net Type. false
NET_FUNCTION Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Net Function with ID. false
NET_LOAD Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Net Load with ID. false
NET_CLUSTER Integer (Item ID),
ID, X, Y, XC, YC,
XA, YA, XK or YK		 Net Cluster with ID. true

Property

These parameters primarily filter Building properties, though some apply to other items like Stakeholders.

Param Value Description Limits search polygon
CATEGORY Category,
X, Y, XA, YA		 Category with this value.
Buildings of this Category.		 false
CATEGORYMULT Category Value Multiply the calculated value with this Category Value of a Building. false
CRS positive integer CRS EPSG number of requested coordinate system. false
FUNCTIONMULT Function Value Multiply the calculated value with this Function Value of a Building. false
ITERATION positive integer Query only executes when the current Iteration matches this value. false
KEY String Select Attribute based on Overlay Key value. false
LAYERTYPE Layer,
X, Y, XA, YA		 Only include Buildings and Terrains that are part of this Layer. true
MAP Map Type,
X, Y, XA, YA		 Only Items present in this Map Type. true
NAME String Select Attribute or Global with specified name. false
RESIDENCE boolean When true, consider only Buildings that are Residences. false
ROAD_SYSTEM boolean When true, consider only Buildings that are part of the road system. false
STAKEHOLDERTYPE Stakeholder Type Stakeholder Type with this value.
Only include Plots that are owned by this type of Stakeholder.		 true
STATE Timestate Only include Buildings and Measures that are in this Timestate. false
TERM Client Word,
Server Word		 Client Word or Server Word with name. false

API Endpoints

TQL Clause parameters
Spatial
Area • Area with attribute • Buffer • Layertype • Map • Neighborhood • Neighborhood with attribute • Terrain • Terrain with attribute • Zone • Zone with attribute
Attribute
Attribute • Attribute max • Attribute min • Attribute mult • Index
Grid
Grid • Grid with attribute • Gridtype • Gridvalue • Maxgridvalue • Mingridvalue • Overlay • Resulttype • Timeframe
Item
Address • Building • Building with attribute • Function • Global • Indicator • Levee • Measure • Panel • Relation • Scenario • Stakeholder
Net
Net line • Net type • Net function • Net load • Net cluster
Property
Category • Categorymult • Crs • Functionmult • Layertype • Iteration • Key • Map • Name • Residence • Road system • Stakeholdertype • State • Term
Replacement
X • XA • XC • XK • Y • YA • YC • YK • ID • Relation • Sort
Other
Select • Update


Retrieved from "https://support.tygron.com/w/index.php?title=Clause_(TQL)&oldid=91908"