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

ОБЛАСТЬ ПРИМЕНЕНИЯ:даSQL Server (начиная с 2016)даБаза данных SQL AzureдаХранилище данных SQL AzureнетParallel Data WarehouseAPPLIES TO: yesSQL Server (starting with 2016) yesAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

В SQL Server 2017SQL Server 2017 многие задачи администрирования и сбора информации можно выполнять с помощью системных хранимых процедур.In SQL Server 2017SQL Server 2017, many administrative and informational activities can be performed by using system stored procedures. Системные хранимые процедуры объединяются в категории, перечисленные в следующей таблице.The system stored procedures are grouped into the categories shown in the following table.

в этом разделеIn This Section

КатегорияCategory ОписаниеDescription
Активная Георепликация хранимых процедурActive Geo-Replication Stored Procedures Используется для управления для управления конфигурациями активной Георепликации в базе данных SQL AzureUsed to manage to manage Active Geo-Replication configurations in Azure SQL Database
Хранимые процедуры каталогаCatalog Stored Procedures Используются для реализации функций словаря данных ODBC и изоляции ODBC-приложений от изменений во внутренних системных таблицах.Used to implement ODBC data dictionary functions and isolate ODBC applications from changes to underlying system tables.
Хранимые процедуры системы отслеживания измененных данныхChange Data Capture Stored Procedures Используются для включения, отключения или подготовки отчетов об объектах системы отслеживания измененных данных.Used to enable, disable, or report on change data capture objects.
Хранимые процедуры курсораCursor Stored Procedures Используются для реализации переменной функциональности курсоров.Used to implements cursor variable functionality.
Хранимые процедуры сборщика данныхData Collector Stored Procedures Используется для работы со сборщиком данных и следующими компонентами: наборами элементов сбора, элементами коллекций и типами коллекций.Used to work with the data collector and the following components: collection sets, collection items, and collection types.
Хранимым процедурам ядра СУБДDatabase Engine Stored Procedures Используются для выполнения общих задач по обслуживанию компонента Компонент SQL Server Database EngineSQL Server Database Engine.Used for general maintenance of the Компонент SQL Server Database EngineSQL Server Database Engine.
Хранимые процедуры Database Mail (Transact-SQL)Database Mail Stored Procedures (Transact-SQL) Используются для работы с электронной почтой в пределах экземпляра SQL ServerSQL Server.Used to perform e-mail operations from within an instance of SQL ServerSQL Server.
Хранимые процедуры плана обслуживания базы данныхDatabase Maintenance Plan Stored Procedures Используются для выполнения основных задач, необходимых для управления производительностью базы данных.Used to set up core maintenance tasks that are required to manage database performance.
Хранимые процедуры распределенных запросовDistributed Queries Stored Procedures Используются для реализации распределенных запросов и управления ими.Used to implement and manage distributed queries.
FileStream и хранимые процедуры FileTable (Transact-SQL)Filestream and FileTable Stored Procedures (Transact-SQL) Используется для настройки и управления функциями FILESTREAM и FileTable.Used to configure and manage the FILESTREAM and FileTable features.
Хранимые процедуры правил брандмауэра (база данных Azure SQL)Firewall Rules Stored Procedures (Azure SQL Database) Используется для настройки брандмауэра базы данных SQL Azure.Used to configure the Azure SQL Database firewall.
Компонент Full-Text Search хранимых процедурFull-Text Search Stored Procedures Используются для создания полнотекстовых индексов и запросов к ним.Used to implement and query full-text indexes.
Общие расширенные хранимые процедурыGeneral Extended Stored Procedures Используются, чтобы предоставить внешним программам интерфейс к экземпляру SQL ServerSQL Server для выполнения различных задач обслуживания.Used to provide an interface from an instance of SQL ServerSQL Server to external programs for various maintenance activities.
Доставка журналов хранимых процедурLog Shipping Stored Procedures Используются для создания, изменения и отслеживания конфигураций доставки журналов.Used to configure, modify, and monitor log shipping configurations.
Хранимые процедуры хранилища данных управления (Transact-SQL)Management Data Warehouse Stored Procedures (Transact-SQL) Используется для настройки хранилища данных управления.Used to configure the management data warehouse.
OLE Automation хранимых процедурOLE Automation Stored Procedures Используются, чтобы включить стандартные объекты OLE-автоматизации использования в стандартном пакете Transact-SQLTransact-SQL.Used to enable standard Automation objects for use within a standard Transact-SQLTransact-SQL batch.
Хранимые процедуры управления на основе политикPolicy-Based Management Stored Procedures Используется для управления на основе политики.Used for Policy-Based Management.
Хранимые процедуры PolyBasePolyBase stored procedures Добавление или удаление компьютера из группы горизонтального масштабирования PolyBase.Add or remove a computer from a PolyBase scale-out group.
Query Store хранимых процедур (Transact-SQL)Query Store Stored Procedures (Transact-SQL) Используется для настройки производительности.Used to tune performance.
Хранимые процедуры репликацииReplication Stored Procedures Используются для управления репликацией.Used to manage replication.
Безопасность хранимых процедурSecurity Stored Procedures Используются для управления безопасностью.Used to manage security.
Моментальный снимок резервной копии хранимых процедурSnapshot Backup Stored Procedures Используется для удаления резервной копии FILE_SNAPSHOT, а также все его моментальные снимки или удаления отдельных файла резервной копии моментальных снимков.Used to delete the FILE_SNAPSHOT backup along with all of its snapshots or to delete an individual backup file snapshot.
Хранимые процедуры пространственного индексаSpatial Index Stored Procedures Используется для анализа и улучшения производительности индексирования пространственных индексов.Used to analyze and improve the indexing performance of spatial indexes.
Агент SQL Server хранимых процедурSQL Server Agent Stored Procedures Используются приложением Приложение SQL Server ProfilerSQL Server Profiler для наблюдения за производительностью и активностью.Used by Приложение SQL Server ProfilerSQL Server Profiler to monitor performance and activity.
SQL Server Profiler хранимых процедурSQL Server Profiler Stored Procedures Используются агентом SQL ServerSQL Server для управления запланированных или зависящих от событий действий.Used by SQL ServerSQL Server Agent to manage scheduled and event-driven activities.
Stretch Database хранимых процедурStretch Database Stored Procedures Используется для управления базами данных stretch.Used to manage stretch databases.
Темпоральные таблицы хранимых процедурTemporal Tables Stored Procedures Используйте для темпоральных таблицUse for temporal tables
Хранимые процедуры XMLXML Stored Procedures Используются для работы с текстом в формате XML.Used for XML text management.

Примечание

Если не оговорено другое, все системные хранимые процедуры возвращают значение 0, что означает успешное выполнение процедуры.Unless specifically documented otherwise, all system stored procedures return a value of 0 to indicate success. Для сигнализации об ошибке возвращается ненулевое значение.To indicate failure, a nonzero value is returned.

Системные хранимые процедуры для работы с APIAPI System Stored Procedures

Пользователи, запускающие приложение Приложение SQL Server ProfilerSQL Server Profiler для приложений ADO, OLE DB и ODBC, могут заметить, что эти приложения используют системные хранимые процедуры, не описанные в справочнике по Transact-SQLTransact-SQL.Users that run Приложение SQL Server ProfilerSQL Server Profiler against ADO, OLE DB, and ODBC applications may notice these applications using system stored procedures that are not covered in the Transact-SQLTransact-SQL Reference. Эти хранимые процедуры используются MicrosoftMicrosoft SQL ServerSQL Server собственный поставщик OLE DB клиента и SQL ServerSQL Server драйвер ODBC собственного клиента для реализации функциональности API базы данных.These stored procedures are used by the MicrosoftMicrosoft SQL ServerSQL Server Native Client OLE DB Provider and the SQL ServerSQL Server Native Client ODBC driver to implement the functionality of a database API. Эти хранимые процедуры — всего лишь механизм, задействованный поставщиком или драйвером для передачи запросов пользователя экземпляру SQL ServerSQL Server.These stored procedures are just the mechanism the provider or driver uses to communicate user requests to an instance of SQL ServerSQL Server. Они предназначены только для внутреннего использования поставщиком или драйвером.They are intended only for the internal use of the provider or the driver. Вызывать их явным образом из SQL ServerSQL Server-приложения на основе не поддерживается.Calling them explicitly from a SQL ServerSQL Server-based application is not supported.

Sp_createorphan и sp_droporphans хранимые процедуры используются для ODBC ntext, текст, и изображение обработки.The sp_createorphan and sp_droporphans stored procedures are used for ODBC ntext, text, and image processing.

Хранимая процедура sp_reset_connection используется SQL ServerSQL Server для поддержки вызовов в транзакциях удаленных хранимых процедур.The sp_reset_connection stored procedure is used by SQL ServerSQL Server to support remote stored procedure calls in a transaction. Кроме того, эта хранимая процедура инициирует события Audit Login и Audit Logout при повторном использовании соединения из пула соединений.This stored procedure also causes Audit Login and Audit Logout events to fire when a connection is reused from a connection pool.

Системные хранимые процедуры в следующих таблицах используются внутри экземпляра SQL ServerSQL Server или через клиентские API и не предназначены для общего пользования.The system stored procedures in the following tables are used only within an instance of SQL ServerSQL Server or through client APIs and are not intended for general customer use. Они подвержены изменению, и совместимость не гарантируется.They are subject to change and compatibility is not guaranteed.

Следующие хранимые процедуры описаны в электронной документации по SQL ServerSQL Server:The following stored procedures are documented in SQL ServerSQL Server Books Online:

sp_catalogssp_catalogs sp_column_privileges, хранимая процедураsp_column_privileges
sp_column_privileges_exsp_column_privileges_ex sp_columnssp_columns
sp_columns_exsp_columns_ex sp_databasessp_databases
sp_cursorsp_cursor sp_cursorclosesp_cursorclose
sp_cursorexecutesp_cursorexecute sp_cursorfetchsp_cursorfetch
sp_cursoroptionsp_cursoroption sp_cursoropensp_cursoropen
sp_cursorpreparesp_cursorprepare sp_cursorprepexecsp_cursorprepexec
sp_cursorunpreparesp_cursorunprepare sp_executesp_execute
sp_datatype_infosp_datatype_info sp_fkeyssp_fkeys
sp_foreignkeyssp_foreignkeys sp_indexessp_indexes
sp_pkeys, хранимая процедураsp_pkeys sp_primarykeyssp_primarykeys
sp_preparesp_prepare sp_prepexecsp_prepexec
sp_prepexecrpcsp_prepexecrpc sp_unpreparesp_unprepare
sp_server_infosp_server_info sp_special_columnssp_special_columns
sp_sproc_columnssp_sproc_columns sp_statisticssp_statistics
sp_table_privilegessp_table_privileges sp_table_privileges_exsp_table_privileges_ex
sp_tablessp_tables sp_tables_exsp_tables_ex

Следующие хранимые процедуры в документации не описаны:The following stored procedures are not documented:

sp_assemblies_rowsetsp_assemblies_rowset sp_assemblies_rowset_rmtsp_assemblies_rowset_rmt
sp_assemblies_rowset2sp_assemblies_rowset2 sp_assembly_dependencies_rowsetsp_assembly_dependencies_rowset
sp_assembly_dependencies_rowset_rmtsp_assembly_dependencies_rowset_rmt sp_assembly_dependencies_rowset2sp_assembly_dependencies_rowset2
sp_bcp_dbcmptlevelsp_bcp_dbcmptlevel sp_catalogs_rowsetsp_catalogs_rowset
sp_catalogs_rowset;2sp_catalogs_rowset;2 sp_catalogs_rowset;5sp_catalogs_rowset;5
sp_catalogs_rowset_rmtsp_catalogs_rowset_rmt sp_catalogs_rowset2sp_catalogs_rowset2
sp_check_constbytable_rowsetsp_check_constbytable_rowset sp_check_constbytable_rowset;2sp_check_constbytable_rowset;2
sp_check_constbytable_rowset2sp_check_constbytable_rowset2 sp_check_constraints_rowsetsp_check_constraints_rowset
sp_check_constraints_rowset;2sp_check_constraints_rowset;2 sp_check_constraints_rowset2sp_check_constraints_rowset2
sp_column_privileges_rowsetsp_column_privileges_rowset sp_column_privileges_rowset;2sp_column_privileges_rowset;2
sp_column_privileges_rowset;5sp_column_privileges_rowset;5 sp_column_privileges_rowset_rmtsp_column_privileges_rowset_rmt
sp_column_privileges_rowset2sp_column_privileges_rowset2 sp_columns_90sp_columns_90
sp_columns_90_rowsetsp_columns_90_rowset sp_columns_90_rowset_rmtsp_columns_90_rowset_rmt
sp_columns_90_rowset2sp_columns_90_rowset2 sp_columns_ex_90sp_columns_ex_90
sp_columns_rowsetsp_columns_rowset sp_columns_rowset;2sp_columns_rowset;2
sp_columns_rowset;5sp_columns_rowset;5 sp_columns_rowset_rmtsp_columns_rowset_rmt
sp_columns_rowset2sp_columns_rowset2 sp_constr_col_usage_rowsetsp_constr_col_usage_rowset
sp_datatype_info_90sp_datatype_info_90 sp_ddopen;1sp_ddopen;1
sp_ddopen;10sp_ddopen;10 sp_ddopen;11sp_ddopen;11
sp_ddopen;12sp_ddopen;12 sp_ddopen;13sp_ddopen;13
sp_ddopen;2sp_ddopen;2 sp_ddopen;3sp_ddopen;3
sp_ddopen;4sp_ddopen;4 sp_ddopen;5sp_ddopen;5
sp_ddopen;6sp_ddopen;6 sp_ddopen;7sp_ddopen;7
sp_ddopen;8sp_ddopen;8 sp_ddopen;9sp_ddopen;9
sp_foreign_keys_rowsetsp_foreign_keys_rowset sp_foreign_keys_rowset;2sp_foreign_keys_rowset;2
sp_foreign_keys_rowset;3sp_foreign_keys_rowset;3 sp_foreign_keys_rowset;5sp_foreign_keys_rowset;5
sp_foreign_keys_rowset_rmtsp_foreign_keys_rowset_rmt sp_foreign_keys_rowset2sp_foreign_keys_rowset2
sp_foreign_keys_rowset3sp_foreign_keys_rowset3 sp_indexes_90_rowsetsp_indexes_90_rowset
sp_indexes_90_rowset_rmtsp_indexes_90_rowset_rmt sp_indexes_90_rowset2sp_indexes_90_rowset2
sp_indexes_rowsetsp_indexes_rowset sp_indexes_rowset;2sp_indexes_rowset;2
sp_indexes_rowset;5sp_indexes_rowset;5 sp_indexes_rowset_rmtsp_indexes_rowset_rmt
sp_indexes_rowset2sp_indexes_rowset2 sp_linkedservers_rowsetsp_linkedservers_rowset
sp_linkedservers_rowset;2sp_linkedservers_rowset;2 sp_linkedservers_rowset2sp_linkedservers_rowset2
sp_oledb_databasesp_oledb_database sp_oledb_defdbsp_oledb_defdb
sp_oledb_deflangsp_oledb_deflang sp_oledb_languagesp_oledb_language
sp_oledb_ro_usrnamesp_oledb_ro_usrname sp_primary_keys_rowsetsp_primary_keys_rowset
sp_primary_keys_rowset;2sp_primary_keys_rowset;2 sp_primary_keys_rowset;3sp_primary_keys_rowset;3
sp_primary_keys_rowset;5sp_primary_keys_rowset;5 sp_primary_keys_rowset_rmtsp_primary_keys_rowset_rmt
sp_primary_keys_rowset2sp_primary_keys_rowset2 sp_procedure_params_90_rowsetsp_procedure_params_90_rowset
sp_procedure_params_90_rowset2sp_procedure_params_90_rowset2 sp_procedure_params_rowsetsp_procedure_params_rowset
sp_procedure_params_rowset;2sp_procedure_params_rowset;2 sp_procedure_params_rowset2sp_procedure_params_rowset2
sp_procedures_rowsetsp_procedures_rowset sp_procedures_rowset;2sp_procedures_rowset;2
sp_procedures_rowset2sp_procedures_rowset2 sp_provider_types_90_rowsetsp_provider_types_90_rowset
sp_provider_types_rowsetsp_provider_types_rowset sp_schemata_rowsetsp_schemata_rowset
sp_schemata_rowset;3sp_schemata_rowset;3 sp_special_columns_90sp_special_columns_90
sp_sproc_columns_90sp_sproc_columns_90 sp_statistics_rowsetsp_statistics_rowset
sp_statistics_rowset;2sp_statistics_rowset;2 sp_statistics_rowset2sp_statistics_rowset2
sp_stored_proceduressp_stored_procedures sp_table_constraints_rowsetsp_table_constraints_rowset
sp_table_constraints_rowset;2sp_table_constraints_rowset;2 sp_table_constraints_rowset2sp_table_constraints_rowset2
sp_table_privileges_rowsetsp_table_privileges_rowset sp_table_privileges_rowset;2sp_table_privileges_rowset;2
sp_table_privileges_rowset;5sp_table_privileges_rowset;5 sp_table_privileges_rowset_rmtsp_table_privileges_rowset_rmt
sp_table_privileges_rowset2sp_table_privileges_rowset2 sp_table_statistics_rowsetsp_table_statistics_rowset
sp_table_statistics_rowset;2sp_table_statistics_rowset;2 sp_table_statistics2_rowsetsp_table_statistics2_rowset
sp_tablecollationssp_tablecollations sp_tablecollations_90sp_tablecollations_90
sp_tables_info_90_rowsetsp_tables_info_90_rowset sp_tables_info_90_rowset_64sp_tables_info_90_rowset_64
sp_tables_info_90_rowset2sp_tables_info_90_rowset2 sp_tables_info_90_rowset2_64sp_tables_info_90_rowset2_64
sp_tables_info_rowsetsp_tables_info_rowset sp_tables_info_rowset;2sp_tables_info_rowset;2
sp_tables_info_rowset_64sp_tables_info_rowset_64 sp_tables_info_rowset_64;2sp_tables_info_rowset_64;2
sp_tables_info_rowset2sp_tables_info_rowset2 sp_tables_info_rowset2_64sp_tables_info_rowset2_64
sp_tables_rowset;2sp_tables_rowset;2 sp_tables_rowset;5sp_tables_rowset;5
sp_tables_rowset_rmtsp_tables_rowset_rmt sp_tables_rowset2sp_tables_rowset2
sp_usertypes_rowsetsp_usertypes_rowset sp_usertypes_rowset_rmtsp_usertypes_rowset_rmt
sp_usertypes_rowset2sp_usertypes_rowset2 sp_views_rowsetsp_views_rowset
sp_views_rowset2sp_views_rowset2 sp_xml_schema_rowsetsp_xml_schema_rowset
sp_xml_schema_rowset2sp_xml_schema_rowset2

См. такжеSee Also

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