Data source

该 data-source 部分定义数据库访问详细信息。 它还定义数据库选项。

数据源设置

Format overview

{
  "data-source": {
    "database-type": <string>,
    "connection-string": <string>,
    "options": {
      // mssql only
      "set-session-context": <true> (default) | <false>,
      // cosmosdb_nosql only
      "database": <string>,
      "container": <string>,
      "schema": <string>
    },
    "health": {
      "enabled": <true> (default) | <false>,
      "name": <string>,
      "threshold-ms": <integer; default: 1000>
    }
  },
  "data-source-files": ["<string>"]
}

Data source

Nested properties

Property values

Format

{
  "data-source": {
    "database-type": <string>,
    "connection-string": <string>,
    "options": {
      "<key-name>": <string>
    }
  }
}

示例：Azure SQL 和 SQL Server

"data-source": {
  "database-type": "mssql",
  "connection-string": "Server=tcp:myserver.database.windows.net,1433;Initial Catalog=MyDatabase;User ID=MyUser;Password=MyPassword;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
    "options": {
      "set-session-context": true
    }
}

消费 SESSION_CONTEXT

对于 Azure SQL 和 SQL Server，数据 API 生成器可以包含 SQL 中的 SESSION_CONTEXT声明信息。

CREATE PROC GetUser @userId INT AS
BEGIN
    -- Use claims
    IF SESSION_CONTEXT(N'user_role') = 'admin' 
    BEGIN
        RAISERROR('Unauthorized access', 16, 1);
    END

    SELECT Id, Name, Age, IsAdmin
    FROM Users
    WHERE Id = @userId;
END;

示例：Azure Cosmos DB

"data-source": {
  "database-type": "cosmosdb_nosql",
  "connection-string": "@env('SQL_CONNECTION_STRING')",
  "options": {
    "database": "Your_CosmosDB_Database_Name",
    "container": "Your_CosmosDB_Container_Name",
    "schema": "Path_to_Your_GraphQL_Schema_File"
  }
}

Environment variables

使用环境变量将纯文本机密保留在配置文件中。

"data-source": {
  "database-type": "mssql",
  "connection-string": "@env('SQL_CONNECTION_STRING')"
}

Connection resiliency

数据 API 生成器使用指数退避在暂时性错误后重试数据库请求。

托管服务标识 （MSI）

库中定义的Azure.Identity托管服务标识（MSI）受DefaultAzureCredential支持。 详细了解 Azure SQL 的 Microsoft Entra 中的托管标识。

User-Assigned 托管标识（UAMI）

For User Assigned Managed Identity, append the Authentication and User Id properties to your connection string while substituting in your User Assigned Managed Identity's client id: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

System-Assigned 托管标识（SAMI）

For System Assigned Managed Identity, append the Authentication property and exclude the UserId and Password arguments from your connection string: Authentication=Active Directory Managed Identity;.

运行状况（数据源）

数据 API 生成器支持多个配置文件，每个配置文件都有自己的数据源。 此配置块允许每个数据源都有自己的运行状况配置。

Nested properties

Check name

由于多个配置文件可以指向同一类型的数据源，因此无法在运行状况报告中区分这些数据源。 用于 name 分配仅在运行状况报告中使用的唯一可识别标签。

Check behavior

针对给定数据源执行最简单的查询（特定于数据库类型），以验证是否可以打开连接。 使用该 threshold-ms 属性配置该查询完成的最大可接受持续时间（以毫秒为单位）。

Format

{
  "data-source": {
    "health": {
      "enabled": <true> (default) | <false>,
      "name": <string>,
      "threshold-ms": <integer; default: 1000>
    }
  }
}