Поделиться через


Выходная привязка базы данных Azure для MySQL для функций Azure

Вы можете использовать выходную привязку Базы данных Azure для MySQL для записи в базу данных.

Сведения о настройке и настройке см. в обзоре.

Внимание

В этой статье используются вкладки для поддержки нескольких версий модели программирования Node.js. Модель версии 4 общедоступна и предназначена для более гибкого и интуитивно понятного интерфейса для разработчиков JavaScript и TypeScript. Дополнительные сведения о том, как работает модель версии 4, см. в руководстве разработчика по Функции Azure Node.js. Дополнительные сведения о различиях между версиями 3 и 4 см. в руководстве по миграции.

Примеры

Вы можете создать функцию C# с помощью одного из следующих режимов C#:

  • Изолированная рабочая модель: скомпилированная функция C#, которая выполняется в рабочем процессе, изолированном от среды выполнения. Изолированный рабочий процесс необходим для поддержки функций C#, работающих в долгосрочной поддержке (LTS) и версиях, отличных от LTS для .NET и .NET Framework.
  • Модель в процессе: скомпилированная функция C#, которая выполняется в том же процессе, что и среда выполнения Функций Azure.
  • Скрипт C#: используется в основном при создании функций C# в портал Azure.

Дополнительные примеры для База данных Azure для MySQL выходной привязки доступны в репозитории GitHub.

Этот раздел содержит следующий пример:

Пример ссылается на Product класс и соответствующую таблицу базы данных:

namespace AzureMySqlSamples.Common
{
    public class Product
    {
        public int? ProductId { get; set; }

        public string Name { get; set; }

        public int Cost { get; set; }

        public override bool Equals(object obj)
    }
}
DROP TABLE IF EXISTS Products;

CREATE TABLE Products (
  ProductId int PRIMARY KEY,
  Name varchar(100) NULL,
  Cost int NULL
);

Триггер HTTP, одна запись

В следующем примере показана функция C# , которая добавляет запись в базу данных с помощью данных, предоставленных в HTTP-запросе POST в виде текста JSON.

using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Extensions.MySql;
using Microsoft.Azure.Functions.Worker.Http;
using AzureMySqlSamples.Common;

namespace AzureMySqlSamples.OutputBindingSamples
{
    public static class AddProduct
    {
        [FunctionName(nameof(AddProduct))]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "post", Route = "addproduct")]
            [FromBody] Product prod,
            [MySql("Products", "MySqlConnectionString")] out Product product)
        {
            product = prod;
            return new CreatedResult($"/api/addproduct", product);
        }
    }
}

Дополнительные примеры для База данных Azure для MySQL выходной привязки доступны в репозитории GitHub.

Этот раздел содержит следующий пример:

Пример ссылается на Product класс и соответствующую таблицу базы данных:

package com.function.Common;

import com.fasterxml.jackson.annotation.JsonProperty;

public class Product {
    @JsonProperty("ProductId")
    private int ProductId;
    @JsonProperty("Name")
    private String Name;
    @JsonProperty("Cost")
    private int Cost;

    public Product() {
    }

    public Product(int productId, String name, int cost) {
        ProductId = productId;
        Name = name;
        Cost = cost;
    }
}
DROP TABLE IF EXISTS Products;

CREATE TABLE Products (
  ProductId int PRIMARY KEY,
  Name varchar(100) NULL,
  Cost int NULL
);

Триггер HTTP, запись записывается в таблицу

В следующем примере показана выходная привязка Базы данных Azure для MySQL в функции Java, которая добавляет запись в таблицу с использованием данных, предоставленных в HTTP-запросе POST в виде текста JSON. Функция принимает дополнительную зависимость от библиотеки com.google.code.gson для анализа текста JSON.

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.10.1</version>
</dependency>
package com.function;

import com.microsoft.azure.functions.HttpMethod;
import com.microsoft.azure.functions.HttpRequestMessage;
import com.microsoft.azure.functions.HttpResponseMessage;
import com.microsoft.azure.functions.HttpStatus;
import com.microsoft.azure.functions.OutputBinding;
import com.microsoft.azure.functions.annotation.AuthorizationLevel;
import com.microsoft.azure.functions.annotation.FunctionName;
import com.microsoft.azure.functions.annotation.HttpTrigger;
import com.microsoft.azure.functions.mysql.annotation.MySqlOutput;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.function.Common.Product;

import java.io.IOException;
import java.util.Optional;

public class AddProduct {
    @FunctionName("AddProduct")
    public HttpResponseMessage run(
            @HttpTrigger(
                name = "req",
                methods = {HttpMethod.POST},
                authLevel = AuthorizationLevel.ANONYMOUS,
                route = "addproduct")
                HttpRequestMessage<Optional<String>> request,
            @MySqlOutput(
                name = "product",
                commandText = "Products",
                connectionStringSetting = "MySqlConnectionString")
                OutputBinding<Product> product) throws JsonParseException, JsonMappingException, IOException {

        String json = request.getBody().get();
        ObjectMapper mapper = new ObjectMapper();
        Product p = mapper.readValue(json, Product.class);
        product.setValue(p);

        return request.createResponseBuilder(HttpStatus.OK).header("Content-Type", "application/json").body(product).build();
    }
}

Дополнительные примеры для База данных Azure для MySQL выходной привязки доступны в репозитории GitHub.

Этот раздел содержит следующий пример:

Пример ссылается на таблицу базы данных:

DROP TABLE IF EXISTS Products;

CREATE TABLE Products (
  ProductId int PRIMARY KEY,
  Name varchar(100) NULL,
  Cost int NULL
);

Триггер HTTP, запись записей в таблицу

В следующем примере показана выходная привязка базы данных Azure для MySQL, которая добавляет записи в таблицу, используя данные, предоставленные в HTTP-запросе POST в виде текста JSON.

const { app, output } = require('@azure/functions');

const mysqlOutput = output.generic({
    type: 'mysql',
    commandText: 'Products',
    connectionStringSetting: 'MySqlConnectionString'
})

// Upsert the product, which will insert it into the Products table if the primary key (ProductId) for that item doesn't exist.
// If it does, update it to have the new name and cost.
app.http('AddProduct', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [mysqlOutput],
    handler: async (request, context) => {
        // Note that this expects the body to be a JSON object or array of objects that have a property
        // matching each of the columns in the table to upsert to.
        const product = await request.json();
        context.extraOutputs.set(mysqlOutput, product);

        return {
            status: 201,
            body: JSON.stringify(product)
        };
    }
});
const { app, output } = require('@azure/functions');

const mysqlOutput = output.generic({
    type: 'mysql',
    commandText: 'Products',
    connectionStringSetting: 'MySqlConnectionString'
})

// Upsert the product, which will insert it into the Products table if the primary key (ProductId) for that item doesn't exist.
// If it does, update it to have the new name and cost.
app.http('AddProduct', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [mysqlOutput],
    handler: async (request, context) => {
        // Note that this expects the body to be a JSON object or array of objects that have a property
        // matching each of the columns in the table to upsert to.
        const product = await request.json();
        context.extraOutputs.set(mysqlOutput, product);

        return {
            status: 201,
            body: JSON.stringify(product)
        };
    }
});

Дополнительные примеры для База данных Azure для MySQL выходной привязки доступны в репозитории GitHub.

Этот раздел содержит следующий пример:

Пример ссылается на таблицу базы данных:

DROP TABLE IF EXISTS Products;

CREATE TABLE Products (
  ProductId int PRIMARY KEY,
  Name varchar(100) NULL,
  Cost int NULL
);

Триггер HTTP, запись записей в таблицу

В следующем примере показана выходная привязка Базы данных Azure для MySQL в файле function.json и функция PowerShell, которая добавляет записи в таблицу, используя данные, предоставленные в HTTP-запросе POST в виде текста JSON.

В следующем примере приведены данные привязки в файле function.json:

{
  "bindings": [
    {
      "authLevel": "function",
      "name": "Request",
      "direction": "in",
      "type": "httpTrigger",
      "methods": [
        "post"
      ],
      "route": "addproduct"
    },
    {
      "name": "response",
      "type": "http",
      "direction": "out"
    },
    {
      "name": "product",
      "type": "mysql",
      "direction": "out",
      "commandText": "Products",
      "connectionStringSetting": "MySqlConnectionString"
    }
  ],
  "disabled": false
}

В разделе "Конфигурация" описаны эти свойства.

Ниже приведен пример кода PowerShell для функции в файле run.ps1:

using namespace System.Net

# Trigger binding data passed in via parameter block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell function with MySql Output Binding processed a request."

# Note that this expects the body to be a JSON object or array of objects 
# that have a property matching each of the columns in the table to upsert to.
$req_body = $Request.Body

# Assign the value that you want to pass to the MySQL output binding. 
# The -Name value corresponds to the name property in the function.json file for the binding.
Push-OutputBinding -Name product -Value $req_body

# Assign the value to return as the HTTP response. 
# The -Name value matches the name property in the function.json file for the binding.
Push-OutputBinding -Name response -Value ([HttpResponseContext]@{
    StatusCode = [HttpStatusCode]::OK
    Body = $req_body
})

Дополнительные примеры для База данных Azure для MySQL выходной привязки доступны в репозитории GitHub.

Этот раздел содержит следующий пример:

Пример ссылается на таблицу базы данных:

DROP TABLE IF EXISTS Products;

CREATE TABLE Products (
  ProductId int PRIMARY KEY,
  Name varchar(100) NULL,
  Cost int NULL
);

Примечание.

Для Python необходимо использовать функции Azure версии 1.22.0b4.

Триггер HTTP, запись записей в таблицу

В следующем примере показана выходная привязка базы данных Azure для MySQL в файле function.json и функция Python, которая добавляет записи в таблицу с использованием данных, предоставленных в HTTP-запросе POST в виде текста JSON.

Ниже приведен пример кода Python для файла function_app.py:

import json 

import azure.functions as func

app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)
@app.generic_trigger(arg_name="req", type="httpTrigger", route="addproduct")
@app.generic_output_binding(arg_name="$return", type="http")
@app.generic_output_binding(arg_name="r", type="mysql",
                            command_text="Products",
                            connection_string_setting="MySqlConnectionString")
def mysql_output(req: func.HttpRequest, r: func.Out[func.MySqlRow]) \
        -> func.HttpResponse:
    body = json.loads(req.get_body())
    row = func.MySqlRow.from_dict(body)
    r.set(row)

    return func.HttpResponse(
        body=req.get_body(),
        status_code=201,
        mimetype="application/json"
    )

Атрибуты

Библиотека C# использует MySqlAttribute атрибут для объявления привязок MySQL для функции, которая имеет следующие свойства:

Свойство атрибута Описание
CommandText Обязательный. Имя таблицы, в которую записывается привязка.
ConnectionStringSetting Обязательный. Имя параметра приложения, содержащего строку подключения для базы данных, в которую записываются данные. Это значение не является фактической строкой подключения и вместо этого должно разрешаться в переменную среды.

Заметки

В библиотеке среды выполнения функций Java используйте заметку @MySQLOutput по параметрам, значения которых будут поступать из База данных Azure для MySQL. Эта заметка поддерживает следующие элементы:

Элемент Описание
commandText Обязательный. Имя таблицы, в которую записывается привязка.
connectionStringSetting Обязательный. Имя параметра приложения, содержащего строку подключения для базы данных, в которую записываются данные. Это значение не является фактической строкой подключения и вместо этого должно разрешаться в переменную среды.
name Обязательный. Уникальное имя привязки функции.

Настройка

В следующей таблице описываются свойства, которые можно задать для объекта, переданного options методу output.generic() :

Свойство Описание
commandText Обязательный. Имя таблицы, в которую записывается привязка.
connectionStringSetting Обязательный. Имя параметра приложения, содержащего строку подключения для базы данных, в которую записываются данные. Это значение не является фактической строкой подключения и вместо этого должно разрешаться в переменную среды.

Настройка

В следующей таблице описываются свойства конфигурации привязки, заданные в файле function.json:

Свойство Описание
type Обязательный. Должен иметь значениеMysql.
direction Обязательный. Должен иметь значениеout.
name Обязательный. Имя переменной, представляющей сущность в коде функции.
commandText Обязательный. Имя таблицы, в которую записывается привязка.
connectionStringSetting Обязательный. Имя параметра приложения, содержащего строку подключения для базы данных, в которую записываются данные. Это значение не является фактической строкой подключения и вместо этого должно разрешаться в переменную среды.

Если разработка ведется на локальном компьютере, добавьте параметры приложения в файл local.settings.json в коллекции Values.

Примечание.

Выходная привязка поддерживает все специальные символы, включая знак доллара ($), backtick ('), дефис (-) и подчеркивание (_). Дополнительные сведения см. в документации сообщества MySQL.

Язык программирования может определять атрибуты-члены, содержащие специальные символы, поддерживаемые им. Например, C# имеет несколько ограничений для определения переменных.

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

Использование

Свойство CommandText — это имя таблицы, в которой хранятся данные. Имя параметра строки подключения соответствует параметру приложения, который содержит строку подключения к Базе данных Azure для MySQL.

Если исключение возникает при выполнении входной привязки MySQL, код функции не будет выполняться. Результатом может быть код ошибки, например триггер HTTP, возвращающий код ошибки 500.