<cfdump>

edit

Outputs the elements, variables and values of most kinds of CFML objects.

Very useful for debugging.

You can display the contents of simple and complex variables, objects, components, user-defined functions, and other elements.

This tag may have a body.

This tag has no <cfscript> support or it uses a different syntax.

<cfdump var=any eval=string expand=boolean label=string top=number showUDFs=boolean show=string output=string metainfo=boolean keys=number hide=string format=string abort=boolean async=boolean enabled=boolean flush=boolean ><!--- body --->[</cfdump>]
Attribute Description
var
any, optional
edit

Variable to display. Enclose a variable name in pound signs.

eval
string, optional
edit

name of the variable to display, also used as label, when no label defined.

expand
boolean, optional
edit

expands views

label
string, optional
edit

header for the dump output.

top
number, optional
edit

The number of rows to display.

showUDFs
boolean, optional
edit

show UDFs in cfdump output.

show
string, optional
edit

show column or keys.

output
string, optional
edit

Where to send the results:

  • browser: the result is written to the browser response stream (default).
  • console: the result is written to the console (System.out).
  • debug: the result is written to the debugging logs, when debug is enabled.
  • false: output will not be written, effectively disabling the dump (this is currently not implemented, use enabled=false instead)

Otherwise, this is value is treated as filename to write/append the dump outputs into, unless left blank.

metainfo
boolean, optional
edit

Includes information about the query in the cfdump results.

keys
number, optional
edit

For a structure, number of keys to display.

hide
string, optional
edit

hide column or keys.

format
string, optional
edit

specify the output format of the dump, the following formats are available by default:

  • html: the default browser output
  • text: this is the default when outputting to console and plain text in the browser
  • classic: classic view with HTML/CSS/JavaScript
  • simple: no formatting in the output

You can use your custom style by creating a corresponding file in the lucee/dump/skins folder. Check the folder for examples.

abort
boolean, optional
edit

stops further processing of request.

async
boolean, optional
edit

if true and output is not to browser, Lucee builds the output in a new thread that runs in parallel to the thread that called the dump. please note that if the calling thread modifies the data before the dump takes place, it is possible that the dump will show the modified data.

enabled
boolean, optional
edit

dumps are enabled by default, pass false to short circuit a dump execution and effectively disable it

flush
boolean, optional
edit

flushes the response stream after the dump

Examples

edit

Simple example with cfdump

<!--- You can dump any thing here. Easy to see the content of complex data type--->
<cfdump var="#getTimeZoneInfo()#" label="Tag label"/>

See also