1 Version 4.0 -- 1/15/89 sp_helpkey
______________________________________________________________________
NAME: sp_helpkey
FUNCTION:
Reports information on primary, foreign, and common keys.
SYNTAX:
sp_helpkey [objname]
EXAMPLES:
sp_helpkey
Displays information on the keys that have been defined in the
sp_helpkey Version 4.0 -- 1/15/89 2
______________________________________________________________________
database:
keytype object related_object object_keys related_keys
------- ------- -------------- ----------------------- ---------------------
primary authors -- none -- au_id, *, *, *, *, *, *, * *, *, *, *, *, *, *, *
foreign titleauthor authors au_id, *, *, *, *, *, *, * au_id, *, *, *, *, *, *, *
(2 rows affected)
PARAMETERS:
objname - is the name of a table or view in the current data-
base. If you don't specify a name, the procedure reports on
all keys that have been defined in the current database.
COMMENTS:
o Executing sp_helpkey lists information about all the primary,
3 Version 4.0 -- 1/15/89 sp_helpkey
______________________________________________________________________
foreign, or common key definitions that reference the table
objname, or about all the keys in the database. The
object_keys and related_keys columns in the report refer to the
names of the columns that make up the key.
o Keys are created to make explicit a logical relationship: that
is implicit in your database design. The information can be
used by an application program.
MESSAGES:
The name supplied for the objname parameter included a database
reference. You can get key information about local tables or
views only.
The name supplied for the objname parameter is not a table or
view in the current database.
PERMISSIONS:
Execute permission to public.
sp_helpkey Version 4.0 -- 1/15/89 4
______________________________________________________________________
TABLES USED:
syskeys, master.dbo.spt_values
SEE ALSO:
sp_commonkey, sp_foreignkey, sp_help, sp_primarykey, CREATE
TRIGGER