Referenz zu datenbankspezifischen Features für den Daten-API-Generator

Diese Referenz behandelt Features, Verhaltensweisen und Anforderungen, die spezifisch für eine oder mehrere Datenbankplattformen sind, die vom Daten-API-Generator (DATA API Builder, DAB) unterstützt werden. Eine datenbankübergreifende Featurevergleichsmatrix finden Sie unter Featureverfügbarkeit.

Datenbankversionsunterstützung

DAB unterstützt die folgenden Datenbankplattformen. Mindestversionsanforderungen gelten für selbstverwaltete Bereitstellungen. PaaS-Datenbanken (Platform-as-a-Service) verfügen nicht über eine Mindestversionsanforderung, da der Dienst die Version verwaltet.

SQL Server und Azure SQL

SESSION_CONTEXT

Für SQL Server und Azure SQL kann DAB authentifizierte Benutzeransprüche an die Datenbank weitergeben, indem sie vor dem Ausführen jeder Abfrage aufrufen sp_set_session_context . Mit diesem Mechanismus können SQL-systemeigene Sicherheitsrichtlinien auf Zeilenebene und gespeicherte Prozeduren die Identität des Aufrufers aus dem Datenbankmodul lesen.

Wenn set-session-context in der DAB-Konfiguration aktiviert ist, sendet DAB alle authentifizierten Ansprüche als Schlüsselwertpaare:

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;

Allgemeine gesendete Ansprüche umfassen roles, , sub, oidund alle benutzerdefinierten Ansprüche, die Ihr Identitätsanbieter in JWT enthält.

Aktivieren von SESSION_CONTEXT

Beim Aufrufen dab initfestlegen--set-session-context true:

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

Oder legen Sie die Eigenschaft direkt in dab-config.json:

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

Verwenden von SESSION_CONTEXT in SQL

Nach dem Aktivieren set-session-contextkönnen Ihre SQL-Objekte die Anspruchswerte lesen:

-- 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));

Eine vollständige exemplarische Vorgehensweise finden Sie unter Implementieren der Sicherheit auf Zeilenebene mit Sitzungskontext.

SESSION_CONTEXT und Verbindungspooling

DAB setzt alle Sitzungskontextwerte am Anfang jeder Anforderung zurück. Da set-session-context jedoch die Semantik pro Benutzerverbindung erzwungen wird, wird die Wiederverwendung der Verbindung für benutzerübergreifende Benutzer automatisch vermieden, wenn diese Option aktiviert ist.

Verbindungszeichenfolgenvarianten

DAB verwendet Microsoft.Data.SqlClient SQL Server und Azure SQL. Die Bibliothek unterstützt diese Verbindungszeichenfolgenformate.

Allgemeine Formate:

Nicht unterstützte Datentypen

Die folgenden SQL Server- und Azure SQL-Datentypen werden von DAB nicht unterstützt:

Azure Cosmos DB für NoSQL-Datenbanklösungen

Schemaanforderung

Im Gegensatz zu relationalen Datenbanken ist Azure Cosmos DB für NoSQL schemaagnostisch. DAB kann keinen Cosmos DB-Container introspektieren, um GraphQL-Typen zu generieren. Sie müssen eine GraphQL-Schemadatei (.gql) bereitstellen, die Ihre Dokumentstruktur definiert.

Die Schemadatei verwendet standardmäßige GraphQL Schema Definition Language (SDL) mit zwei benutzerdefinierten Direktiven:

@model-Anweisung

Die @model(name: "...") Direktive ist für jeden GraphQL-Typ erforderlich, den Sie über DAB verfügbar machen. Der name Wert muss exakt mit dem Entitätsnamen in Ihrer DAB-Konfigurationsdatei übereinstimmen.

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

@authorize-Anweisung

Die @authorize Direktive stellt die Zugriffssteuerung auf Feldebene und Typebene für Cosmos DB GraphQL-Abfragen bereit. Er akzeptiert einen roles Parameter, der die Rollen auflistet, die auf das Feld oder den Typ zugreifen können.

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

Sie können auch auf Typebene anwenden @authorize :

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

Eine vollständige Einrichtungsanleitung finden Sie unter Einrichten des Daten-API-Generators für Azure Cosmos DB für NoSQL.

Rest-API nicht verfügbar

DAB generiert keine REST-Endpunkte für Azure Cosmos DB für NoSQL. Azure Cosmos DB bietet eine umfassende native REST-API für Dokumentvorgänge. Es werden nur GraphQL-Endpunkte generiert. OpenAPI-Dokumente werden für Cosmos DB-Entitäten nicht generiert.

Verwenden Sie die Azure Cosmos DB-REST-API direkt, um auf Daten über REST zuzugreifen.

Nicht unterstützte Features für Cosmos DB

Die folgenden Features werden für Azure Cosmos DB für NoSQL nicht unterstützt:

PostgreSQL

Mindestversion

PostgreSQL 11 oder höher ist erforderlich. DAB verwendet Npgsql als PostgreSQL-Treiber.

Nicht unterstützte Datentypen

Die folgenden PostgreSQL-Datentypen werden von DAB nicht unterstützt:

Gespeicherte Prozeduren

Gespeicherte Prozeduren werden für PostgreSQL-Entitäten nicht unterstützt. Verwenden Sie stattdessen Tabellen und Ansichten.

MySQL

Mindestversion

MySQL 8 oder höher ist erforderlich.

Nicht unterstützte Datentypen

Die folgenden MySQL-Datentypen werden von DAB nicht unterstützt:

Gespeicherte Prozeduren

Gespeicherte Prozeduren werden für MySQL-Entitäten nicht unterstützt. Verwenden Sie stattdessen Tabellen.

Azure Synapse Analytics (dedizierter SQL-Pool)

Unterstützte Objekte

Dedizierter SQL-Pool unterstützt Tabellen, Ansichten und gespeicherte Prozeduren – identisch mit SQL Server und Azure SQL. Serverloser SQL-Pool wird nicht unterstützt.

Nicht unterstützte Funktionen

Verwandte Inhalte

• Verfügbarkeit von Features
• Referenz zur Datenquellenkonfiguration
• Implementieren der Sicherheit auf Zeilenebene mit Sitzungskontext
• Einrichten des Daten-API-Generators für Azure Cosmos DB für NoSQL
• Versions- und Versionsverwaltungsrichtlinien