システム ストアド プロシージャ (Transact-SQL)
適用対象:
SQL Server 2016 (13.x) 以降 Azure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsMicrosoft Fabric の SQL エンドポイントMicrosoft Fabric のウェアハウス
SQL Server では、システム ストアド プロシージャを使って、管理や情報に関する多くのアクティビティを実行できます。 システム ストアド プロシージャは、次の表に示すカテゴリに分類されます。
このセクションの内容
| カテゴリ | 説明 |
|---|---|
| アクティブなGeo-Replication ストアド プロシージャ | 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 のインスタンスから外部プログラムに提供するために使われます。 |
| ログ配布ストアド プロシージャ | ログ配布構成の構成、変更、監視に使われます。 |
| ストアド プロシージャData Warehouse管理 | 管理データ ウェアハウスの構成に使われます。 |
| MSDTC ストアド プロシージャ | Microsoft 分散トランザクション コーディネーター (MSDTC) のログのリセットや、MSDTC の統計の調査に使われます。 |
| OLE オートメーション ストアド プロシージャ | 標準の Transact-SQL バッチ内で使うために標準の Automation オブジェクトを有効にするために使われます。 |
| ポリシー ベースの管理ストアド プロシージャ | ポリシー ベースの管理に使用します。 |
| PolyBase ストアド プロシージャ | PolyBase スケールアウト グループのコンピューターを追加または削除します。 |
| クエリ ストアのストアド プロシージャ | パフォーマンスのチューニングに使われます。 |
| レプリケーション ストアド プロシージャ | レプリケーションの管理に使われます。 |
| セキュリティ ストアド プロシージャ | セキュリティの管理に使われます。 |
| スナップショット バックアップ ストアド プロシージャ | FILE_SNAPSHOT バックアップとそのすべてのスナップショットの削除や、個々のバックアップ ファイル スナップショットの削除に使われます。 |
| 空間インデックス ストアド プロシージャ | 空間インデックスのインデックス作成パフォーマンスの分析と向上に使われます。 |
| ストアド プロシージャのSQL Server エージェント | パフォーマンスとアクティビティを監視するために SQL Server Profiler によって使われます。 |
| ストアド プロシージャのSQL Server Profiler | スケジュールされたアクティビティとイベント ドリブン アクティビティを管理するために、SQL Server エージェントによって使われます。 |
| Stretch Database ストアド プロシージャ | 拡張データベースの管理に使われます。 |
| テンポラル テーブル ストアド プロシージャ | テンポラル テーブルに使われます |
| XML ストアド プロシージャ | XML テキストの管理に使用します。 |
注意
特に文書化されていない限り、すべてのシステム ストアド プロシージャは 成功を示すために の 0 値を返します。 失敗した場合は、0 以外の値が返されます。
重要
Stretch Database は、SQL Server 2022 (16.x) では非推奨になります。 この機能は、Microsoft SQL Server の将来のバージョンで削除されます。 新規の開発作業ではこの機能を使用しないようにし、現在この機能を使用しているアプリケーションは修正することを検討してください。
API システム ストアド プロシージャ
ADO、OLE DB、ODBC アプリケーションに対してSQL Server Profilerを実行するユーザーは、Transact-SQL リファレンスに記載されていないシステム ストアド プロシージャを使用しているアプリケーションに気付く場合があります。 これらのストアド プロシージャは、データベース API の機能を実装するために、SQL Server Native Client OLE DB Provider および SQL Server Native Client ODBC ドライバーによって使用されます。 これらのストアド プロシージャのメカニズムは、プロバイダーまたはドライバーによってユーザー要求を SQL Server のインスタンスに伝えるためだけに使われます。 これらは、プロバイダーまたはドライバーの内部で使うためだけのものです。 SQL Server ベースのアプリケーションから明示的に呼び出すことはサポートされていません。
sp_createorphanストアド プロシージャと sp_droporphans ストアド プロシージャは、ODBC の ntext、text、および Image の処理に使用されます。
ストアド プロシージャはsp_reset_connection、トランザクションでのリモート ストアド プロシージャ呼び出しをサポートするために、SQL Serverによって使用されます。 また、このストアド プロシージャを使うと、接続プールの接続が再利用されたときに、ログイン監査イベントとログアウト監査イベントが発生します。
次の表のシステム ストアド プロシージャは、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