システム ストアド プロシージャ (Transact-SQL)System Stored Procedures (Transact-SQL)

適用対象: ○SQL Server (2016 以降) ○Azure SQL Database XAzure SQL Data Warehouse XParallel Data Warehouse APPLIES 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
アクティブ Geo レプリケーションのストアド プロシージャActive Geo-Replication Stored Procedures Azure SQL データベースでのアクティブ Geo レプリケーションの構成を管理する管理に使用します。Used 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 データベース エンジンSQL Server Database Engineの全般的なメンテナンスに使用します。Used for general maintenance of the SQL Server データベース エンジンSQL Server Database Engine.
データベース メール ストアド プロシージャ(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 Database)Firewall Rules Stored Procedures (Azure SQL Database) Azure SQL データベース ファイアウォールを構成するために使用します。Used to configure the Azure SQL Database firewall.
フルテキスト検索ストアド プロシージャ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 オートメーション ストアド プロシージャOLE Automation Stored Procedures 標準の 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.
PolyBase ストアド プロシージャPolyBase stored procedures 追加または PolyBase スケール アウトのグループからコンピューターを削除します。Add or remove a computer from a PolyBase scale-out group.
クエリ ストアのストアド プロシージャ(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 プロファイラーSQL Server Profiler で、パフォーマンスと利用状況の監視に使用します。Used by SQL Server プロファイラーSQL 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 拡大のデータベースの管理に使用されます。Used to manage stretch databases.
テンポラル テーブルはストアド プロシージャTemporal Tables Stored Procedures 一時的なテーブルの使用Use for temporal tables
XML ストアド プロシージャXML 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. 失敗した場合は、0 以外の値が返されます。To indicate failure, a nonzero value is returned.

API システム ストアド プロシージャAPI System Stored Procedures

ADO、OLE DB、ODBC アプリケーションに対して SQL Server プロファイラーSQL Server Profiler を実行する場合に、これらのアプリケーションで、Transact-SQLTransact-SQL リファレンスにないシステム ストアド プロシージャが使用されていることがあります。Users that run SQL Server プロファイラーSQL 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 Native Client OLE DB プロバイダーとSQL ServerSQL Serverデータベース API の機能を実装するために Native Client ODBC ドライバー。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_privilegessp_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_pkeyssp_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