Interactive dbsql commands  Catalog stored procedures

Chapter 1: Quick Reference

System procedures

This section provides the syntax and brief descriptions for Adaptive Server system stored procedures. See Reference Manual: Procedures for more information.

sp_activeroles

Displays all active roles.

sp_activeroles [expand_down]

sp_add_qpgroup

Adds an abstract plan group.

sp_add_qpgroup new_name

sp_add_resource_limit

Creates a limit on the number of server resources that can be used by an Adaptive Server login and/or an application to execute a query, query batch, or transaction.

sp_add_resource_limit name, appname, rangename, limittype, limitvalue 
	[, enforced [, action [, scope ]]]

sp_add_time_range

Adds a named time range to an Adaptive Server.

sp_add_time_range name, startday, endday, 
	starttime, endtime

sp_addalias

Allows an Adaptive Server user to be known in a database as another user.

sp_addalias loginame, name_in_db

sp_addauditrecord

Allows users to enter user-defined audit records (comments) into the audit trail.

sp_addauditrecord [text [, db_name [, obj_name
	[, owner_name [, dbid [, objid]]]]]]

sp_addaudittable

Adds another system audit table after auditing is installed.

sp_addaudittable devname

sp_addengine

Adds an engine to an existing engine group or, if the group does not exist, creates an engine group and adds the engine.

sp_addengine engine_number, engine_group

sp_addexeclass

Creates or updates a user-defined execution class that you can bind to client applications, logins, and stored procedures.

sp_addexeclass classname, priority, timeslice, engine_group

sp_addextendedproc

Creates an extended stored procedure (ESP) in the master database.

sp_addextendedproc esp_name, dll_name

sp_addexternlogin

Component Integration Services only– creates an alternate login account and password to use when communicating with a remote server through Component Integration Services.

sp_addexternlogin server, loginame, externname 
	[, externpasswd] [rolename]

sp_addgroup

Adds a group to a database. Groups are used as collective names in granting and revoking privileges.

sp_addgroup grpname

sp_addlanguage

Defines the names of the months and days for an alternate language and its date format.

sp_addlanguage language, alias, months, shortmons, 
	days, datefmt, datefirst

sp_addlogin

Adds a new user account to Adaptive Server; specifies the password expiration interval, the minimum password length, and the maximum number of failed logins allowed for a specified login at creation.

sp_addlogin loginame, passwd [, defdb] 
	[, deflanguage] [, fullname] [, passwdexp]
	[, minpwdlen] [, maxfailedlogins] [, auth_mech]

sp_addmessage

Adds user-defined messages to sysusermessages for use by stored procedure print and raiserror calls and by sp_bindmsg.

sp_addmessage message_num, message_text 
	[, language [, with_log [, replace]]]

sp_addobjectdef

Component Integration Services only – specifies the mapping between a local table and an external storage location.

sp_addobjectdef tablename, objectdef [,"objecttype"]

sp_addremotelogin

Authorizes a new remote server user by adding an entry to master.dbo.sysremotelogins.

sp_addremotelogin remoteserver [, loginame [, remotename] ]

sp_addsegment

Defines a segment on a database device in a database.

sp_addsegment segname, dbname, devname

sp_addserver

Defines a remote server, or defines the name of the local server.

sp_addserver lname [, class [, pname]]

sp_addthreshold

Creates a threshold to monitor space on a database segment.

sp_addthreshold dbname, segname, free_space, proc_name

sp_addtype

Creates a user-defined datatype.

sp_addtype typename, 
	phystype [(length) | (precision [, scale])]
	[, "identity" | nulltype]

sp_addumpdevice

Adds a dump device to Adaptive Server.

sp_addumpdevice {"tape" | "disk"}, logicalname,
	physicalname [, tapesize]

sp_adduser

Adds a new user to the current database.

sp_adduser loginame [, name_in_db [, grpname]]

sp_altermessage

Enables and disables the logging of a system-defined or user-defined message in the Adaptive Server error log.

sp_altermessage message_id, parameter, parameter_value

sp_audit

Allows a System Security Officer to configure auditing options.

sp_audit option, login_name, object_name [,setting]
sp_audit ‘restart’

sp_autoconnect

Component Integration Services only – defines a passthrough connection to a remote server for a specific user, which allows the named user to enter passthrough mode automatically at login.

sp_autoconnect server, {true|false} 
	[, loginame]

sp_autoformat

Reformats the width of variable-length character data to display only non-blank characters.

sp_autoformat fulltabname [, selectlist , whereclause , orderby ]

sp_bindcache

Binds a database, table, index, text object, or image object to a data cache.

sp_bindcache cachename, dbname
	[, [ownername.]tablename
	[, indexname | "text only"]]

sp_bindefault

Binds a user-defined default to a column or user-defined datatype.

sp_bindefault defname, objname [, futureonly]

sp_bindexeclass

Associates an execution class with a client application, login, or stored procedure.

sp_bindexeclass "object_name", "object_type", "scope", "classname"

sp_bindmsg

Binds a user message to a referential integrity constraint or check constraint.

sp_bindmsg constrname, msgid

sp_bindrule

Binds a rule to a column or user-defined datatype.

sp_bindrule rulename, objname [, futureonly]

sp_cacheconfig

Creates, configures, reconfigures, and drops data caches, and provides information about them.

sp_cacheconfig [cachename [ ,"cache_size[P|K|M|G]" ] 
	[,logonly | mixed ] [,strict | relaxed ] ]
	[, "cache_partition=[1|2|4|8|16|32|64]"]

sp_cachestrategy

Enables or disables prefetching (large I/O) and MRU cache replacement strategy for a table, index, text object, or image object.

sp_cachestrategy dbname, [ownername.]tablename 
	[, indexname | "text only" | "table only" 
	[, { prefetch | mru }, { "on" | "off"}]]

sp_changedbowner

Changes the owner of a user database.

sp_changedbowner loginame [, true ]

sp_changegroup

Changes a user’s group.

sp_changegroup grpname, username

sp_checknames

Checks the current database for names that contain characters not in the 7-bit ASCII set.

sp_checknames [help | silent]

sp_checkreswords

Detects and displays identifiers that are Transact-SQL reserved words. Checks server names, device names, database names, segment names, user-defined datatypes, object names, column names, user names, login names, and remote login names.

sp_checkreswords [user_name_param]

sp_checksource

Checks for the existence of the source text of the compiled object, and for the existence of computed column source text.

sp_checksource [objname [, tabname [, username]]]

sp_chgattribute

Changes the max_rows_per_page, fillfactor, reservepagegap, or exp_row_size value for future space allocations of a table or an index; sets the concurrency_opt_threshold for a table. Provides the user interface for optimistic index locking.

sp_chgattribute objname, {"max_rows_per_page" | "fillfactor" | 
	"reservepagegap" | "exp_row_size"
	concurrency_opt_threshold | “optimistic_index_lock” | “identity_burn_max”}, value,  optvalue
sp_chgattribute objname, {"identity_gap", set_number |
	“dealloc_first_txtpg”, value}

sp_clearpsexe

Clears the execution attributes of an Adaptive Server session that was set by ssp_setpsexe.

sp_clearpsexe spid, exeattr

sp_clearstats

Initiates a new accounting period for all server users or for a specified user. Prints statistics for the previous period by executing sp_reportstats.

sp_clearstats [loginame]

sp_client_addr

Displays the IP (Internet Protocol) address of every Adaptive Server task with an attached client application, including the spid and the client host name.

sp_client addr[“spid”]

sp_cmp_all_qplans

Compares all abstract plans in two abstract plan groups.

sp_cmp_all_qplans group1, group2 [, mode]

sp_cmp_qplans

Compares two abstract plans.

sp_cmp_qplans id1, id2

sp_commonkey

Defines a common key—columns that are frequently joined—between two tables or views.

sp_commonkey tabaname, tabbname, col1a, col1b 
	[, col2a, col2b, ..., col8a, col8b]

sp_companion

Performs cluster operations such as configuring Adaptive Server as a secondary companion in a high availability system and moving a companion server from one failover mode to another.

sp_companion 
	[server_name 
	{, configure
		[, {with_proxydb | NULL}] 
		[, srvlogin]
		[, server_password]
		[, cluster_login] 
		[, cluspassword]]
	| drop
	| suspend
	| resume
	| prepare_failback
	| do_advisory}
		{, all
		| help
		| group attribute_name 
		| base attribute_name}

sp_configure

Displays configuration parameters by group, their current values, their default values, the value to which they have most recently been set, and the amount of memory used by this setting.

sp_configure [configname [, configvalue] | group_name | 
	non_unique_parameter_fragment]
sp_configure "configuration file", 0, {"write" | "read" | "verify" | "restore"} 
	"file_name"

sp_copy_all_qplans

Copies all plans for one abstract plan group to another group.

sp_copy_all_qplans src_group, dest_group

sp_copy_qplan

Copies one abstract plan to an abstract plan group.

sp_copy_qplan src_id, dest_group

sp_countmetadata

Displays the number of indexes, objects, or databases in Adaptive Server.

sp_countmetadata "configname" [, dbname]

sp_cursorinfo

Reports information about a specific cursor or all execute cursors that are active for your session.

sp_cursorinfo [{cursor_level | null}] [, cursor_name]

sp_dbextend

Allows you to install automatic database expansion procedures on database/segment pairs and devices, define site-specific policies for individual segments and devices, and simulate execution of the database expansion machinery, to study the operation before engaging large volume loads.

sp_dbextend ’help’[, <command > ]
sp_dbextend [ ['set', ['threshold', dbname, segmentname, freespace | 
	'database', dbname, segmentname {[ [, growby ] [, maxsize ] ]} | 
	'device', devicename { [ [, growby ] [, maxsize ] ] }] |
	'clear', 'threshold', dbname, segmentname 
sp_dbextend 'clear', 'database' [, dbname [, segmentname ] ]
sp_dbextend 'clear', 'device' [, devicename ]
sp_dbextend 'modify', 'database', dbname, segmentname, 
	{ 'growby' | 'maxsize' }, newvalue
sp_dbextend 'modify', 'device', devicename, { ’growby’ | ' maxsize ' }, 
	newvalue
sp_dbextend { 'list' | 'listfull' } [, 'database' [, dbname [, segmentname 
	[, order_by_clause ] ] ] ]
sp_dbextend { 'list' | 'listfull' } [, 'device' [, devicename [, order_by_clause ] ] ]
sp_dbextend { 'list' | 'listfull' }, [ 'threshold' [ , @dbname 
	[ , @segmentname ] ] ]
sp_dbextend 'check', 'database' [, dbname [, segmentname ] ]
sp_dbextend { 'simulate' | 'execute' }, dbname, segmentname [, iterations ]
sp_dbextend 'trace', {'on' | 'off' }
sp_dbextend 'reload [defaults]'
sp_dbextend { 'enable' | 'disable' }, 'database' [, dbname [, segmentname ] ]
sp_dbextend 'who' [, '<spid>' | 'block' | 'all' ]

sp_dboption

Displays or changes database options, and enables the asynchronous log service feature.

sp_dboption [dbname, optname, optvalue [, dockpt]]

sp_dbrecovery_order

Specifies the order in which user databases are recovered and lists the user-defined recovery order of a database or all databases.

sp_dbrecovery_order 
	[database_name [, rec_order [, force]]]

sp_dbremap

Forces Adaptive Server to recognize changes made by alter database. Run this procedure only when instructed to do so by an Adaptive Server message.

sp_dbremap dbname

sp_defaultloc

Component Integration Services only – defines a default storage location for objects in a local database.

sp_defaultloc dbname, defaultloc, defaulttype

sp_depends

Displays information about database object dependencies.

sp_depends objname[, column_name]

sp_deviceattr

UNIX platforms only – changes the device parameter settings of an existing database device file.

sp_deviceattr  logicalname, optname, optvalue

sp_diskdefault

Specifies whether or not a database device can be used for database storage if the user does not specify a database device or specifies default with the create database or alter database commands.

sp_diskdefault logicalname, {defaulton | defaultoff}

sp_displayaudit

Displays the status of audit options.

sp_displayaudit ["procedure" | "object" | "login" | "database" | "global" | 
	"default_object" | "default_procedure" [, "name"]]

sp_displaylevel

Sets or shows which Adaptive Server configuration parameters appear in sp_configure output.

sp_displaylevel [loginame [, level]]

sp_displaylogin

Displays information about a login account. Also displays information about the hierarchy tree above or below the login account when you so specify.

sp_displaylogin [loginame [, expand_up | expand_down]]

sp_displayroles

Displays all roles granted to another role, or displays the entire hierarchy tree of roles in table format.

sp_displayroles [grantee_name [, mode]]

sp_dropalias

Removes the alias user name identity established with sp_addalias.

sp_dropalias loginame [, force]

sp_drop_all_qplans

Deletes all abstract plans in an abstract plan group.

sp_drop_all_qplans name

sp_drop_qpgroup

Drops an abstract plan group.

sp_drop_qpgroup group

sp_drop_qplan

Drops an abstract plan.

sp_drop_qplan id

sp_drop_resource_limit

Removes one or more resource limits from Adaptive Server.

sp_drop_resource_limit { name, appname }
	[, rangename, limittype, enforced, action, scope]

sp_drop_time_range

Removes a user-defined time range from Adaptive Server.

sp_drop_time_range name

sp_dropdevice

Drops an Adaptive Server database device or dump device.

sp_dropdevice logicalname

sp_dropengine

Drops an engine from a specified engine group or, if the engine is the last one in the group, drops the engine group.

sp_dropengine engine_number, engine_group

sp_dropexeclass

Drops a user-defined execution class.

sp_dropexeclass classname

sp_dropextendedproc

Removes an extended stored procedure (ESP).

sp_dropextendedproc esp_name

sp_dropexternlogin

Component Integration Services only – Drops the definition of a remote login previously defined by sp_addexternlogin.

sp_dropexternlogin  server  [,  loginame  [,  rolename ] ]

sp_dropglockpromote

Removes lock promotion values from a table or database.

sp_dropglockpromote {"database" | "table"}, objname

sp_dropgroup

Drops a group from a database.

sp_dropgroup grpname

sp_dropkey

Removes from the syskeys table a key that had been defined using sp_primarykey, sp_foreignkey, or sp_commonkey.

sp_dropkey keytype, tabname [, deptabname]

sp_droplanguage

Drops an alternate language from the server and removes its row from master.dbo.syslanguages.

sp_droplanguage language [, dropmessages]

sp_droplogin

Drops an Adaptive Server user login by deleting the user’s entry from master.dbo.syslogins.

sp_droplogin loginame

sp_dropmessage

Drops user-defined messages from sysusermessages.

sp_dropmessage message_num [, language]

sp_dropobjectdef

Component Integration Services only – deletes the external storage mapping provided for a local object.

sp_dropobjectdef tablename

sp_dropremotelogin

Drops a remote user login.

sp_dropremotelogin remoteserver [, loginame [, remotename] ]

sp_droprowlockpromote

Removes row lock promotion threshold values from a database or table.

sp_droprowlockpromote {"database" | "table"}, objname

sp_dropsegment

Drops a segment from a database or unmaps a segment from a particular database device.

sp_dropsegment segname, dbname [, device]

sp_dropserver

Drops a server from the list of known servers or drops remote logins and external logins in the same operation.

sp_dropserver server [, droplogins]

sp_dropthreshold

Removes a free-space threshold from a segment.

sp_dropthreshold dbname, segname, free_space

sp_droptype

Drops a user-defined datatype.

sp_droptype typename

sp_dropuser

Drops a user from the current database.

sp_dropuser name_in_db

sp_dumpoptimize

Specifies the amount of data dumped by Backup Server during the dump database operation.

sp_dumpoptimize [ ’archive_space = 
	{maximum | minimum | default }’ ]
sp_dumpoptimize [ ’reserved_threshold = 
	{nnn | default }’ ]
sp_dumpoptimize [ ’allocation_threshold = 
	{nnn | default }’ ]

sp_engine

Enables you to bring an engine online or offline.

sp_engine {“online” | [offline | can_offline] [, engine_id] | 
[“shutdown”, engine_id]}

sp_estspace

Estimates the amount of space required for a table and its indexes, and the time needed to create the index.

sp_estspace table_name, no_of_rows, fill_factor,
	cols_to_max, textbin_len, iosec, page_size

sp_export_qpgroup

Exports all plans for a specified user and abstract plan group to a user table.

sp_export_qpgroup usr, group, tab

sp_extendsegment

Extends the range of a segment to another database device.

sp_extendsegment segname, dbname, devname

sp_extengine

Starts and stops EJB Server. Displays status information about EJB Server.

sp_extengine 'ejb_server', '{ start | stop | status }'

sp_familylock

Reports information about all the locks held by a family (coordinating process and its worker processes) executing a statement in parallel.

sp_familylock [fpid1 [, fpid2]]

sp_find_qplan

Finds an abstract plan, given a pattern from the query text or plan text.

sp_find_qplan pattern [, group ]

sp_fixindex

Repairs the index on one of your system tables when it has been corrupted.

sp_fixindex dbname, tabname, indid

sp_flushstats

Flushes statistics from in-memory storage to the systabstats and sysstatistics system tables.

sp_flushstats objname

sp_forceonline_db

Provides access to all the pages in a database that were previously marked suspect by recovery.

sp_forceonline_db dbname, 
	{"sa_on" | "sa_off" | "all_users"}

sp_forceonline_object

Provides access to an index previously marked suspect by recovery.

sp_forceonline_object dbname, objname, indid,
	{sa_on | sa_off | all_users} [, no_print]

sp_forceonline_page

Provides access to pages previously marked suspect by recovery.

sp_forceonline_page dbname, pgid, 
	{"sa_on" | "sa_off" | "all_users"}

sp_foreignkey

Defines a foreign key on a table or view in the current database.

sp_foreignkey tabname, pktabname, col1 [, col2] ... 
	[, col8] 

sp_freedll

Unloads a dynamic link library (DLL) that was previously loaded into XP Server memory to support the execution of an extended stored procedure (ESP).

sp_freedll dll_name

sp_getmessage

Retrieves stored message strings from sysmessages and sysusermessages for print and raiserror statements.

sp_getmessage message_num, result output [, language]

sp_grantlogin

Windows NT only – assigns Adaptive Server roles or default permissions to Windows NT users and groups when Integrated Security mode or Mixed mode (with Named Pipes) is active.

sp_grantlogin {login_name | group_name} 
	["role_list" | default]

sp_ha_admin

Performs administrative tasks on Adaptive Servers configured with Sybase Failover in a high availability system.

sp_ha_admnin [cleansessions | help]

sp_help

Reports information about a database object (any object listed in sysobjects) and about system or user-defined datatypes, as well as computed columns and function-based indexes.

sp_help [objname]

sp_help_resource_limit

Reports on resource limits.

sp_help_resource_limit [name [, appname [, limittime
	[, limitday [, scope [, action[, verbose]]]]]]]

sp_help_qpgroup

Reports information on an abstract plan group.

sp_help_qpgroup [ group [, mode ]]

sp_help_qplan

Reports information about an abstract plan.

sp_help_qplan id [, mode ]

sp_helpartition

Lists partition-related information of a table or index.

sp_helpartition [ tabname [, { null | indexname | ‘all’ }[, partitionname ] ] ]

sp_helpcache

Displays information about the objects that are bound to a data cache or the amount of overhead required for a specified cache size.

sp_helpcache {cache_name | "cache_size[P|K|M|G]"}

sp_helpcomputedcolumn

Reports information on the computed columns in a specified table.

sp_helpcomputedcolumn {tabname}

sp_helpconfig

Reports help information on configuration parameters.

sp_helpconfig "configname", ["size"]

sp_helpconstraint

Reports information about integrity constraints used in the specified tables.

sp_helpconstraint [objname] [, detail] 

sp_helpdb

Reports information about a particular database or about all databases.

sp_helpdb   [  dbname  [,  order ]  ]

sp_helpdevice

Reports information about a particular device or about all Adaptive Server database devices and dump devices.

sp_helpdevice [devname]

sp_helpextendedproc

Displays extended stored procedures (ESPs) in the current database, along with their associated DLL files.

sp_helpextendedproc [esp_name]

sp_helpexternlogin

Component Integration Services only – reports information about external login names.

sp_helpexternlogin   [  server  [,  loginame  [,  rolename  ]  ]  ]

sp_helpgroup

Reports information about a particular group or about all groups in the current database.

sp_helpgroup [grpname]

sp_helpindex

Reports information about the indexes created on a table, and on computed column indexes and function-based indexes.

sp_helpindex objname

sp_helpjava

Displays information about Java classes and associated JARs that are installed in the database.

 sp_helpjava ["class" [, java_class_name [, “detail” | “depends” ] ] | 
	"jar" [, jar_name [, “depends” ] ] ]

sp_helpjoins

Lists the columns in two tables or views that are likely join candidates.

sp_helpjoins lefttab, righttab

sp_helpkey

Reports information about a primary, foreign, or common key of a particular table or view, or about all keys in the current database.

sp_helpkey [tabname]

sp_helplanguage

Reports information about a particular alternate language or about all languages.

sp_helplanguage [language]

sp_helplog

Reports the name of the device that contains the first page of the transaction log.

sp_helplog

sp_helpobjectdef

Component Integration Services only – reports owners, objects, and type information for remote object definitions.

sp_helpobjectdef [objname]

sp_helpremotelogin

Reports information about a particular remote server’s logins or about all remote server logins.

sp_helpremotelogin [remoteserver [, remotename]]

sp_helprotect

Reports on permissions for database objects, users, groups, or roles.

sp_helprotect [name [, username [, "grant" 
	[,"none"|"granted"|"enabled"|role_name]]]]

sp_helpsegment

Reports information about a particular segment or about all segments in the current database.

sp_helpsegment [segname]

sp_helpserver

Reports information about a particular remote server or about all remote servers.

sp_helpserver [server]

sp_helpsort

Displays Adaptive Server’s default sort order and character set.

sp_helpsort

sp_helptext

Displays the source text of a compiled object. Displays the source text of computed columns or function-based index definitions.

sp_helptext objname [,number]

sp_helpthreshold

Reports the segment, free-space value, status, and stored procedure associated with all thresholds in the current database or all thresholds for a particular segment.

sp_helpthreshold [segname]

sp_helpuser

Reports information about a particular user, group, or alias, or about all users, in the current database.

sp_helpuser [name_in_db]

sp_hidetext

Hides the source text for the specified compiled object. Hides the text of computed columns and function-based index keys.

sp_hidetext [objname [, tabname [, username]]]

sp_import_qpgroup

Imports abstract plans from a user table into an abstract plan group.

sp_import_qpgroup tab, usr, group

sp_indsuspect

Checks user tables for indexes marked as suspect during recovery following a sort order change.

sp_indsuspect [tab_name]

sp_ldapadmin

Creates an LDAP URL search string, lists an LDAP URL search string, or verifies an LDAP URL search string or login.

sp_ldapadmin { set_primary_url, ‘ldapurl’ | 
	set_secondary_url, { ‘ldapurl’ | null } |
	set_access_acct, account_distinguished_name, account_password |
	set_dn_lookup_url, distinguished_name_url |
	list_urls | check_url, ‘ldapurl’ |
	check_login, ‘login_name’ }

sp_listener

Dynamically starts and stops listeners on Adaptive Server on any given port on a per-engine basis.

sp_listener “command”, “server_name”, engine | remaining
sp_listener “command”, “[protocol:]machine:port”, engine

sp_listsuspect_db

Lists all databases that currently have offline pages because of corruption detected on recovery.

sp_listsuspect_db

sp_listsuspect_object

Lists all indexes in a database that are currently offline because of corruption detected on recovery.

sp_listsuspect_object [dbname]

sp_listsuspect_page

Lists all pages in a database that are currently offline because of corruption detected on recovery.

sp_listsuspect_page [dbname] 

sp_lmconfig

Configures license management-related information on Adaptive Server.

sp_lmconfig “edition”, edition_type, 
	“license type”, license_type_name, 
	“smtp host”, smtp_host_name, 
	“smtp port”, smtp_port_number, 
	“email sender”, sender_email_address, 
	“email recipients”, email_recipients, 
	“email severity”, email_severity

sp_lock

Reports information about processes that currently hold locks.

sp_lock [spid1 [, spid2]]

sp_locklogin

Locks an Adaptive Server account so that the user cannot log in, or displays a list of all locked accounts.

sp_locklogin login | all | NULL | wildcard_string , "lock" |"unlock",
	[ except_login_name | except_role_name ] 
sp_locklogin

sp_logdevice

Moves the transaction log of a database with log and data on the same device to a separate database device.

sp_logdevice dbname, devname

sp_loginconfig

Windows NT only – displays the value of one or all integrated security parameters.

sp_loginconfig ["parameter_name"]

sp_logininfo

Windows NT only – displays all roles granted to Windows NT users and groups with sp_grantlogin.

sp_logininfo ["login_name" | "group_name"]

sp_logiosize

Changes the log I/O size used by Adaptive Server to a different memory pool when doing I/O for the transaction log of the current database.

sp_logiosize ["default" | "size" | "all"]

sp_maplogin

Maps external users to Adaptive Server logins.

sp_maplogin (authentication_mech | null), (client_username | null), 
	(action | login_name | null)

sp_metrics

Backs up, drops, and flushes QP metrics—always captured in the default running group, which is group 1 in each respective database—and their statistics on queries.

sp_metrics [‘backup’ backup_group_ID | ‘drop’, ‘gid’ [, ‘id’] | 
	‘flush’ | ‘help’, ‘command’]

sp_modify_resource_limit

Changes a resource limit by specifying a new limit value, or the action to take when the limit is exceeded, or both.

sp_modify_resource_limit {name, appname } 
	rangename , limittype , limitvalue , enforced , action , scope

sp_modify_time_range

Changes the start day, start time, end day, and/or end time associated with a named time range.

sp_modify_time_range name, startday, endday, starttime, endtime

sp_modifylogin

Modifies the default database, default language, default role activation, login script, full name, the password expiration interval, the minimum password length, and the maximum number of failed logins allowed for a specified Adaptive Server login account.

sp_modifylogin {loginame | “all overrides”}, option, value

sp_modifystats

Allows the System Administrator to modify the density values of a column—or columns—in sysstatistics

sp_modifystats [database].[owner].table_name,
	{“column_group” | “all”},
	MODIFY_DENSITY,
	{range | total},
	{absolute | factor},
	“value
sp_modifystats [database].[owner].table_name, 
	column_name,
	REMOVE_SKEW_FROM_DENSITY

sp_modifythreshold

Modifies a threshold by associating it with a different threshold procedure, free-space level, or segment name.

sp_modifythreshold dbname, segname, free_space
	[, new_proc_name] [, new_free_space] [, new_segname]

sp_monitor

Displays statistics about Adaptive Server.

sp_monitor [ connection, [cpu | diskio | elapsed time ] ]  
	[event, [spid ] ] [procedure, [ dbname, [ procname, 
	[, summary | detail ] ] ] ]  [ enable ] [ disable ] 
	[ statement, [ cpu | diskio | elapsed time ] ] [ help], 
	[ connection | statement | procedure | event ] ]

sp_monitorconfig

Displays cache usage statistics regarding metadata descriptors for indexes, objects, and databases, and reports statistics on auxiliary scan descriptors used for referential integrity queries and usage statistics for transaction descriptors and DTX participants.

sp_monitorconfig "configname" [ , “result_tbl_name”] [, “full”]

sp_object_stats

Shows lock contention, lock wait-time, and deadlock statistics for tables and indexes.

sp_object_stats interval [, top_n 
	[, dbname, objname [, rpt_option ]]]

sp_passthru

Component Integration Services only – allows the user to pass a SQL command buffer to a remote server.

sp_passthru server, command, errcode, errmsg, rowcount
	[, arg1, arg2, ... argn]

sp_password

Adds or changes a password for an Adaptive Server login account.

sp_password caller_passwd, new_passwd [, loginame, immediate]

sp_placeobject

Puts future space allocations for a table or index on a particular segment.

sp_placeobject segname, objname

sp_plan_dbccdb

Recommends suitable sizes for new dbccdb and dbccalt databases, lists suitable devices for dbccdb and dbccalt, and suggests a cache size and a suitable number of worker processes for the target database.

sp_plan_dbccdb [dbname]

sp_poolconfig

Creates, drops, resizes, and provides information about memory pools within data caches.

sp_poolconfig cache_name [, "mem_size [P|K|M|G]", "config_poolK" 
	[, "affected_poolK"]]
sp_poolconfig cache_name, "io_size ", "wash=size[P|K|M|G]"
sp_poolconfig cache_name, "io_size ", 
	"local async prefetch limit=percent "

sp_post_xpload

Checks and rebuilds indexes after a cross-platform load database where the endian types are different.

sp_post_xpload

sp_primarykey

Defines a primary key on a table or view.

sp_primarykey tabname, col1 [, col2, col3, ..., col8]

sp_processmail

Windows NT only – reads, processes, sends, and deletes messages in the Adaptive Server message inbox, using the sp_findnextmsg, xp_readmail, xp_sendmail, and xp_deletemail system extended stored procedures (ESPs).

sp_processmail [subject] [, originator [, dbuser
	[, dbname [, filetype [, separator]]]]]

sp_procxmode

Displays or changes the execution modes associated with stored procedures.

sp_procxmode [procname [, tranmode]]

sp_recompile

Causes each stored procedure and trigger that uses the named table to be recompiled the next time it runs.

sp_recompile objname

sp_remap

Remaps a stored procedure, trigger, rule, default, or view from releases later than 4.8 and prior to 10.0 to be compatible with releases 10.0 and later. Use sp_remap on pre-existing objects that the upgrade procedure failed to remap.

sp_remap objname

sp_remoteoption

Displays or changes remote login options.

sp_remoteoption [remoteserver [, loginame 
	[, remotename [, optname [, optvalue]]]]]

sp_remotesql

Component Integration Services only – establishes a connection to a remote server, passes a query buffer to the remote server from the client, and relays the results back to the client.

sp_remotesql server, query[, query2, ... , query254]

sp_rename

Changes the name of a user-created object or user-defined datatype in the current database.

sp_rename objname, newname [,“index” | “column”]

sp_rename_qpgroup

Renames an abstract plan group.

sp_rename_qpgroup old_name, new_name

sp_renamedb

Changes the name of a user database.

sp_renamedb dbname, newname

sp_reportstats

Reports statistics on system usage.

sp_reportstats [loginame]

sp_revokelogin

Windows NT only – revokes Adaptive Server roles and default permissions from Windows NT users and groups when Integrated Security mode or Mixed mode (with Named Pipes) is active.

sp_revokelogin {login_name | group_name}

sp_role

Grants or revokes roles to an Adaptive Server login account.

sp_role {"grant" | "revoke"}, rolename, loginame

sp_sendmsg

Sends a message to a User Datagram Protocol (UDP) port.

sp_sendmsg ip_address, port_number, message

sp_serveroption

Displays or changes remote server options.

sp_serveroption [server, optname, optvalue]

sp_set_qplan

Changes the text of the abstract plan of an existing plan without changing the associated query.

sp_set_qplan id, plan

sp_setlangalias

Assigns or changes the alias for an alternate language.

sp_setlangalias language, alias

sp_setpglockpromote

Sets or changes the lock promotion thresholds for a database, for a table, or for Adaptive Server.

sp_setpglockpromote {"database" | "table"}, objname, new_lwm, 
	new_hwm, new_pct
sp_setpglockpromote server, NULL, new_lwm, new_hwm, new_pct 

sp_setpsexe

Sets custom execution attributes for a session while the session is active.

sp_setpsexe spid, exeattr, value

sp_setrowlockpromote

Sets or changes row-lock promotion thresholds for a datarows-locked table, for all datarows-locked tables in a database, or for all datarows-locked tables on a server.

sp_setrowlockpromote "server", NULL, new_lwm, new_hwm, new_pct
sp_setrowlockpromote {"database" | "table"}, objname, new_lwm, 
	new_hwm, new_pct

sp_setsuspect_granularity

Displays or sets the recovery fault isolation mode for a user database, which governs how recovery behaves when it detects data corruption.

sp_setsuspect_granularity [dbname 
	[, "database" | "page" [, "read_only"]]]

sp_setsuspect_threshold

Displays or sets the maximum number of suspect pages that Adaptive Server allows in a database before marking the entire database suspect.

sp_setsuspect_threshold [dbname [, threshold]]

sp_showcontrolinfo

Displays information about engine group assignments, bound client applications, logins, and stored procedures.

sp_showcontrolinfo [object_type, object_name, spid ]

sp_showexeclass

Displays the execution class attributes and the engines in any engine group associated with the specified execution class.

sp_showexeclass [execlassname]

sp_showplan

Displays the showplan output for any user connection for the current SQL statement or for a previous statement in the same batch.

sp_showplan spid, batch_id output, context_id output, stmt_num output

sp_showpsexe

Displays execution class, current priority, and affinity for all client sessions running on Adaptive Server.

sp_showpsexe [spid]

sp_spaceused

Displays estimates of the number of rows, the number of data pages, the size of indexes, and the space used by a specified table or by all tables in the current database.

sp_spaceused [objname [,1] ]

sp_ssladmin

Adds, deletes, or displays a list of server certificates for Adaptive Server.

sp_ssladmin {[addcert, certificate_path [, password|NULL]] 
	[dropcert, certificate_path]
	[lscert] 
	[help]}
	[lsciphers]
	[setciphers, {"FIPS" | "Strong" | "Weak" | "All" 
		| quoted_list_of_ciphersuites}]

sp_syntax

Displays the syntax of Transact-SQL statements, system procedures, utilities, and other routines for Adaptive Server, depending on which products and corresponding sp_syntax scripts exist on your server.

sp_syntax word [, mod][, language]

sp_sysmon

Displays performance information.

sp_sysmon begin_sample
sp_sysmon interval [, noclear,[,section  [, applmon]]]
sp_sysmon { end_sample | interval } [, section [, applmon] ]
sp_sysmon { end_sample | interval } [, applmon ]

sp_tempdb

Allows users to create the default temporary database group, bind temporary databases to the default temporary database group, and bind users and applications to the default temporary database group or to specific temporary databases

sp_tempdb [
	[ { “create” | “drop” } , “groupname” ] | 
	[ { “add” | “remove” } , “tempdbname”, “groupname” ] | 
	[ { “bind”, ““objtype”, “objname”, “bindtype”, “bindobj” 
		[, “scope”, “hardness” ] } | 
		{ “unbind”, “objtype”, “objname” [, “scope” ] } ] | 
	[ “unbindall_db”, “tempdbname” ] | 
	[ show [, "all" | "gr" | "db" | "login" | "app" [, “name” ] ] | 
	[ who, “dbname” ] 
	[ help ] ]

sp_thresholdaction

Executes automatically when the number of free pages on the log segment falls below the last-chance threshold, unless the threshold is associated with a different procedure. Sybase does not provide this procedure.

sp_thresholdaction @dbname,
	@segment_name,
	@space_left,
	@status

sp_transactions

Reports information about active transactions.

sp_tranactions ["xid", xid_value] | 
	["state", {"heuristic_commit" | "heuristic_abort" 
	| "prepared" | "indoubt"} [, "xactname"]] |
	["gtrid", gtrid_value]

sp_unbindcache

Unbinds a database, table, index, text object, or image object from a data cache.

sp_unbindcache dbname [,[owner.]tablename 
	[, indexname | "text only"]] 

sp_unbindcache_all

Unbinds all objects that are bound to a cache.

sp_unbindcache_all cache_name

sp_unbindefault

Unbinds a created default value from a column or from a user-defined datatype.

sp_unbindefault objname [, futureonly]

sp_unbindexeclass

Removes the execution class attribute previously associated with an client application, login, or stored procedure for the specified scope.

sp_unbindexeclass object_name, object_type, scope

sp_unbindmsg

Unbinds a user-defined message from a constraint.

sp_unbindmsg constrname

sp_unbindrule

Unbinds a rule from a column or from a user-defined datatype.

sp_unbindrule objname [, futureonly [, “accessrule” | “all”]]

sp_version

Returns the version information of the installation scripts that was last run and whether it was successful.

sp_version [script_file, [all]]

sp_volchanged

Notifies the Backup Server that the operator performed the requested volume handling during a dump or load.

sp_volchanged session_id, devname, action
	[, fname [, vname]]

sp_who

Reports information about all current Adaptive Server users and processes or about a particular user or process.

sp_who [loginame | "spid"]




Copyright © 2005. Sybase Inc. All rights reserved. Catalog stored procedures

View this book as PDF