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>
    }
  }
}

Пример: SQL Azure и 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

Для SQL Azure и SQL Server построитель API данных может включать сведения о утверждениях SESSION_CONTEXTв SQL.

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

Построитель данных использует экспоненциальную обратную передачу для повторных запросов к базе данных после временных ошибок.

Удостоверения управляемых служб (MSI)

Управляемые удостоверения службы (MSI) поддерживаются в DefaultAzureCredentialAzure.Identity библиотеке. Дополнительные сведения об управляемых удостоверениях в Microsoft Entra для SQL Azure.

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

Работоспособности (источник данных)

Построитель данных поддерживает несколько файлов конфигурации, каждый из которых имеет собственный источник данных. Этот блок конфигурации позволяет каждому источнику данных иметь собственную конфигурацию работоспособности.

Nested properties

Check name

Так как несколько файлов конфигурации могут указывать на источники данных одного типа, эти источники данных не могут отличаться в отчете о работоспособности. Используется name для назначения уникальной идентифицируемой метки, используемой только в отчете о работоспособности.

Check behavior

Самый простой запрос, характерный для типа базы данных, выполняется в заданном источнике данных, чтобы убедиться, что подключение можно открыть. threshold-ms Используйте свойство, чтобы настроить максимальную допустимую длительность (в миллисекундах) для завершения этого запроса.

Format

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