Command reference
Aggregate Functions
dbr.avg- Calculates the average of the selected columndbr.avg.prefix- Sets the prefix to be used with dbr.avgdbr.calc- Allows you to create calculation formulas to populate cellsdbr.count- Calculates the number of non-null valuesdbr.count.prefix- Sets the prefix to be used with dbr.countdbr.countd- Calculates the distinct number of non-null valuesdbr.countd.prefix- Sets the prefix to be used with dbr.countddbr.countr- Counts the total number of rowsdbr.max- Calculates the maximum value of the selected columndbr.max.prefix- Sets the prefix to be used with dbr.maxdbr.min- Calculates the minimum value of the selected columndbr.min.prefix- Sets the prefix to be used with dbr.mindbr.sum- Calculates the sum of the selected columndbr.sum.prefix- Sets the prefix to be used with dbr.sumdbr.summary.calc- Same as dbr.calc. Kept for compatibility with older versionsdbr.summary.options- Change the default aggregate calculationdbr.summary.text- Adds text to summary row
Appearance
dbr.accordion- Organizes report elements with accordionsdbr.accordion.class- Defines a custom accordion style using a CSS classdbr.accordion.close- Marks the end of an accordiondbr.accordion.style- Defines a custom accordion style using inline CSSdbr.collapse- Collapses selected columns to create a more compact viewdbr.collapse.template- Uses a template for collapsed datadbr.colsort- Alias fordbr.sortcoldbr.column.filter- An alias fordbr.columnfilterdbr.column.title- Defines a dynamic title for a column whose content changes at runtimedbr.columnfilter- Adds a column filter that hides non-matching rowsdbr.columnfilter.remember- Remembers the user's filter choice between page refreshesdbr.columnhighlite- Adds a column filter that highlights matching rowsdbr.compare- Shows database results side by sidedbr.compare.options- Changes the compare behaviordbr.divify- Uses DIVs instead of tables in the outputdbr.header.group- Adds an additional header row to group columnsdbr.header.tooltip- Defines a tooltip for a column headerdbr.keepwithnext- Places the next element side by side with the current onedbr.localization- Overrides the default localization settingsdbr.lockcolumns- Locks the leftmost columns when the result set is wider than the screen. The 'fixedrow' option allows variable-height columnsdbr.no_data- Defines a placeholder for queries that return no datadbr.nosort- Disables sorting on specified columnsdbr.pager- Attaches a pager to a table reportdbr.pageview- Shows a row in page view formatdbr.parameters.show- Makes the parameter input visible within the reportdbr.rank- Adds a rank to a columndbr.refresh- Makes the report automatically refresh at a set interval, or immediately if no interval is specifieddbr.resultset.options- Combines multiple result sets by skipping headers or footersdbr.rownum- Inserts the row number for each row in the result setdbr.rownum.set- Initializes the rownum valuedbr.scrollable- Makes the result set scrollable with a fixed number of visible rowsdbr.search- Enables or disables the search and export UI for a result setdbr.sort- Sets the initial sort orderdbr.sort.remember- Remembers the user's sort orderdbr.sortcol- Sorts a column based on values from another columndbr.sortmethod- Overrides the default sort method for a columndbr.sortorder- Overrides the default initial sort order (default: 'intelligent')dbr.tab- Organizes report elements with tabsdbr.tab.class- Defines a custom tab style using a CSS classdbr.tab.close- Marks the end of a tab sectiondbr.tab.next- Switches to the next unpopulated tabdbr.tab.selected- Sets the default tab by name or by tab order number (0=first, 1=second)dbr.tab.style- Defines a custom tab style using inline CSSdbr.toggle- Makes columns and rows togglabledbr.toggle.options- Sets toggle optionsdbr.tooltip- Defines the tooltip for a cell
Calendar
dbr.calendar- Creates a calendar from a result set or dynamically via Ajaxdbr.calendar.options- Sets calendar optionsdbr.calendar.report- Defines the Ajax report for calendar data
Charts
dbr.chart- Generates a chart from the subsequent result setdbr.chart.color- Defines custom colors for chart elementsdbr.chart.gv.cluster- Defines styles for Graphviz clustersdbr.chart.gv.cmdoptions- Passes custom options directly to the Graphviz renderer commanddbr.chart.gv.engine- Selects the Graphviz layout enginedbr.chart.gv.node- Defines styles for individual Graphviz nodesdbr.chart.gv.option- Configures specific options for Graphviz-based chartsdbr.chart.gv.preprocess- Preprocesses the Graphviz data file before renderingdbr.chart.gv.renderer_formatter- Overrides default Graphviz renderers and formatters (e.g.,cairo:cairo)dbr.chart.gv.style- Defines global styles for Graphviz objectsdbr.chart.options- Configures advanced options for the chart
Cross-tabulation
dbr.crosstab- Turns a result set into a cross-tabulation report. The first parameter is the crosstab column; the optional second parameter marks the last data column within the crosstab.dbr.crosstab.col- Predefines the cross-tabulation columnsdbr.crosstab.col.style- Sets the column style for the crosstab horizontal summary columndbr.crosstab.col.title- Sets the column title for the crosstab horizontal summary columndbr.crosstab.data.tooltip- Defines a crosstab header tooltip based on the crosstab data valuedbr.crosstab.group- Groups crosstab column values by adding another header leveldbr.crosstab.header- Adds an additional header group to the crosstabdbr.crosstab.header.col- Predefines the 2nd-level cross-tabulation header columns fordbr.crosstab.headerdbr.crosstab.options- Adds a crosstab optiondbr.crosstab.order- Sets the order of the cross-tabulation columnsdbr.crosstab.title- Overrides the default title for the horizontal summary columndbr.havg- Calculates the horizontal average in a cross-tabulation reportdbr.hcount- Calculates the number of values horizontally in a cross-tabulation reportdbr.hidecolumn.data- Hides crosstab data columns while keeping the summary column. Used withdbr.calcdbr.hidecolumn.data.all- Hides all crosstab data columns while keeping the summary columndbr.hidecolumn.set.data- Hides crosstab data columns based on the CrossTabSet namedbr.hidecolumn.summary- Hides crosstab summary columns while keeping data columns. Used withdbr.calcdbr.hidedatacolumn- Same asdbr.hidecolumn.data, kept for backwards compatibilitydbr.hmax- Calculates the horizontal maximum in a cross-tabulation reportdbr.hmin- Calculates the horizontal minimum in a cross-tabulation reportdbr.hminus- Calculates horizontal values using the formula Col1 - Col2 - Col3...dbr.hnull- Creates a placeholder for a horizontal column used withdbr.calcdbr.hsum- Calculates the horizontal sum in a cross-tabulation report
File Downloads
dbr.download- Serves files from the filesystem
Editable reports
dbr.editable- Enables in-place editing for a specific columndbr.selectable- Converts an ID column into checkboxes for batch processing with linked reportsdbr.selectable.selected- Preselects specific rows in adbr.selectableresult setdbr.upload- Facilitates file uploads to the server's filesystemdbr.upload.options- Configures specific file upload settings
Export Commands
dbr.blob- Reads a file from the databasedbr.calc.excel- Defines a native Excel formula for a columndbr.export.json- Keeps a JSON-formatted column as JSON in JSON exportdbr.export.options- Sets export optionsdbr.wkhtmltopdf- Passes command-line parameters to the wkhtmltopdf command
Header Levels
dbr.hdr- Sets a header level in a querydbr.hdr.options- Sets options for header level display
Passing HTML Into the Page
dbr.css- Includes CSS definitions in the reportdbr.file- Includes an HTML file in the reportdbr.head- Includes tags in the HTML head sectiondbr.html- Passes HTML directly into the report. Use this for safe HTML (your own HTML)dbr.html.ext- Passes HTML directly into the report. HTML content is filtered for unsafe code. Use this for unsafe HTMLdbr.html.ext:- Includes HTML in a string. HTML content is filtered for unsafe code. Use this for unsafe HTMLdbr.html:- Includes HTML in a string. Use this for safe HTML (your own HTML)dbr.http.debug- Debugs an HTTP PUT/POST calldbr.http.delete- Makes an HTTP DELETE request and optionally returns the resultdbr.http.get- Makes an HTTP GET request and optionally returns the resultdbr.http.header- Saves HTTP headersdbr.http.option- Passes options todbr.http.postdbr.http.post- Makes an HTTP POST request and returns the resultdbr.http.put- Makes an HTTP PUT request and returns the resultdbr.http.save- Calls a procedure to handle an HTTP POST/GET resultdbr.javascript- Includes JavaScript code in the reportdbr.purehtml- Same asdbr.html, kept for compatibilitydbr.purehtml:- Same asdbr.html:, kept for compatibilitydbr.redirect- Performs a server-side 302 redirect to another page. Uses the same syntax asdbr.reportdbr.system- Executes a system call
Import Commands
dbr.import- Calls the import procedure for each imported rowdbr.import.finish- Calls the finish report after the import completesdbr.import.options- Sets import optionsdbr.import.prepare- Calls the preparation report before the import begins
Linked Reports
dbr.button- Creates a button containing a linkdbr.embed_object- Creates a placeholder or popup window for the linked report's contentdbr.list- Creates a list containing a link to a reportdbr.report- Creates a link to another reportdbr.searchable- Creates a search field to get dynamic contentdbr.selectlist- Creates a select list for linked reportsdbr.url- Creates a link to an external URL
Remote Calls to Other myDBR Servers
dbr.remote.call- Executes the defined remote call and runs a local report to handle the results. Requireddbr.remote.options- Allows setting extra options for transfer. The option includes turning off the certificate check on the remote server. Optional and needs to be called before 'dbr.remote.prepare'dbr.remote.prepare- Defines the server to be called, call to be made and local table to receive the results. Required, needs to be called before 'dbr.remote.call'
Running total
dbr.running_total- Calculates the running total for a column
Applying Styles
dbr.avg_prefix- Override the default avg-prefixdbr.cellclass- Applies a CSS class to individual cells based on a value in another column, enabling value-based formattingdbr.cellformat- Applies a per-row printf format to a column using format strings from another column, allowing cells in the same column to be formatted differently across rowsdbr.cellstyle- Applies a CSS style to individual cells based on a value in another column, enabling value-based formattingdbr.colclass- Adds a CSS class to a specified report columndbr.colstyle- Sets a report column's style, combining printf formatting and CSS style definitionsdbr.count_prefix- Override the default count-prefixdbr.footer.cellclass- Sets the footer's CSS class based on data in another footer columndbr.footer.cellstyle- Sets the footer's CSS style based on data in another footer columndbr.footer.colclass- Sets the CSS class for a footer columndbr.footer.colstyle- Sets the style for a specific footer columndbr.footerstyle- Sets the footer row styledbr.header.colclass- Sets the CSS class for a header columndbr.header.colstyle- Sets the style for an individual header columndbr.headerstyle- Sets the header row styledbr.hidecolumn- Hides individual columns, which can be positioned anywhere in the querydbr.hidecolumns- Hides a specified number of columns from the right end of the result setdbr.hideheader- Hides the column headers in the result setdbr.html5data- Places a column's value into another column's HTML5 data-xxx attributedbr.html5data.rs- Adds an HTML5 data attribute to the result set tabledbr.max_prefix- Override the default max-prefixdbr.min_prefix- Override the default min-prefixdbr.resultclass- Adds a custom CSS class to the result tabledbr.rowclass- Applies a CSS class to report rows. A column in the query provides the CSS class name for each rowdbr.rowstyle- Applies a CSS style to report rows. A column in the query provides the CSS style for each rowdbr.showcolumn- Shows individual columns that were automatically hiddendbr.sum_prefix- Override the default sum-prefixdbr.summary.colstyle- Sets the style for an individual summary column
Templates
dbr.record- Records report output into a variable for later usedbr.template- Defines the template used for the subsequent result setdbr.template.footer- Declares the footer result setdbr.template.form- Uses result set columns to set values for form fields in the templatedbr.template.header- Declares the header result set
Titles / Text
dbr.subtitle- Gives a name to the result set in a reportdbr.text- Inserts a free text element into the reportdbr.title- Sets the report title. By default, the report's title is the report's name
Barcode Extension
dbr.barcode- Displays a barcode
D3 Extension
dbr.d3- Creates a D3 objectdbr.d3.sankey_format- Formats Sankey diagram tooltipsdbr.d3.zoom- Adjusts the zoom level for Chord diagrams when labels are long
eChart Extension
dbr.echart- Creates an extended chartdbr.echart.bubble_scale- Scales the bubble chart axesdbr.echart.color- Specifies the color palette for the chartdbr.echart.name- Sets the names for the chart categories
Form Extension
dbr.form- Creates a form
Google Maps Extension
dbr.googlemaps- Display Google Maps mashupdbr.googlemaps.geojson- Include GeoJSON-file into the mapsdbr.googlemaps.heatmap- Use Google Maps Heatmap layerdbr.googlemaps.kml- Include KML-file into the mapsdbr.googlemaps.link_in_title- Whether to show single linked report in the title or in the markerdbr.googlemaps.marker- Add additional markers to mapdbr.googlemaps.polyline- Draw a polyline between the pointsdbr.googlemaps.route- Draw route between the pointsdbr.googlemaps.same- Use the previous map and add elements to it instead of creating a new one
iCalendar Extension
dbr.icalendar- Create iCalendar file
IP2Location Extension
dbr.ip2location- Retrieves location data for a given IP addressdbr.ip2location.language- Sets the language for names returned by MaxMind (defaults to 'en'). Refer to MaxMind's documentation for supported language codes
Mail Extension
dbr.mail- Sends an emaildbr.mail.attach- Attaches a file to the emaildbr.mail.debug- Enables verbose debug logging for troubleshooting (1=on, 0=off)dbr.mail.encoding- Sets the email encoding (options: "8bit", "7bit", "binary", "base64", or "quoted-printable")dbr.mail.header_file- Overrides the default email header file with a custom one located in theuser/directorydbr.mail.ignore_invalid_email- Ignores invalid email addresses specified indbr.mail.recipientdbr.mail.log.proc- Defines a stored procedure to log email delivery actionsdbr.mail.nobr.html- Prevents automatic conversion of linefeeds to HTML line breaks (<br>) in HTML emailsdbr.mail.notify_successful_mail- Suppresses the "Mail sent" confirmation messagedbr.mail.postprocess- Post-processes the email content using a command-line tool (defaults to Pandoc)dbr.mail.recipient- Adds additional recipients (CC, BCC, or TO) to the emaildbr.mail.sender- Specifies the sender's address within the report, overriding global settingsdbr.mail.smtp.authentication.type- Selects the SMTP authentication method (defaults to LOGIN)dbr.mail.smtp.server- Specifies an alternative SMTP serverdbr.mail.smtp.ssl- Configures SSL context options for the SMTP connectiondbr.mail.smtp.user- Specifies alternative SMTP credentials (username and password)
OpenStreetMap Extension
dbr.openstreetmap- Display the mapdbr.openstreetmap.geojson- Include a GeoJSON file on the mapdbr.openstreetmap.heatmap- Enable the heatmap layerdbr.openstreetmap.options- Provide additional options to the Leaflet.jsL.Mapobjectdbr.openstreetmap.polygon- Add polygons to the map.dbr.openstreetmap.tiles- Use alternative tile layers on top of the map
Organization Chart Extension
dbr.org.chart- Displays an organization chartdbr.org.chart.animate- Enables or disables chart animationdbr.org.chart.autobalance- Defines automatic positioning for 'a'-nodesdbr.org.chart.drop- Enables dropping nodes onto each otherdbr.org.chart.lineclass- Sets the CSS class for the connector line ending at the nodedbr.org.chart.move- Enables reorganization by moving subtreesdbr.org.chart.nodeclass- Adds a CSS class to an organization nodedbr.org.chart.nodeheight- Sets the height for an individual nodedbr.org.chart.nodehshift- Sets the horizontal shift for sibling nodes in pixels. Default is 15pxdbr.org.chart.nodehspace- Sets the horizontal spacing between nodes. Default is 30pxdbr.org.chart.nodesize- Sets global node dimensionsdbr.org.chart.nodetoggle- Sets the initial toggle state for a node (1=toggled, 0=open)dbr.org.chart.nodevspace- Sets the vertical spacing between nodes. Default is 30pxdbr.org.chart.nodewidth- Sets the width for an individual nodedbr.org.chart.toggle- Configures the ability to toggle sub-charts, with an optional database callbackdbr.org.chart.tooltip- Adds a tooltip to a nodedbr.org.target- Adds a target indicator to a node
Push Notification Extension
dbr.push- Sends a push notificationdbr.push.debug- Displays the status for each message sent for troubleshootingdbr.push.log.proc- Logs push notification activity to a specified database proceduredbr.push.notify_successful_push- Suppresses the "Push message sent" confirmation messagedbr.push.option- Configures a service-specific optiondbr.push.sender- Selects a notification provider (prowl, pushsafer, pushover, pushbullet), overriding the default configured in$mydbr_push
QR Code Extension
dbr.qrcode- Displays a QR code
SMS Extension
dbr.sms- Sends SMS messages through the configured provider