Oracle SQL*Plus: The Definitive Guide, 2nd Edition

Name

DESCRIBE

Synopsis

The DESCRIBE command displays information about a table, a view, an Oracle object type, a stored package, a stored procedure, or a stored function. When used against a table or view, DESCRIBE returns a list of columns, including datatypes and lengths. When used against an Oracle object type or a stored package, DESCRIBE returns a list of procedures, functions, and variables accessible from outside the package or type. Parameters for each function, procedure, and method are listed as well. When used against a stored procedure or function, DESCRIBE returns a list of parameters. In the case of a function, DESCRIBE displays the return type as well. DESCRIBE is discussed in Chapter 10.

Syntax

DESC[RIBE] [schema.]object_name[@database_link_name]

Parameters

DESC[RIBE]

Is the command, which may be abbreviated DESC.

schema

Is the name of the object's owner. This defaults to your username.

object_name

Is the name of the object, often a table or a view, that you want to describe. You can describe any of the following: a table, a view, a stored procedure, a stored function, a stored package, or an Oracle object type.

database_link_name

Is the name of a database link pointing to the database where the object exists. You need to specify this only if the object you want to describe exists in a database other than the one to which you are currently connected. Your DBA can help create a database link if you need one.