Contents

Return to Tags or Functions

cfdbinfo

Syntax

<cfdbinfo
	[datasource="string"]
	[dbname="string"]
	[dbnames="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="string"]
	[dbname="string"]
	[dbnames="string"]
	name="string"
	[password="string"]
	[pattern="string"]
	[procedure="string"]
	[table="string"]
	type="string"
	[username="string"];
</cfscript>

[] = Optional attribute

Description

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.

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.

Name Type Required Description
datasource string No Datasource to use to connect to the database.
dbname string No Name of the database
dbnames string No Name of the database (alias for dbname)
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 filter 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.
type string Yes Type of information to get:
- dbnames: database name and type
- tables: information to all tables
- columns: column infromation to a single table/view
- version: version information of the database
- procedures: information to all procedures
- procedure_columns: column infromation to a single procedure
- foreignkeys: information to all foreignkeys
- index: information to all indexes
,tables,columns,version,procedures,foreignkeys,index,users
username string No User name to connect to the database.

category Categories: