sp_spaceused (Transact-SQL)

適用対象: SQL Server Azure SQL データベース Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

sp_spaceused システム ストアド プロシージャには、次のいずれかが表示されます。

• 現在のデータベースのテーブル、インデックス付きビュー、または Service Broker キューによって使用される行数、予約済みディスク領域、ディスク領域

• データベース全体で予約および使用されるディスク領域

Transact-SQL 構文表記規則

構文

sp_spaceused
    [ [ @objname = ] N'objname' ]
    [ , [ @updateusage = ] 'updateusage' ]
    [ , [ @mode = ] 'mode' ]
    [ , [ @oneresultset = ] oneresultset ]
    [ , [ @include_total_xtp_storage = ] include_total_xtp_storage ]
[ ; ]

引数

Azure Synapse Analytics and Analytics Platform System (PDW) の場合、 sp_spaceused パラメーターの序数位置に依存するのではなく、名前付きパラメーター ( sp_spaceused (@objname= N'Table1'); など) を指定する必要があります。

[ @objname = ] N'objname'

スペース使用量情報が要求される表、索引付きビュー、またはキューの修飾名または非修飾名。 @objname は nvarchar(776) で、既定値は NULL です。 引用符は、修飾オブジェクト名が指定されている場合にのみ必要です。 完全修飾オブジェクト名 (データベース名を含む) を指定する場合、データベース名は現在のデータベースの名前である必要があります。

@objnameが指定されていない場合は、データベース全体の結果が返されます。

[ @updateusage = ] 'updateusage'

領域の使用状況情報を更新するために実行する必要がある DBCC UPDATEUSAGE を示します。 @updateusage は varchar(5) で、既定値は false です。 @objnameが指定されていない場合、ステートメントはデータベース全体で実行されます。 それ以外の場合、ステートメントは @objnameで実行されます。 値は、true または false です。

[ @mode = ] 'mode'

結果のスコープを示します。 ストレッチ テーブルまたはデータベースの場合、 @mode パラメーターを使用すると、オブジェクトのリモート部分を含めたり除外したりできます。 詳細については、「 Stretch Database」を参照してください。

@mode は varchar(11)であり、これらの値のいずれかを指定できます。

[ @oneresultset = ] oneresultset

1 つの結果セットを返すかどうかを示します。 @oneresultset は ビットであり、次のいずれかの値を指定できます。

[ @include_total_xtp_storage = ] include_total_xtp_storage

適用対象: SQL Server 2017 (14.x) 以降のバージョン、および SQL Database

@oneresultsetが 1 に設定されている場合、このパラメーターは、単一の結果セットにMEMORY_OPTIMIZED_DATAストレージの列が含まれているかどうかを判断します。 @include_total_xtp_storage は bit で、既定値は 0 です。 1場合、XTP 列は結果セットに含まれます。

リターン コードの値

0 (成功) または 1 (失敗)。

結果セット

@objnameを省略し、@oneresultsetの値が0場合は、次の結果セットが返され、現在のデータベース サイズ情報が提供されます。

@objnameを省略し、@oneresultsetの値が1場合は、次の単一の結果セットが返され、現在のデータベース サイズ情報が提供されます。

@objnameを指定すると、指定したオブジェクトに対して次の結果セットが返されます。

このモードは、パラメーターが指定されていない場合の既定値です。 次の結果セットは、ディスク上のデータベース サイズ情報の詳細を返します。

データベース内のテーブルによって使用される領域。 この結果セットには、ディスク使用量のテーブルごとのアカウンティングがないため、メモリ最適化テーブルは反映されません。

次の結果セットは 返されます データベースに少なくとも 1 つのコンテナーを含む MEMORY_OPTIMIZED_DATA ファイル グループがある場合は、その場合に発生します。

@objnameを省略すると、@oneresultsetの値が1され、@include_total_xtp_storageが1場合は、次の単一の結果セットが返され、現在のデータベース サイズ情報が提供されます。 @include_total_xtp_storageが0 (既定値) の場合、最後の 3 つの列は省略されます。

¹ @include_total_xtp_storage が 1に設定されている場合にのみ含まれます。

解説

ログ ファイルのサイズが含まれているため、 database_size の値は通常、 reserved + unallocated space の合計よりも大きくなりますが、 reserved と unallocated_space ではデータ ページのみが考慮されます。 Azure Synapse Analytics では、このステートメントが正しくない場合があります。

XML インデックスとフルテキスト インデックスで使用されるページは、両方の結果セットの index_size に含まれます。 @objnameを指定すると、オブジェクトの XML インデックスとフルテキスト インデックスのページも、結果の合計reservedとindex_sizeにカウントされます。

空間インデックスであるデータベースまたはオブジェクトの領域使用量が計算される場合、空間サイズの列 ( database_size、 reserved、 index_sizeなど) には空間インデックスのサイズが含まれます。

@updateusageを指定すると、SQL Server データベース エンジンはデータベース内のデータ ページをスキャンし、各テーブルで使用される記憶域に関するsys.allocation_unitsおよびsys.partitionsカタログ ビューに対して必要な修正を行います。 インデックスが削除された後、テーブルの領域情報が最新でない場合など、いくつかの状況があります。 @updateusage は、大規模なテーブルまたはデータベースで実行するのに時間がかかる場合があります。 @updateusageは、正しくない値が返されていると思われる場合、およびプロセスがデータベース内の他のユーザーまたはプロセスに悪影響を及ぼさない場合にのみ使用します。 必要に応じて、 DBCC UPDATEUSAGE を個別に実行できます。

アクセス許可

sp_spaceusedを実行するアクセス許可は、public ロールに付与されます。 @updateusage パラメーターを指定できるのは、db_owner 固定データベース ロールのメンバーだけです。

例

A. テーブルに関するディスク領域情報を表示する

次の例では、 Vendor テーブルとそのインデックスのディスク領域情報を報告します。

USE AdventureWorks2022;
GO
EXEC sp_spaceused N'Purchasing.Vendor';
GO

B. データベースに関する更新された領域情報を表示する

次の例では、現在のデータベースで使用されている領域を要約し、省略可能なパラメーター @updateusage を使用して、現在の値が確実に返されるようにします。

USE AdventureWorks2022;
GO
EXEC sp_spaceused @updateusage = N'TRUE';
GO

C: Stretch 対応テーブルに関連付けられているリモート テーブルに関する領域の使用状況情報を表示する

次の例では、 @mode 引数を使用してリモート ターゲットを指定することで、Stretch 対応テーブルに関連付けられているリモート テーブルで使用される領域を要約します。 詳細については、「Stretch Database」を参照してください。

USE StretchedAdventureWorks2022;
GO

EXEC sp_spaceused N'Purchasing.Vendor', @mode = 'REMOTE_ONLY';

D. 1 つの結果セット内のデータベースの領域使用量情報を表示する

次の例は、1 つの結果セット内の現在のデータベースの領域使用量をまとめたものです。

USE AdventureWorks2022;
GO
EXEC sp_spaceused @oneresultset = 1;

E. 1 つの結果セットに少なくとも 1 つのMEMORY_OPTIMIZED ファイル グループがあるデータベースの領域使用量情報を表示する

次の例では、1 つの結果セットに少なくとも 1 つの MEMORY_OPTIMIZED ファイル グループがある現在のデータベースの領域使用量を要約します。

USE WideWorldImporters
GO

EXEC sp_spaceused @updateusage = 'FALSE',
    @mode = 'ALL',
    @oneresultset = '1',
    @include_total_xtp_storage = '1';
GO

F. データベース内の MEMORY_OPTIMIZED テーブル オブジェクトの領域使用量情報を表示する

次の例では、現在のデータベース内の MEMORY_OPTIMIZED テーブル オブジェクトの領域使用量と、少なくとも 1 つの MEMORY_OPTIMIZED ファイル グループを要約します。

USE WideWorldImporters
GO

EXEC sp_spaceused @objname = N'VehicleTemperatures',
    @updateusage = 'FALSE',
    @mode = 'ALL',
    @oneresultset = '0',
    @include_total_xtp_storage = '1';
GO

関連するコンテンツ

• CREATE INDEX (Transact-SQL)
• CREATE TABLE (Transact-SQL)
• DBCC UPDATEUSAGE (Transact-SQL)
• Service Broker
• sys.allocation_units (Transact-SQL)
• sys.indexes (Transact-SQL)
• sys.index_columns (Transact-SQL)
• sys.objects (Transact-SQL)
• sys.partitions (Transact-SQL)
• システム ストアド プロシージャ (Transact-SQL)