Export options 

These are the keys of a single export definition below mod.web_xlsexport.<key>.

Name Type Default
table
 string
alias
 string
select
 list
selectLiteral
 list
count
 string '*'
fieldLabels
 list
format
 string xlsx
label
 string
where
 list
join
 list
leftJoin
 list
rightJoin
 list

table

table
Type
string
Required

true

The database table to read from — the argument of QueryBuilder::from().

alias

alias
Type
string

Optional table alias, passed as the second argument of QueryBuilder::from(). Use it when a join needs to reference this table under a short name.

select

select
Type
list
Required

true

The columns to read, as a numeric TSconfig list (10, 20, …). Each value is one column passed to QueryBuilder::select(). Prefix with the table or alias (tt_content.uid) when selecting across joins.

selectLiteral

selectLiteral
Type
list

Additional raw select expressions passed to QueryBuilder::selectLiteral(), for example COUNT(*) AS amount. Unlike select, these are not quoted — only use integrator-controlled values here.

count

count
Type
string
Default
'*'

The column counted for the record number shown next to the export in the module, using QueryBuilder::count(). * counts all rows.

fieldLabels

fieldLabels
Type
list
Required

true

The column headers written into the first row of the spreadsheet, as a numeric list aligned by position with select.

format

format
Type
string
Default
xlsx

The default spreadsheet format: xlsx, xls, ods or csv. Editors can override it per download.

label

label
Type
string

The label shown for the export in the module. May be a plain string or an LLL: reference. Defaults to the table name.

where

where
Type
list

The filter conditions — see Filtering rows.

join

join
Type
list

Inner joins — see Joining tables.

leftJoin

leftJoin
Type
list

Left joins — see Joining tables.

rightJoin

rightJoin
Type
list

Right joins — see Joining tables.