sp_fulltext_keymappings (Transact-SQL)

適用対象: SQL Server Azure SQL Managed Instance Analytics Platform System (PDW)

ドキュメント識別子 (DocId) とフルテキスト キー値の間のマッピングを返します。 DocId 列には、フルテキスト インデックス付きテーブルの特定のフルテキスト キー値にマップされる bigint 整数の値が含まれています。 検索条件に一致する DocId 値は、Full-Text Engine からデータベース エンジンに渡され、そこでクエリ対象のベース テーブルのフルテキスト キー値にマップされます。 フルテキスト キー列は、テーブルの 1 つの列に必要な一意のインデックスです。

Transact-SQL 構文表記規則

構文

sp_fulltext_keymappings { table_id | table_id , docId | table_id , NULL , key }
[ ; ]

引数

table_id

フルテキスト インデックス付きテーブルのオブジェクト ID。 無効な table_idを指定すると、エラーが返されます。 テーブルのオブジェクト ID の取得については、 OBJECT_IDを参照してください。

docId

キー値に対応する内部ドキュメント識別子 (DocId)。 無効な docId 値は結果を返しません。

キー

指定したテーブルのフルテキスト キー値。 key 値が無効な場合、結果は返されません。 フルテキスト キー値の詳細については、「 フルテキスト インデックスの作成と管理」を参照してください。

リターン コードの値

なし。

結果セット

¹ キーのデータ型は、ベース テーブルのフルテキスト キー列のデータ型と同じです。

アクセス許可

この関数はパブリックであり、特別なアクセス許可は必要ありません。

解説

次の表に、1 つ、2 つ、または 3 つのパラメーターを使用した場合の効果を示します。

次のいずれかの条件に該当する場合は、エラーが返されます。

• 無効な table_idを指定しました
• テーブルにフルテキスト インデックスが作成されていない
• NULL が null 以外の可能性があるパラメーターに対して検出されます。

例

A. すべての Key 値と DocId 値を取得する

次の例では、 DECLARE @local_variable ステートメントを使用してローカル変数を作成し、 @table_id し、 ProductReview テーブルの ID を値として割り当てます。 この例では、table_id パラメーターsp_fulltext_keymappings@table_idを指定して実行します。

USE AdventureWorks2022;
GO
DECLARE @table_id int = OBJECT_ID(N'Production.ProductReview');
EXEC sp_fulltext_keymappings @table_id;
GO

この例では、次のように、テーブルからすべての DocId とフルテキスト キーを返します。

B. 特定のキー値の DocId 値を取得する

次の例では、DECLARE ステートメントを使用してローカル変数 @table_idを作成し、 ProductReview テーブルの ID をその値として割り当てます。 この例では、table_id パラメーターの@table_id、docId パラメーターにNULL、key パラメーターに 4 を指定sp_fulltext_keymappings実行します。

USE AdventureWorks2022;
GO

DECLARE @table_id int = OBJECT_ID(N'Production.ProductReview');

EXEC sp_fulltext_keymappings @table_id, NULL, 4;
GO

この例では、次の結果が返されます。

関連するコンテンツ

• フルテキスト検索およびセマンティック検索ストアド プロシージャ (Transact-SQL)