Lucee Tag Reference

<cfdbinfo>

Lets you retrieve information about a data source, including details about the database, tables, queries, procedures, foreign keys, indexes, and version information about the database, driver, and JDBC. This tag supports only JDBC drivers, and does not support ODBC-based drivers, including the Microsoft Access driver.

Body

This tag can't have a body.

Example

<cfdbinfo
[datasource=object]
[dbname=string]
[filter=string]
name=string
[password=string]
[pattern=string]
[procedure=string]
[table=string]
type=string
[username=string]>
This tag is also supported within cfscript
<cfscript>
dbinfo
[datasource=object]
[dbname=string]
[filter=string]
name=string
[password=string]
[pattern=string]
[procedure=string]
[table=string]
type=string
[username=string];
</cfscript>

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Description
datasource any No Datasource to use to connect to the database. 
dbname string No Name of the database 
filter string No Filter for type="tables" with a wildcard, defaults to all types when empty (slow, especially oracle).
  • "TABLE"
  • "VIEW"
  • "SYSTEM TABLE"
  • "GLOBAL TEMPORARY"
  • "LOCAL TEMPORARY"
  • "ALIAS"
  • "SYNONYM"
    Each Database implementation has it's own supported types 
    		•
    name string Yes Name to use to refer to the result. 
    password string No Password to connect to the database. 
    pattern string No Specifies a sql filter, i.e 'sys%' to retrieve information about specific tables, columns, or stored procedures 
    procedure string No Name of the procedure from which you retrieve information. 
    table string No Name of the table from which you retrieve information.
    Patterns are also supported, i.e.
  • use % to fetch all columns, from every table.
  • use SCHEMA.% to fetch all columns, from every table, from a scheme.
    Not used for type="tables", use pattern instead 
    		•
    type string Yes Type of information to get:
  • dbNames: database name and type
  • tables: information to all tables
  • columns: column information for tables/views, accepts wildcards like '%''
  • columns_minimal: column information for tables/views, but no FK / PK information (faster)
  • version: version information of the database
  • procedures: information to all procedures
  • procedure_columns: column information to a single procedure
  • foreignKeys: information to all foreignKeys
  • index: information to all indexes
  • users: list database users
  • terms: vendor preferred term for PROCEDURE, CATALOG and SCHEMA 
    		•
    username string No User name to connect to the database.