<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.

Usage

<cfdbinfo
    [pattern=string]
    [table=string]
    [dbname=string]
    [password=string]
    name=string
    type=string
    [procedure=string]
    [datasource=string]
    [username=string]
>

This tag cannot have a body.

This tag is also supported within cfscript

Attributes

Attribute Description
pattern
(string, optional)

Specifies a filter to retrieve information about specific tables, columns, or stored procedures

table
(string, optional)

Name of the table from which you retrieve information.

dbname
(string, optional)

Name of the database

password
(string, optional)

Password to connect to the database.

name
(string, required)

Name to use to refer to the result.

type
(string, required)

Type of information to get:

  • dbnames: database name and type
  • tables: information to all tables
  • columns: column information to a single table/view
  • 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
procedure
(string, optional)

Name of the procedure from which you retrieve information.

datasource
(string, optional)

Datasource to use to connect to the database.

username
(string, optional)

User name to connect to the database.

Examples

There are currently no examples for this tag.