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

適用対象: SQL Server 2016 (13.x) 以降 Azure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsMicrosoft Fabric の SQL 分析エンドポイントMicrosoft Fabric のウェアハウス

SQL Server では、システム ストアド プロシージャを使用して、多くの管理および情報アクティビティを実行できます。 システム ストアド プロシージャは、次の表に示すカテゴリに分類されます。

このセクションの内容

カテゴリ 説明
アクティブ geo レプリケーション ストアド プロシージャ Azure SQL Database でアクティブ geo レプリケーション構成を管理するために使用されます
カタログ ストアド プロシージャ ODBC データ ディクショナリ関数を実装し、基になるシステム テーブルへの変更から ODBC アプリケーションを分離するために使用します。
Change Data Capture ストアド プロシージャ 変更データ キャプチャ オブジェクトの有効化、無効化、またはレポートに使用されます。
カーソル ストアド プロシージャ カーソル変数の機能を実装するために使用されます。
データ コレクター ストアド プロシージャ データ コレクターと、コレクション セット、コレクション項目、コレクション型のコンポーネントを操作するために使用されます。
ストアド プロシージャのデータベース エンジン SQL Server データベース エンジンの一般的なメインテナントに使用されます。
ストアド プロシージャのデータベース メール SQL Server のインスタンス内から電子メール操作を実行するために使用されます。
データベース メンテナンス プランのストアド プロシージャ データベースのパフォーマンスの管理に必要な基本のメンテナンス タスクを設定する場合に使用します。
分散クエリ ストアド プロシージャ 分散クエリの実装と管理に使用されます。
FILESTREAM ストアド プロシージャと FileTable ストアド プロシージャ FILESTREAM 機能および FileTable 機能の構成と管理に使用します。
ファイアウォール規則ストアド プロシージャ (Azure SQL Database) Azure SQL Database ファイアウォールの構成に使用されます。
フルテキスト検索ストアド プロシージャ フルテキスト インデックスの実装とクエリに使用されます。
一般的な拡張ストアド プロシージャ SQL Server のインスタンスから、さまざまなメインテナント アクティビティ用の外部プログラムへのインターフェイスを提供するために使用されます。
ログ配布ストアド プロシージャ ログ配布構成の構成、変更、監視に使用されます。
管理データ ウェアハウスのストアド プロシージャ 管理データ ウェアハウスの構成に使用されます。
MSDTC ストアド プロシージャ Microsoft 分散トランザクション コーディネーター (MSDTC) ログをリセットしたり、MSDTC 統計を確認したりするために使用します。
OLE オートメーション ストアド プロシージャ 標準の Transact-SQL バッチ内で使用する標準の Automation オブジェクトを有効にするために使用されます。
ポリシー ベースの管理ストアド プロシージャ ポリシー ベースの管理に使用します。
PolyBase ストアド プロシージャ PolyBase スケールアウト グループからコンピューターを追加または削除します。
ストアド プロシージャのクエリ ストア パフォーマンスを調整するために使用されます。
レプリケーション ストアド プロシージャ レプリケーションの管理に使用されます。
セキュリティ ストアド プロシージャ セキュリティの管理に使用されます。
スナップショット バックアップ ストアド プロシージャ FILE_SNAPSHOT バックアップとそのすべてのスナップショットを削除したり、個々のバックアップ ファイルスナップショットを削除したりするために使用されます。
空間インデックス ストアド プロシージャ 空間インデックスのインデックス作成パフォーマンスを分析および向上させるために使用されます。
ストアド プロシージャのSQL Server エージェント パフォーマンスとアクティビティを監視するためにSQL Server プロファイラーによって使用されます。
ストアド プロシージャのSQL Server プロファイラー スケジュールされたアクティビティとイベント ドリブン アクティビティを管理するためにSQL Server エージェントによって使用されます。
Stretch Database ストアド プロシージャ ストレッチ データベースの管理に使用されます。
テンポラル テーブル ストアド プロシージャ テンポラル テーブルに使用する
XML ストアド プロシージャ XML テキストの管理に使用します。

Note

特に明記されていない限り、すべてのシステム ストアド プロシージャは成功を示す値 0 を返します。 失敗した場合は、0 以外の値が返されます。

重要

拡張データベースは、SQL Server 2022 (16.x) および Azure SQL Database では非推奨になります。 この機能は、データベース エンジンの将来のバージョンで削除される予定です。 新規の開発作業ではこの機能を使用しないようにし、現在この機能を使用しているアプリケーションは修正することを検討してください。

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

ADO、OLE DB、ODBC アプリケーションに対してSQL Server プロファイラーを実行するユーザーは、Transact-SQL リファレンスで説明されていないシステム ストアド プロシージャを使用しているこれらのアプリケーションに気付く場合があります。 これらのストアド プロシージャは、データベース API の機能を実装するために、SQL Server Native Client OLE DB Provider と SQL Server Native Client ODBC ドライバーによって使用されます。 これらのストアド プロシージャは、プロバイダーまたはドライバーが SQL Server のインスタンスにユーザー要求を通信するために使用するメカニズムにすぎません。 これらは、プロバイダーまたはドライバーの内部使用のみを目的としています。 SQL Server ベースのアプリケーションからの明示的な呼び出しはサポートされていません。

ODBC の ntext、text、およびイメージの処理には、ストアド プロシージャとストアド プロシージャが使用されます。sp_createorphansp_droporphans

ストアド プロシージャは sp_reset_connection 、トランザクションでのリモート ストアド プロシージャ呼び出しをサポートするために SQL Server によって使用されます。 このストアド プロシージャでは、接続プールから接続が再利用されるときに、Audit Login イベントと Audit Logout イベントも発生します。

次の表のシステム ストアド プロシージャは、SQL Server のインスタンス内またはクライアント API 経由でのみ使用され、一般的な顧客向けではありません。 これらは変更される可能性があり、互換性は保証されません。

次のストアド プロシージャについて説明します。

 

次のストアド プロシージャは文書化されていません。

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