TQL Query Grammar

Example

<Query var="some">

  <Documentation>

    This query finds all pairs of illuminated street lights next to vacant (or about to become vacant) parking

    meters operated by the same business outside of 1000 feet radius of a Chevron gas station if any.

  </Documentation>

  <Find using="Sensity,City,Business">

    <Entity QType="Business" as="some.Business"/>

    <Light operatedBy="some.Business.EIN" not.state="OutOfOrder" as="MyLight">

      <Brightness gt="80%"/>

      <Location>

        <Lattitude between="1.234,0.9876"/>

      </Location>

    </Light>

    <Parking.Meter operatedBy="some.Business.EIN" as="MyParkingMeter">

      <or>

        <eq target="state">

          vacant

        </eq>

        <and>

          <eq target="state" value="occupied"/>

          <le target="remainingTime" value="PT10M"/>

        </and>

      </or>

    </Parking.Meter>

    <not>

      <Business name="Chevron" businessType="GasStation" as="Chevron"/>

      <Distance from="Chevron.EID" to="var.MyLight.LID">

        <feet le="1000"/>

      </Distance>

    </not>

  </Find>

</Query>

Referenced by:

Query

• Label: Query label, will be copied into result
• From: Dot-delimited path to source container
• TqlAs is written as "As": Colon-separated whole result: result set [:instance] container specifiers
• FsExpression: any facet script expressions. They can be used both before the "Find/DeleteAll/Save/Create/Update/Delete" tags or after them. In either case, the execution is different
• ListQName Using: List of namespace hints
• Tag Using: Additional model definitions

Example

<Query>

  <Find as="X:Y:Z" format="version,current">

    <Zone as="var.Zone">

      <ZoneID ne=""/>

    </Zone>

    <ZoneInfo >

      <ZoneName  eq="var.Zone.Name" />

    </ZoneInfo>

  </Find>

</Query>

returns

 <X>
   <Y>
	 <Z>
       <ZoneID>KPDWP77BAAAMBKABAGF37PTP</ZoneID>
       <Zone.Attr...
     </Z>
     <Z>
       <ZoneInfo.Attr...
     </Z>
    </Y>
 </X>

Referenced by:

• TqlQuery
• TqlFindDeleteAll
• TqlCrud

TqlAs

• TqlAs: This defines a micro-language for a string value
• TqlContainer - Instance container - this part is only used in Find. 

Example

<Query>

  <Find as="$none:Zone:$none" format="version,current">

    <Zone as="var.Zone">

      <ZoneID ne=""/>

    </Zone>

    <ZoneInfo >

      <ZoneName  eq="var.Zone.Name" />

    </ZoneInfo>

  </Find>

</Query>

returns

 <Zone>
   <ZoneID>KPDWP77BAAAMBKABAGF37PTP</ZoneID>
   <Zone.Attr...
   <ZoneInfo.Attr...
 </Zone>
 <Zone>
   ...
 </Zone>

Referenced by:

• TqlAs

TqlContainer

• TqlContainer: This is a [partial] string value definition.
• ValueOf(sid): use SID as a container
• ValueOf(name): use [model] name as a container
• $none: no container requested 

Example

<Query>

  <Find as="$none:Zone:$none" Only="Zone:Name" format="version,current">

    <Zone as="var.Zone">

      <ZoneID ne=""/>

    </Zone>

  </Find>

</Query>

Returns

<Zone>
  <Name Value="CV-F1-Zone-1" Version="1"/>
</Zone>
<Zone>
...

Referenced by:

• TqlQuery

TqlFindDeleteAll

• TqlFindDeleteAll: Find or DeleteAll content
• From: Dot-delimited path to source container
• TqlAs is written as "As": Colon-separated whole result:result set[:instance] container specifiers
• Distinct: Reference to a model
• TqlOnly is written as "Only": List of attributes to fetch 

Example

<Query>

  <Find as="$none:Zone:$none" Only="Zone:Name" format="version,current">

    <Zone as="var.Zone">

      <ZoneID ne=""/>

    </Zone>

  </Find>

</Query>

Returns

<Zone>
  <Name Value="CV-F1-Zone-1" Version="1"/>
</Zone>
<Zone>
...

Referenced by:

• TqlFindDeleteAll
• TqlCrud

TqlOnly

• TqlOnly: comma-separated list of attribute names with optional predicates
• Has optional "not." or "!" prefix
• not.: canonical prefix
• !: abbreviated prefix
• Attribute reference: can be qualified by a model name or a variable name
• "," and optional white space between attribute references

Example

<Query>

  <Find as="$none:Zone:$none"  format="version,current">

    <gateway.agriculture.Zone as="var.X">

      <ZoneID ne=""/>

    </gateway.agriculture.Zone>

  </Find>

</Query>

Referenced by:

• TqlFindDeleteAll

TqlFindModel

• TqlFindModel: Tql Find query model content
• $Model=SubtypeOf(DataModel): this should set the $Model variable to be the name of any subtypes of DataModel (i.e. all Models). This variable value will be carried on to be used by TqlFindAttribute.
• TqlFindAttribute: This will use the $Model variable

Example

<Query>

  <Find as="$none:Zone:$none"  format="version,current">

    <Zone as="var.X">

      <And>

        <ZoneID ne=""/>

        <Name ne="CV-F1-Zone-1" />

      </And>

    </Zone>

  </Find>

</Query>

Returns all the records except with Name as CV-F1-Zone-1.

Referenced by:

• TqlFindModel

TqlFindAttribute

• TqlFindAttribute: Tql Find query model attribute content
• AttributeOf($Model): name of an attribute of the enclosing model.
• ConditionExpression: see definition on TQL Model Grammar

Example

Referenced by:

• TqlQuery

TqlCrud

• TqlCrud: CRUD operation content
• From: Dot-delimited path to source container
• TqlAs is written as "As": Colon-separated whole result:instance container specifiers
• TqlOnly is written as "Only": List of attributes to store

Example

Referenced by:

• TqlCrud

TqlCrudModel

• TqlCrudModel: Tql CRUD query model content
• $Model=SubtypeOf(DataModel): this should set the $Model variable to be the name of any subtypes of DataModel (i.e. all Models). This variable value will be carried on to be used by TqlCrudAttribute.
• TqlCrudAttribute: This will use the $Model variable

Example

Referenced by:

• TqlCrudModel

TqlCrudAttribute

• TqlCrudAttribute: Tql CRUD query model attribute content
• AttributeOf($Model): name of an attribute of the enclosing model; abbreviated form or extended form
• Value: actual value
• Version: optional version
• do: optional operation

Example

Referenced by:

• TqlCrudAttribute