Системные хранимые процедуры (Transact-SQL)

Область применения: SQL Server 2016 (13.x) и более поздних версий База данных SQL Azure Управляемый экземпляр SQL Azure

В SQL Server многие административные и информационные действия можно выполнять с помощью системных хранимых процедур. Системные хранимые процедуры объединяются в категории, перечисленные в следующей таблице.

В этом разделе

Категория	Описание
Активные Geo-Replication хранимые процедуры	Используется для управления конфигурациями активных Geo-Replication в базе данных Azure SQL
Хранимые процедуры для работы с каталогом	Используются для реализации функций словаря данных ODBC и изоляции ODBC-приложений от изменений во внутренних системных таблицах.
Хранимые процедуры системы отслеживания измененных данных	Используются для включения, отключения или подготовки отчетов об объектах системы отслеживания измененных данных.
Хранимые процедуры для работы с курсорами	Используются для реализации переменной функциональности курсоров.
Хранимые процедуры сборщика данных	Используется для работы со сборщиком данных и следующими компонентами: наборами элементов сбора, элементами коллекций и типами коллекций.
Хранимые процедуры для работы с ядром СУБД	Используется для общего обслуживания ядра СУБД SQL Server.
Хранимые процедуры Database Mail (Transact-SQL)	Используется для выполнения операций электронной почты из экземпляра SQL Server.
Хранимые процедуры для работы с планами обслуживания базы данных	Используются для выполнения основных задач, необходимых для управления производительностью базы данных.
Хранимые процедуры распределенных запросов	Используются для реализации распределенных запросов и управления ими.
Хранимые процедуры Filestream и FileTable (Transact-SQL)	Используется для настройки и управления функциями FILESTREAM и FileTable.
Хранимые процедуры правил брандмауэра (база данных Azure SQL)	Используется для настройки брандмауэра базы данных Azure SQL.
Хранимые процедуры для работы с полнотекстовым поиском	Используются для создания полнотекстовых индексов и запросов к ним.
Общие расширенные хранимые процедуры	Используется для предоставления интерфейса из экземпляра SQL Server во внешние программы для различных действий по обслуживанию.
Хранимые процедуры для работы с доставкой журналов	Используются для создания, изменения и отслеживания конфигураций доставки журналов.
Хранимые процедуры хранилища данных управления (Transact-SQL)	Используется для настройки хранилища данных управления.
Хранимые процедуры ole-автоматизации	Используется для включения стандартных объектов автоматизации для использования в стандартном пакете Transact-SQL.
Хранимые процедуры управления на основе политики	Используется для управления на основе политики.
Хранимые процедуры PolyBase	Добавление или удаление компьютера из масштабируемой группы PolyBase.
Хранимые процедуры хранилища запросов (Transact-SQL)	Используется для настройки производительности.
Хранимые процедуры репликации	Используются для управления репликацией.
Хранимые процедуры для обеспечения безопасности	Используются для управления безопасностью.
Хранимые процедуры резервного копирования моментальных снимков	Используется для удаления FILE_SNAPSHOT резервной копии вместе со всеми ее моментальными снимками или для удаления отдельного моментального снимка файла резервной копии.
Хранимые процедуры пространственного индекса	Используется для анализа и повышения производительности пространственных индексов.
Хранимые процедуры для работы с агентом SQL Server	Используется SQL Server Profiler для мониторинга производительности и активности.
Хранимые процедуры для работы с приложением SQL Server Profiler	Используется агент SQL Server для управления запланированными и управляемыми событиями действиями.
Хранимые процедуры Stretch Database	Используется для управления базами данных Stretch.
Хранимые процедуры темпоральных таблиц	Используется для темпоральных таблиц
Хранимые процедуры для работы с XML	Используются для работы с текстом в формате XML.

Примечание

Если не оговорено другое, все системные хранимые процедуры возвращают значение 0, что означает успешное выполнение процедуры. Для сигнализации об ошибке возвращается ненулевое значение.

Важно!

Службу Stretch Database не рекомендуется использовать в SQL Server 2022 (16.x). В будущей версии Microsoft SQL Server этот компонент будет удален. Избегайте использования этого компонента в новых разработках и запланируйте изменение существующих приложений, в которых он применяется.

Системные хранимые процедуры для работы с API

Пользователи, выполняющие SQL Server Profiler в приложениях ADO, OLE DB и ODBC, могут заметить, что эти приложения используют системные хранимые процедуры, которые не рассматриваются в справочнике по Transact-SQL. Эти хранимые процедуры используются поставщиком OLE DB microsoft SQL Server Native Client и драйвером ODBC SQL Server Native Client для реализации функциональных возможностей API базы данных. Эти хранимые процедуры — это просто механизм, используемый поставщиком или драйвером для передачи запросов пользователей экземпляру SQL Server. Они предназначены только для внутреннего использования поставщиком или драйвером. Явный вызов из приложения на основе SQL Server не поддерживается.

Хранимые процедуры sp_createorphan и sp_droporphans используются для обработки ntext, текста и изображений ODBC.

Хранимая процедура sp_reset_connection используется SQL Server для поддержки удаленных вызовов хранимых процедур в транзакции. Кроме того, эта хранимая процедура инициирует события Audit Login и Audit Logout при повторном использовании соединения из пула соединений.

Системные хранимые процедуры в следующих таблицах используются только в экземпляре SQL Server или через клиентские API и не предназначены для общего использования клиентами. Они подвержены изменению, и совместимость не гарантируется.

Следующие хранимые процедуры описаны в электронной документации по SQL Server:

sp_catalogs

sp_column_privileges, хранимая процедура

sp_column_privileges_ex

sp_columns

sp_columns_ex

sp_databases

sp_cursor

sp_cursorclose

sp_cursorexecute

sp_cursorfetch

sp_cursoroption

sp_cursoropen

sp_cursorprepare

sp_cursorprepexec

sp_cursorunprepare

sp_execute

sp_datatype_info

sp_fkeys

sp_foreignkeys

sp_indexes

sp_pkeys, хранимая процедура

sp_primarykeys

sp_prepare

sp_prepexec

sp_prepexecrpc

sp_unprepare

sp_server_info

sp_special_columns

sp_sproc_columns

sp_statistics

sp_table_privileges

sp_table_privileges_ex

sp_tables

sp_tables_ex

 

Следующие хранимые процедуры в документации не описаны:

sp_assemblies_rowset

sp_assemblies_rowset_rmt

sp_assemblies_rowset2

sp_assembly_dependencies_rowset

sp_assembly_dependencies_rowset_rmt

sp_assembly_dependencies_rowset2

sp_bcp_dbcmptlevel

sp_catalogs_rowset

sp_catalogs_rowset;2

sp_catalogs_rowset;5

sp_catalogs_rowset_rmt

sp_catalogs_rowset2

sp_check_constbytable_rowset

sp_check_constbytable_rowset;2

sp_check_constbytable_rowset2

sp_check_constraints_rowset

sp_check_constraints_rowset;2

sp_check_constraints_rowset2

sp_column_privileges_rowset

sp_column_privileges_rowset;2

sp_column_privileges_rowset;5

sp_column_privileges_rowset_rmt

sp_column_privileges_rowset2

sp_columns_90

sp_columns_90_rowset

sp_columns_90_rowset_rmt

sp_columns_90_rowset2

sp_columns_ex_90

sp_columns_rowset

sp_columns_rowset;2

sp_columns_rowset;5

sp_columns_rowset_rmt

sp_columns_rowset2

sp_constr_col_usage_rowset

sp_datatype_info_90

sp_ddopen;1

sp_ddopen;10

sp_ddopen;11

sp_ddopen;12

sp_ddopen;13

sp_ddopen;2

sp_ddopen;3

sp_ddopen;4

sp_ddopen;5

sp_ddopen;6

sp_ddopen;7

sp_ddopen;8

sp_ddopen;9

sp_foreign_keys_rowset

sp_foreign_keys_rowset;2

sp_foreign_keys_rowset;3

sp_foreign_keys_rowset;5

sp_foreign_keys_rowset_rmt

sp_foreign_keys_rowset2

sp_foreign_keys_rowset3

sp_indexes_90_rowset

sp_indexes_90_rowset_rmt

sp_indexes_90_rowset2

sp_indexes_rowset

sp_indexes_rowset;2

sp_indexes_rowset;5

sp_indexes_rowset_rmt

sp_indexes_rowset2

sp_linkedservers_rowset

sp_linkedservers_rowset;2

sp_linkedservers_rowset2

sp_oledb_database

sp_oledb_defdb

sp_oledb_deflang

sp_oledb_language

sp_oledb_ro_usrname

sp_primary_keys_rowset

sp_primary_keys_rowset;2

sp_primary_keys_rowset;3

sp_primary_keys_rowset;5

sp_primary_keys_rowset_rmt

sp_primary_keys_rowset2

sp_procedure_params_90_rowset

sp_procedure_params_90_rowset2

sp_procedure_params_rowset

sp_procedure_params_rowset;2

sp_procedure_params_rowset2

sp_procedures_rowset

sp_procedures_rowset;2

sp_procedures_rowset2

sp_provider_types_90_rowset

sp_provider_types_rowset

sp_schemata_rowset

sp_schemata_rowset;3

sp_special_columns_90

sp_sproc_columns_90

sp_statistics_rowset

sp_statistics_rowset;2

sp_statistics_rowset2

sp_stored_procedures

sp_table_constraints_rowset

sp_table_constraints_rowset;2

sp_table_constraints_rowset2

sp_table_privileges_rowset

sp_table_privileges_rowset;2

sp_table_privileges_rowset;5

sp_table_privileges_rowset_rmt

sp_table_privileges_rowset2

sp_table_statistics_rowset

sp_table_statistics_rowset;2

sp_table_statistics2_rowset

sp_tablecollations

sp_tablecollations_90

sp_tables_info_90_rowset

sp_tables_info_90_rowset_64

sp_tables_info_90_rowset2

sp_tables_info_90_rowset2_64

sp_tables_info_rowset

sp_tables_info_rowset;2

sp_tables_info_rowset_64

sp_tables_info_rowset_64;2

sp_tables_info_rowset2

sp_tables_info_rowset2_64

sp_tables_rowset;2

sp_tables_rowset;5

sp_tables_rowset_rmt

sp_tables_rowset2

sp_usertypes_rowset

sp_usertypes_rowset_rmt

sp_usertypes_rowset2

sp_views_rowset

sp_views_rowset2

sp_xml_schema_rowset

sp_xml_schema_rowset2

См. также:

CREATE PROCEDURE (Transact-SQL)
Хранимые процедуры (компонент Database Engine)
Выполнение хранимых процедур (OLE DB)
Выполнение хранимых процедур
Хранимые процедуры ядра СУБД (Transact-SQL)
Выполнение хранимых процедур