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

Synopsis

dbfootprint([allObjects=boolean], [outputFile=string], [type=string])

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

dbfootprint is NOT undoable, queryable, and NOT editable.

This command lets you explore the memory usage of specific parts of the scene. Query the 'type' flag to see what all of the different types are, and query a specific type to get a description of what information it will provide. All output is in JSON format so that it can easily be processed and formatted to highlight areas of interest.

Return value

stringJSON data representing the memory usage of the requested objects
string[]List of types for which footprint measurements can be made (Query with no flags)
stringDescription of what a particular type will measure (Query with a 'type' flag)

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

Keywords

dbtrace, dbpeek

Flags

allObjects, outputFile, type
Long name (short name) Argument types Properties
allObjects(all) boolean create
Ignore any specified or selected objects and measure all applicable objects. The definition of "allObjects" will vary based on the type of objects being measured - see the type documentation for details on what it means for that type. By default if no objects are selected or specified then it will behave as though this flag were set.
outputFile(of) string create
Specify the location of a file to which the information is to be dumped. Default will return the value from the command. Use the special names stdout, cout, stderr, or cerr to redirect to the standard output or error locations.
type(t) string createquery
Specify the type of object footprint to measure. The various types are registered at run time and can be listed by querying this flag without a value. If you query it with a value then you get a description of what that particular type is going to measure.

In query mode, this flag can accept a value.
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

cmds.dbfootprint( query=True )
# Result: ['nodes'] #