Go to: Synopsis. Return value. Keywords. Flags. Python examples.

Synopsis

dbtrace([filter=string], [info=boolean], [keyword=string], [mark=boolean], [off=boolean], [output=string], [timed=boolean], [title=string], [verbose=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

dbtrace is NOT undoable, queryable, and NOT editable.

The dbtrace command is used to manipulate trace objects. The keyword is the only mandatory argument, indicating which trace object is to be altered. You can use the query mode to find out which keywords are currently active (query with no arguments) or inactive (query with the off argument). You can enhance that query with or without a keyword argument to find out where their output is going (query with the output argument), out what filters are currently applied (query with the filter argument), or if their output will be timestamped (query with the timed argument).

Return value

None

In query mode, return type is based on queried flag.

Keywords

debug, trace, filter

Flags

filter, info, keyword, mark, off, output, timed, title, verbose
Long name (short name) Argument types Properties
filter(f) string createquery
Set the filter object for these trace objects (see 'dgfilter')
info(i) boolean query
In query mode return a brief description of the trace object.
keyword(k) string createquerymultiuse
Keyword of the trace objects to affect

In query mode, this flag can accept a value.
mark(m) boolean create
Display a mark for all outputs of defined trace objects
off() boolean create
Toggle the traces off. If omitted it will turn them on.
output(o) string createquery
Destination file of the affected trace objects. Use the special names stdout and stderr to redirect to your command window. The special name msdev is available on Windows to direct your output to the debug tab in the output window of Visual Studio.
timed(tm) boolean createquery
Turn on/off timing information in the output of the specified trace objects.
title(t) string create
Display a title mark for all outputs of defined trace objects
verbose(v) boolean create
Include all traces in output and filter queries, not just those turned on.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# The default action is to turn the trace object on.  This action can be
# changed using one of the -off, -output, -mark, -query, or -title.
cmds.dbtrace( off=True ) # turns all active tracing off
cmds.dbtrace( k='key' )  # turns on all tracing for keyword "key"
cmds.dbtrace( o='FRED' ) # sends all active tracing output to the file "FRED"
# Inserts a title line in all active trace destinations having keyword 'key'
cmds.dbtrace( k='key', t='This is a Title' )
# Only turn on traces with keyword "key" in Transform nodes
cmds.dbtrace( k="key", f="transform" )
# Show where output is going for all levels of trace objects having keyword "fooTrace"
cmds.dbtrace( query=True, k="fooTrace", output=True )