View source for Template:FilteredPerformanceOverviewTables/doc

<noinclude>{{doc subpage}}</noinclude>
== Documentation ==

Provides overviews of type "Event by context", "Event by year", "Songs by title", and "Songs by year" for filtered subsets of the performance database. Note that in theory it could be used without filters, however the result would be huge, and transclusion would usually fail due to runtime limits.
<noinclude>[[Category:Incomplete template documentation]]</noinclude><!-- remove this category once the documentation is sufficiently detailed -->

=== Usage ===

* {{tc-namevar|FilteredPerformanceOverviewTables|where|SQL expression for WHERE clause}}

==== The 'where' parameter ====

===== 'WHERE' clause syntax =====

The 'where' parameter provides the content of the 'WHERE' clause, which follows usual SQL syntax, with the {{mw|Extension:Cargo/Querying_data#The_"HOLDS"_command|Cargo extension's "HOLDS" and "HOLDS LIKE"}}, which are applicable for array fields (like "context" and "partners"). For "LIKE" and "HOLDS LIKE" the standard SQL wildcards "%" (any amount of arbitrary characters) and "_" (exactly one arbitrary character) can be used.

Fields you can filter on are those that are contained in the [[Data:All performances standard Cargo query.json|standard query]] that is used in this template. As of the time of this writing, these are:

===== Available fields  =====
From "Performances":
* {{code|song}}
* {{code|event}}
* {{code|context}}
* {{code|date}}
* {{code|type}}
* {{code|pos}}
* {{code|partners}}
* {{code|comment}}
* {{code|perfID}}

From "Songs":
* {{code|title}}, referenced as {{code|songTitle}}
* {{code|type}}, referenced as {{code|songType}}

Due to the structure of this query, you cannot filter with the "where" argument on fields from the "Videos" table, like "duration", "quality", or "rating". <!--- this currently does not work!
For these, you have to use the "filters" parameter.


==== The 'filters' parameter ====

Filtering with this parameter is less efficient compared to the use of the "where" parameter, however, it is required for the fields from the Videos table, i.e. "duration", "quality", or "rating". It follows the syntax from the [[Modules:Performances]], which is a comma seperated list of filters. A filter is described by "fieldname:values". Alternatives within an filter value item can be described with "/". Negations can be described with "!( . )".-->

=== Examples ===

* {{tc-nameval|FilteredPerformanceOverviewTables|where|context HOLDS LIKE 'Talent Show'}}<br />⇓
{{FilteredPerformanceOverviewTables|where=context HOLDS LIKE 'Talent Show'}}

=== See also ===

* {{tl|SongsTable}}

<includeonly>
[[Category:Templates]]
[[Category:Cargo templates]]<!-- see previous category for relevant subcats -->
</includeonly>