データ API ビルダーのデータベース固有の機能リファレンス

このリファレンスでは、Data API Builder (DAB) でサポートされている 1 つ以上のデータベース プラットフォームに固有の機能、動作、要件について説明します。 データベース間機能の比較マトリックスについては、「 機能の可用性」を参照してください。

データベース バージョンのサポート

DAB では、次のデータベース プラットフォームがサポートされています。 最小バージョン要件は、セルフマネージド デプロイに適用されます。 サービスがバージョンを管理するため、サービスとしてのプラットフォーム (PaaS) データベースには最小バージョン要件はありません。

SQL Server と Azure SQL

SESSION_CONTEXT

SQL Server と Azure SQL の場合、DAB は、各クエリを実行する前に sp_set_session_context を呼び出すことによって、認証済みのユーザー要求をデータベースに伝達できます。 このメカニズムにより、SQL ネイティブの行レベルのセキュリティ ポリシーとストアド プロシージャは、データベース エンジン内から呼び出し元の ID を読み取ります。

DAB 構成で set-session-context が有効になっている場合、DAB は認証されたすべての要求をキーと値のペアとして送信します。

EXEC sp_set_session_context 'roles', 'editor', @read_only = 0;
EXEC sp_set_session_context 'oid', 'a1b2c3d4-...', @read_only = 0;
-- Your query executes after claims are set
SELECT * FROM dbo.Documents;

送信される一般的な要求には、 roles、 sub、 oid、および ID プロバイダーが JWT に含めるカスタム要求が含まれます。

SESSION_CONTEXTを有効にする

dab initを呼び出すときに--set-session-context trueを設定します。

dab init \
  --database-type mssql \
  --connection-string "@env('SQL_CONNECTION_STRING')" \
  --set-session-context true

または、 dab-config.jsonでプロパティを直接設定します。

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('SQL_CONNECTION_STRING')",
    "options": {
      "set-session-context": true
    }
  }
}

SQL でSESSION_CONTEXTを使用する

set-session-contextを有効にすると、SQL オブジェクトは要求値を読み取ることができます。

-- Read a claim in a stored procedure
DECLARE @role NVARCHAR(256) = CAST(SESSION_CONTEXT(N'roles') AS NVARCHAR(256));

-- Use a claim in a row-level security predicate function
CREATE FUNCTION dbo.RlsPredicate(@claimRole NVARCHAR(256))
RETURNS TABLE
WITH SCHEMABINDING
AS RETURN SELECT 1 AS result
WHERE @claimRole = CAST(SESSION_CONTEXT(N'roles') AS NVARCHAR(256));

完全なチュートリアルについては、「 セッション コンテキストを使用して行レベルのセキュリティを実装する」を参照してください。

SESSION_CONTEXTと接続プール

DAB は、各要求の開始時にすべてのセッション コンテキスト値をリセットします。 ただし、 set-session-context はユーザーごとの接続セマンティクスを強制するため、このオプションを有効にすると、ユーザー間での接続の再利用は自動的に回避されます。

接続文字列のバリアント

DAB では、SQL Server と Azure SQL に Microsoft.Data.SqlClient が使用されます。 ライブラリでは、 これらの接続文字列形式がサポートされています。

一般的な形式:

サポートされていないデータ型

DAB では、次の SQL Server と Azure SQL のデータ型はサポートされていません。

Azure Cosmos DB for NoSQL

スキーマの要件

リレーショナル データベースとは異なり、Azure Cosmos DB for NoSQL はスキーマに依存しません。 DAB は、GraphQL 型を生成するために Cosmos DB コンテナーをイントロスペクトすることはできません。 ドキュメント構造を定義する GraphQL スキーマ ファイル (.gql) を指定する必要があります。

スキーマ ファイルでは、標準の GraphQL スキーマ定義言語 (SDL) と 2 つのカスタム ディレクティブが使用されます。

@model ディレクティブ

@model(name: "...") ディレクティブは、DAB を介して公開するすべての GraphQL 型で必要です。 name値は、DAB 構成ファイル内のエンティティ名と正確に一致している必要があります。

type Book @model(name: "Book") {
  id: ID
  title: String
  year: Int
}

@authorize ディレクティブ

@authorize ディレクティブは、Cosmos DB GraphQL クエリのフィールド レベルおよび型レベルのアクセス制御を提供します。 フィールドまたは型にアクセスできるロールを一覧表示する roles パラメーターを受け取ります。

type Book @model(name: "Book") {
  id: ID
  title: String @authorize(roles: ["authenticated", "librarian"])
  internalNotes: String @authorize(roles: ["editor"])
}

型レベルで @authorize を適用することもできます。

type InternalReport @model(name: "InternalReport") @authorize(roles: ["auditor"]) {
  id: ID
  summary: String
}

完全なセットアップ ガイドについては、「 NoSQL 用 Azure Cosmos DB のデータ API ビルダーを設定する」を参照してください。

REST API を使用できない

DAB では、Azure Cosmos DB for NoSQL の REST エンドポイントは生成されません。 Azure Cosmos DB には、ドキュメント操作用の包括的なネイティブ REST API が用意されています。 GraphQL エンドポイントのみが生成されます。 Cosmos DB エンティティに対して OpenAPI ドキュメントは生成されません。

REST 経由でデータにアクセスするには、 Azure Cosmos DB REST API を 直接使用します。

Cosmos DB でサポートされていない機能

次の機能は、Azure Cosmos DB for NoSQL ではサポートされていません。

PostgreSQL

最小バージョン

PostgreSQL 11 以降が必要です。 DAB は postgreSQL ドライバーとして Npgsql を使用します。

サポートされていないデータ型

DAB では、次の PostgreSQL データ型はサポートされていません。

ストアド プロシージャ

PostgreSQL エンティティでは、ストアド プロシージャはサポートされていません。 代わりにテーブルとビューを使用してください。

MySQL

最小バージョン

MySQL 8 以降が必要です。

サポートされていないデータ型

次の MySQL データ型は DAB ではサポートされていません。

ストアド プロシージャ

ストアド プロシージャは、MySQL エンティティではサポートされていません。 代わりにテーブルを使用してください。

Azure Synapse Analytics (専用 SQL プール)

サポート対象のオブジェクト

専用 SQL プールでは、SQL Server や Azure SQL と同じように、テーブル、ビュー、ストアド プロシージャがサポートされます。 サーバーレス SQL プールはサポートされていません。

サポートされていない機能

関連するコンテンツ

• 機能の可用性
• データ ソース構成リファレンス
• セッション コンテキストを使用して行レベルのセキュリティを実装する
• Azure Cosmos DB for NoSQL 用のデータ API ビルダーを設定する
• リリースポリシーとバージョン管理ポリシー