Clause (TQL): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
(Minor text and styling improvements)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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 [[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.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Area (TQL Param)}}
{{: Area (TQL Param)}}
{{: Area with attribute (TQL Param)}}
{{: Area with attribute (TQL Param)}}
{{: Buffer (TQL Param)}}
{{: Buffer (TQL Param)}}
{{: Gridvalue (TQL Param)}}
{{: Layertype (TQL Param)}}
{{: Map (TQL Param)}}
{{: Maxgridvalue (TQL Param)}}
{{: Mingridvalue (TQL Param)}}
{{: Neighborhood (TQL Param)}}
{{: Neighborhood (TQL Param)}}
{{: Neighborhood with attribute (TQL Param)}}
{{: Neighborhood with attribute (TQL Param)}}
Line 17: Line 23:
{{: Zone with attribute (TQL Param)}}
{{: Zone with attribute (TQL Param)}}
}}
}}
====Attribute====
 
===Attribute===
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 23: Line 31:
{{: Attribute max (TQL Param)}}
{{: Attribute max (TQL Param)}}
{{: Attribute mult (TQL Param)}}
{{: Attribute mult (TQL Param)}}
{{: Index (TQL Param)}}
}}
}}
====Grid====
 
===Grid===
These parameters are specifically related to grids.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Grid (TQL Param)}}
{{: Grid (TQL Param)}}
Line 33: Line 44:
{{: Maxgridvalue (TQL Param)}}
{{: Maxgridvalue (TQL Param)}}
{{: Overlay (TQL Param)}}
{{: Overlay (TQL Param)}}
{{: Timeframe (TQL Param)}}
}}
}}
====Item====
 
===Item===
These parameter can be used to consider only a specific [[Item]] of that kind.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Address (TQL Param)}}
{{: Address (TQL Param)}}
{{: Area (TQL Param)}}
{{: Building (TQL Param)}}
{{: Building (TQL Param)}}
{{: Function (TQL Param)}}
{{: Function (TQL Param)}}
{{: Global (TQL Param)}}
{{: Global (TQL Param)}}
{{: Grid (TQL Param)}}
{{: Indicator (TQL Param)}}
{{: Indicator (TQL Param)}}
{{: Levee (TQL Param)}}
{{: Levee (TQL Param)}}
{{: Measure (TQL Param)}}
{{: Measure (TQL Param)}}
{{: Neighborhood (TQL Param)}}
{{: Overlay (TQL Param)}}
{{: Panel (TQL Param)}}
{{: Panel (TQL Param)}}
{{: Relation (TQL Param)}}
{{: Stakeholder (TQL Param)}}
{{: Stakeholder (TQL Param)}}
{{: Terrain (TQL Param)}}
{{: Zone (TQL Param)}}
}}
}}


====Net====
===Net===
These parameter 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 56: Line 78:
}}
}}


====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.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Category (TQL Param)}}
{{: Category (TQL Param)}}
{{: Categorymult (TQL Param)}}
{{: Categorymult (TQL Param)}}
{{: Functionmult (TQL Param)}}
{{: Functionmult (TQL Param)}}
{{: Layertype (TQL Param)}}
{{: Map (TQL Param)}}
{{: Name (TQL Param)}}
{{: Name (TQL Param)}}
{{: Residence (TQL Param)}}
{{: Residence (TQL Param)}}
{{: Road system (TQL Param)}}
{{: Road system (TQL Param)}}
{{: Stakeholdertype (TQL Param)}}
{{: Stakeholdertype (TQL Param)}}
{{: State (TQL Param)}}
{{: Term (TQL Param)}}
{{: Term (TQL Param)}}
}}
}}
====Helper====
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Index (TQL Param)}}
{{: Layertype (TQL Param)}}
{{: Map (TQL Param)}}
{{: Relation (TQL Param)}}
{{: State (TQL Param)}}
{{: Timeframe (TQL Param)}}
}}


{{TQL param nav}}
{{TQL param nav}}

Latest revision as of 07:05, 22 December 2023

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.

Attribute

These parameters are related to Attributes.

Grid

These parameters are specifically related to grids.

Item

These parameter can be used to consider only a specific Item of that kind.

Net

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

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 Stakeholders.