Azure Functions - Azure Table Storage との連携を試す

以前の投稿で、Azure Functions を活用することで、各種 Selenium WebDriver ファイルのバージョンアップを定期的に監視、メールで通知する、C# 実装による仕組みを作ったことを書いた。

Azure Functions を使って Selenium WebDriver の新バージョンリリースの通知を受け取る
http://devadjust.exblog.jp/23744108/

さて、新バージョンリリースを検知するためには、それまで時点でわかっている最新バージョンをどこかに保存・永続化しておく必要がある。

新バージョンリリースのチェック実行時、

• 今回チェック時に取得したバージョン番号と、
• その保存・永続化してあったバージョン番号

とを比較することで、新たなバージョンがリリースされたかどうかが判断できるためだ。

そのように最新バージョン番号を保存・永続化する具体的な手立てとして、安価で使い慣れている Azure Table Storage を採用したのであった。

そして前回投稿に書いたように、C# によるファンクション中から Azure Table Storage の読み書きを行うにあたっては、Azure Functions だからといって特別なことは何もない、いたって普通の C# による Azure Table Storage アクセスコードをゴリゴリと記述することで済ませていた。

しかし、である。

Azure ポータル Web サイト上での、Azure Functions の管理画面をいじっていると、入力 (Input) や出力 (Output) のバインディング(連携)先の選択肢に、"Table Storage" という選択肢が用意されているのだ。
ということで、Azure Functions が予め用意してある、Azure Table Storage との連携方法について調べてみた。

...なお、先に断っておくと、本記事に記載の内容は、下記の公式ドキュメントサイトをなぞった内容が多くを占めているので、その点は悪しからず。

Azure Functions Storage table bindings
https://docs.microsoft.com/en-us/azure/azure-functions/functions-bindings-storage-table

連携その1. Azure Table Storage のエンティティを引数にもらう

まずは入力から。

つまり、ファンクションの実行時に、(本稿は C# スクリプトでのファンクション実装を前提にしているので) Run 静的メソッドの引数に Azure Table Storage のエンティティ ( ≒ レコード ) を渡してもらえる、という連携だ。

Azure Functions は、Azure Table Storage の入力連携に関して、"条件に該当するエンティティを最大 n 件取得して引数に渡してもらう" など、いくつかのシナリオに対応している。
ここでは、予め決めておいた特定の 1 エンティティを引数に渡してもらう方法について記す。

とりあえずは何か適当なファンクション (タイマーで起動とか、手動で起動とか) がすでに作成済みであるとしよう。

※以降では、タイマー起動のテンプレートで作成した既存のファンクションに対し、編集する例で示す。

function.json

まずはファンクションの引数や戻り値をどう外部と連携させるかなどを設定している JSON ファイル「function.json」を編集する。

※註: Azure ポータル Web サイト画面上からは、既定では "Standard editor" と称される GUI フォーム画面から function.jsonでの構成内容を編集可能となっている。しかし、この GUI フォーム画面は、本稿作成時点では不都合な振る舞いがあったりする (例えばここでの説明のように "読み取る最大件数" を省いて設定したい場合に、しかし GUI フォームの "Standard editor" では既定の "50" が再表示されてしまう、など) 。そのため、function.json をテキストとして直接編集する "Advanced editor" モードに切り替えて編集する (下図)。下記の要領で、bindings に type="table" の項目を追加する。

{

  "bindings": [

    {

      "name": "myTimer",

      "type": "timerTrigger",

      "direction": "in",

      "schedule": "0 0 0 * * *"

    },

    {

      "type": "table",

      "name": "tableEntity",

      "tableName": "Foo",

      "partitionKey": "fizz",

      "rowKey": "buzz",

      "connection": "StorageConnectionString",

      "direction": "in"

    }

  ],

  "disabled": true

}

プロパティ名と上記記載例から概ねくみ取ってもらえると思うが、function.json にて、"1 エントリ" を特定する情報をすべて記載しているのがポイントだ。

上記例に基づき解説を加えると下記のとおりだ。

• ストレージアカウントへの接続文字列を記載したアプリケーション構成のエントリ名 = "StorageConnectionString"
• そのアカウント中の Table 名 = "Foo"
• その Table 中の1エンティティを特定するパーティションキー = "fizz" と行キー = "buzz"

例によって、接続文字列などのパスワードやキーを含む設定内容は、アプリケーション構成のほうに設定しておき (下図)、function.json からは、その設定エントリ名で参照する仕組みだ。

run.csx

さて次は、対する C# (スクリプト) の実装。

まず、受け取るエンティティを表現するクラスを、run.csx の冒頭で記述する。
例えばこんな感じ。

public class FooBar {

    public string PartitionKey { get; set; }

    public string RowKey { get; set; }

    public string SomethingElse { get; set; }

}

TableEntity クラスから派生する必要がないのは知らなかった。
その代わり、PartitionKey と RowKey のプロパティは必須である。
あとは、function.json で指定した連携対象の Azure Table と同じ構造となるようにプロパティを備えれば OK だ。

あとは Run 静的メソッドの引数に、function.json で指定したのと同じ引数名で、先述のクラスの型を引数を受け取るようにすればよい。

public static void Run(

  TimerInfo myTimer, 

  FooBar tableEntity, 

  TraceWriter log

){

 ...

}

以上で、

• 所定の接続文字列で接続したストレージアカウントの、
• "Foo" テーブル中、
• パーティションキー = "fizz"、行キー = "buzz" のエンティティが、
• FooBar 型のオブジェクトにマッピング・逆シリアル化されて、
• それが引数 tableEntity に渡されて
• Run 静的メソッドが実行される

ようになる。

補足・感想

なお、function.json で指定した条件に合致するエンティティが見つからない場合は、"Object reference not set to an instance of an object." という例外で落ちるようだ。

このようなシナリオ ( 予め読み取り条件が固定の "特定の1エントリ" だけを参照したい ) では、エンティティの特定条件を function.json に宣言的に記述するだけで、C# コード上は Azure Table Storage にアクセスするコードを一切書かずに、いきなりエンティティにマッピングされたオブジェクトとして入手・参照できる。

これはかなりシンプルで便利だと思う。

先述のとおり、公式ドキュメントサイトを見るとわかるように、入力連携にはほかにもいくつか対応シナリオがある。
目的・要件と、Azure Functions 側で用意してあるシナリオ・連携方式が合致する場合は、効率よく記述できそうだ。

連携その2. Azure Table Storage にエンティティを追加する

次いで出力。

つまり、ファンクションの実行によって、Azure Table Storage にレコード追加される、という連携だ。

入力の例の場合と同様、何か作成済みのファンクションについて、話を進める。

function.json

まずは function.json から。

下記要領で連携方法の記述を追加する。

{

  "bindings": [

    {

      "name": "myTimer",

      "type": "timerTrigger",

      "direction": "in",

      "schedule": "0 0 0 * * *"

    },

    {

      "type": "table",

      "name": "outputTable",

      "tableName": "Foo",

      "connection": "StorageConnectionString",

      "direction": "out"

    }

  ],

  "disabled": true

}

コンテナへの接続文字列の指定と、エンティティ追加対象となるテーブル名までを function.json で指定しておく。

run.csx

次いで C# コード (run.csx)。

何はともあれ、対象 Table のエンティティを表すクラスを定義しておく。
ここは入力連携のときと同じ。

public class FooBar {

    public string PartitionKey { get; set; }

    public string RowKey { get; set; }

    public string SomethingElese { get; set; }

}

そして Run 静的メソッドの引数なのだが、function.json 中、name で指定したのと同じ引数名で、ICollector<エンティティにマッピングするクラス> 型の引数を追加する。

public static void Run(

  TimerInfo myTimer,

  ICollector<FooBar> outputTable, 

  TraceWriter log

)

{

  ...

}

あとは、この引数に渡された outputTable に対し、Add メソッドを使ってエンティティを表すクラスのインスタンスを追加するコードを書けばよい。

public static void Run(

  TimerInfo myTimer,

  ICollector<FooBar> outputTable, 

  TraceWriter log

)

{

  ...

  outputTable.Add(new FooBar{

    PartitionKey = "fizz",

    RowKey = "buzz",

    SomethingElse = "wow!"

  });

  ...

}

こうすることで、引数 outputTable に追加されたオブジェクトが、function.json で指定した Azure Table へのエンティティとして追加される。

補足・感想

1回の Run メソッド呼び出しでも、その Run メソッド中で繰り返し Add メソッドを呼び出して複数オブジェクトを追加すれば、追加したオブジェクトぶんの複数エンティティが Azure Table に追加される。

なお、パーティションキー・行キーが重複するオブジェクト(エンティティ)を追加した場合は、Run メソッドを抜けたあと、ICollector<T> の引数に追加した内容をフラッシュするタイミングで、下記のような例外が発生するようだ。

Error while handling parameter outputTable after function returned:. Microsoft.WindowsAzure.Storage: 0:The specified entity already exists

感想としては、Azure Table Storage との接続処理などをこまごま C# コード側に明記しなくて済むので、うれしい印象だ。

では、更新はどうやるの?

さて、ここまでのシナリオでは、エンティティを読み取るか、追加するかだけで、既存のエンティティを更新するシナリオがなかった。

冒頭で紹介した公式ドキュメントサイトを見ても、本記事投稿時点では、なんと、
更新の方法について記載がない。

ということで、更新をやるにはどうしたらよいか、粘り強くネット上で検索してみた。
すると StackOverflow に有力情報のスレッドを見つけた。

Azure Functions Table Binding: How do I update a row?
http://stackoverflow.com/questions/36792547/azure-functions-table-binding-how-do-i-update-a-row

上記スレッドによれば、ある程度は Azure Functions による連携支援はあるものの、基本的には従来通りの Azure Table Storage にアクセスする典型的なコードを記述するしかないとのことだ。

実際にやってみよう。

function.json

例によって、とりあえず何かファンクションはある状況から開始するとして。
function.json の記述はこうだ。

{

  "bindings": [

    {

      "name": "myTimer",

      "type": "timerTrigger",

      "direction": "in",

      "schedule": "0 0 0 * * *"

    },

    {

      "type": "table",

      "name": "cloudTable",

      "tableName": "Foo",

      "connection": "StorageConnectionString",

      "direction": "in"

    }

  ],

  "disabled": true

}

出力連携のときとほぼ同じだが、"direction" (方向) の指定が "out" (出力) ではなく "in" (入力) になってることに注意。

run.csx

そして C# コード (run.csx) 側であるが、まず冒頭に、Microsoft.WindowsAzure.Storage アセンブリへの参照が必要になる。

#r "Microsoft.WindowsAzure.Storage"

記述を短縮化するために、名前空間 Microsoft.WindowsAzure.Storage.Table も冒頭でオープン (using) しておこう。

using Microsoft.WindowsAzure.Storage.Table;

で、先述の連携方法では、何からも派生させることは不要だったエンティティを表すクラスだが、この更新系の実装においては TableEntry からの派生が必要となる。

public class FooBar : TableEntity {

    public string SomethingElese { get; set; };

    public FooBar(){ }

    public FooBar(string partionKey, string rowKey) : base(partionKey, rowKey){ }

}

そして Run 静的メソッド。

functuon.json 中で指定した引数名で引数追加となるが、引数の型は CloudTable とする。

public static void Run(

  TimerInfo myTimer, 

  CloudTable cloudTable, 

  TraceWriter log

){

  ...

}

あとは、こうして引数に渡された CkoudTable オブジェクトに対し、Azure Table Storage の読み書き処理を記述するだけだ。

例えば以下のような感じ。

public static void Run(

  TimerInfo myTimer, 

  CloudTable cloudTable, 

  TraceWriter log

){

    // パーティションキー="fizz",行キー="buzz"のエンティティを検索

    var query = TableOperation.Retrieve("fizz", "buzz");

    var result = cloudTable.Execute(query);

    

    // 該当エンティティがあればその参照を取得、なければ new で新規作成

    var foobar = result.Result as FooBar ?? new FooBar("fizz", "buzz");



    // エンティティの内容を書き換え

    foobar.SomethingElese = "hey!";

    

    // 無ければ追加、あれば更新

    var upsert = TableOperation.InsertOrReplace(foobar);

    cloudTable.Execute(upsert);

}

補足・感想

読み込みのみ、または新規追加のみの連携と比べると、抽象度がぐっと下がってしまい、"生の" Azure Table Storage 読み書きのコードとなってしまった。

とはいえ、接続を開設して CloudTable オブジェクトを用意するところまでは書かずに済む。

まとめ

Azure Table Storage に対し「読むだけ」「追加するだけ」の場合は、Azure Functions が用意してくれている連携の仕組み ( バインディング ) により、ファンクションを実装する側はずいぶんとシンプルに書けるようになっていい感じである。

いっぽうで、既存のエンティティを「更新」する仕組みはずいぶんと荒削りだ。
生々しい Azure Table Storage へのアクセスコードを書くしかないのが今日時点での実情である。

しかし先の StackOverflow のスレッドによれば、"These steps will get easier with our next release," とのこと。
今後の Azure Functions の進化・アップグレードにより、"更新" シナリオについてももっとシンプルな実装手段が提供されることが期待はできそうだ。

それまでの間は、Azure Table Stoarge に対し更新系の連携が必要な場合は、上記のとおり CloudTabel オブジェクトで連携する手法でしのぐのが無難そうである。

それでも接続文字列の取得からはじめてすべて自前で記述するよりはマシだろう。

以上、Azure Functions における Azure Table Storage バインディングのまとめとする。