Clause (TQL): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
(Minor text and styling improvements)
 
(19 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 a specification for 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===
These parameters can be used to limit the search polygon that is used to query [[Building]]s.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Area (TQL Param)}}
{{: Area with attribute (TQL Param)}}
{{: Buffer (TQL Param)}}
{{: Gridvalue (TQL Param)}}
{{: Layertype (TQL Param)}}
{{: Map (TQL Param)}}
{{: Maxgridvalue (TQL Param)}}
{{: Mingridvalue (TQL Param)}}
{{: Neighborhood (TQL Param)}}
{{: Neighborhood with attribute (TQL Param)}}
{{: Stakeholder (TQL Param)}}
{{: Stakeholdertype (TQL Param)}}
{{: Terrain (TQL Param)}}
{{: Terrain with attribute (TQL Param)}}
{{: Zone (TQL Param)}}
{{: Zone with attribute (TQL Param)}}
}}
 
===Attribute===
These parameters are related to [[Attribute]]s.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Attribute (TQL Param)}}
{{: Attribute min (TQL Param)}}
{{: Attribute max (TQL Param)}}
{{: Attribute mult (TQL Param)}}
{{: Index (TQL Param)}}
}}
 
===Grid===
These parameters are specifically related to grids.
{{Param TQL|suppresscategory=true|allowselflinks=true|
{{: Grid (TQL Param)}}
{{: Grid with attribute (TQL Param)}}
{{: Gridtype (TQL Param)}}
{{: Gridvalue (TQL Param)}}
{{: Mingridvalue (TQL Param)}}
{{: Maxgridvalue (TQL Param)}}
{{: Overlay (TQL Param)}}
{{: Timeframe (TQL Param)}}
}}
 
===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)}}
{{: Area (TQL Param)}}
{{: Building (TQL Param)}}
{{: Function (TQL Param)}}
{{: Global (TQL Param)}}
{{: Grid (TQL Param)}}
{{: Indicator (TQL Param)}}
{{: Levee (TQL Param)}}
{{: Measure (TQL Param)}}
{{: Neighborhood (TQL Param)}}
{{: Neighborhood (TQL Param)}}
{{: Overlay (TQL Param)}}
{{: Panel (TQL Param)}}
{{: Relation (TQL Param)}}
{{: Stakeholder (TQL Param)}}
{{: Terrain (TQL Param)}}
{{: Zone (TQL Param)}}
}}
}}
===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|
{{: Net line (TQL Param)}}
{{: Net type (TQL Param)}}
{{: Net function (TQL Param)}}
{{: Net load (TQL Param)}}
{{: Net cluster (TQL Param)}}
}}
===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|
{{: Category (TQL Param)}}
{{: Categorymult (TQL Param)}}
{{: Functionmult (TQL Param)}}
{{: Layertype (TQL Param)}}
{{: Map (TQL Param)}}
{{: Name (TQL Param)}}
{{: Residence (TQL Param)}}
{{: Road system (TQL Param)}}
{{: Stakeholdertype (TQL Param)}}
{{: State (TQL Param)}}
{{: Term (TQL Param)}}
}}
{{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.