go.mercari.io/datastore@v1.8.2/doc_ja.go (about)

     1  package datastore // import "go.mercari.io/datastore"
     2  
     3  /*
     4  Package datastore は、(AppEngine|Cloud) Datastoreの抽象表現を持ちます。
     5  https://cloud.google.com/datastore/docs/ もしくは https://cloud.google.com/appengine/docs/standard/go/datastore/ をよく読みましょう。
     6  また、オリジナルのライブラリとして https://godoc.org/cloud.google.com/go/datastore もしくは https://godoc.org/google.golang.org/appengine/datastore も確認すると良いでしょう。
     7  
     8  
     9  基本的な使い方
    10  
    11  https://godoc.org/go.mercari.io/datastore/clouddatastore か https://godoc.org/go.mercari.io/datastore/aedatastore を見てください。
    12  各パッケージのFromContextを使って Client を作成します。
    13  
    14  このドキュメントの後半に、各パッケージから移行する際の注意点をまとめてあります。
    15  そちらも御覧ください。
    16  
    17  このライブラリはより設計が新しいCloud DatastoreのAPIをベースにしています。
    18  Cloud Datastoreにしかない flatten タグも導入しているので、AE Datastoreから移行する際は注意が必要です。
    19  詳細は後述します。
    20  困ったら https://godoc.org/go.mercari.io/datastore/clouddatastore を見ると解決の糸口があるかもしれません。
    21  
    22  
    23  本パッケージの目的は3つあります。
    24  	1. ミドルウェア層を提供し、アプリケーションの価値とは直接関係がない処理を書く必要を減らす
    25  	2. AppEngine, Cloud、両方のDatastoreに対して同一のインタフェースを提供する。
    26  	3. Single Get, Signle Putなどをバッチ処理化する。
    27  
    28  
    29  ミドルウェア層
    30  
    31  アプリケーションの価値とは直接関係のない、速度や安定性、運用のための機能が必要になる場合があります。
    32  そういった機能はミドルウェアとして抽象化し、利用することができます。
    33  
    34  例えばこんなケースはどうでしょうか。
    35  DatastoreにEntityをPutしたら、MemcacheやRedisにSetしておく。
    36  次にDatastoreからGetするときはまずMemcacheなどからGetし、無ければDatastoreから改めてGetする。
    37  これらをすべてのKind、すべてのEntityの操作で行うのは、ひどく面倒です。
    38  しかし、全てのDatastoreとのRPCに介入し、統一的に処理を差し込めるミドルウェアであれば、アプリケーションから見えないところでこの処理を行うことができます。
    39  
    40  別のケースとして、RPCにありがちなこととして処理が稀に失敗することがあります。
    41  失敗したら単にリトライするだけで処理が成功する場合も多いです。
    42  これも、全ての処理で簡単に行うには、ミドルウェアでリトライ処理をかけるのが適しています。
    43  
    44  既に用意されているミドルウェアが知りたい場合は https://godoc.org/go.mercari.io/datastore/dsmiddleware を参照してください。
    45  
    46  
    47  AppEngineとCloudで同一のインタフェースを提供する
    48  
    49  AppEngine DatastoreとCloud Datastoreに対して、同一のインタフェースが提供されています。
    50  この2つは互換性があり、Clientを作った後は全く同様のコードで動かすことができます。
    51  
    52  例えば本番環境ではAE Datastoreを使って、UnitTestではCloud Datastore Emulatorを使うということもできます。
    53  goappを避けることができれば、テストが高速になったりIDEからデバッグの支援が受けやすくなったりするかもしれません。
    54  また、AE Datastoreで運用しているシステムについて、ローカル環境からCloud Datastoreを介してデータを読み込むこともできるでしょう。
    55  
    56  注意点として、AE DatastoreとCloud DatastoreのRPCのストレージ本体は共有されていますが、APIレベルでの表現力には差があります。
    57  うかつにAE Datastoreで書いたデータをCloud Datastoreで読んで、変更して、更新しないようにしてください。
    58  AE Datastore側のAPIから読み取れなくなる可能性があります。
    59  これについて、我々は厳密にはテストを行っていません。
    60  
    61  
    62  Signle Get, Signle Putのバッチ処理化
    63  
    64  Datastoreの操作にはRPCのためのネットワークに関するレイテンシがほんの少しあります。
    65  10個のEntityを取得するとき、ループして10回Getするよりも1回のGetMultiのほうがより良いということです。
    66  ところが、我々は複数の処理を1回にまとめるのが苦手です。
    67  例えば、Post KindにQueryを投げて、得られたPostが持っているComment IDのリストを使ってCommentのリストをGetしたいとします。
    68  これは、ちゃんとしたコードを書けば1回のQuery+1回のGetMultiで十分ですが、Commentのリストを適切なPostと紐付ける作業が待っています。
    69  一方、1回のQuery+Postの数だけCommentをGetMultiするコードは簡単に書けるでしょう。
    70  ここで、PutやGetをキューに入れておいて、あとでまとめて実行してくれる仕組みがあると都合がよさそうです。
    71  
    72  これを実現したのが Batch() です。
    73  https://godoc.org/go.mercari.io/datastore/#pkg-examples に例があります。
    74  
    75  
    76  goonを置き換えるboom
    77  
    78  私はgoonが好きです。
    79  ですので、本ライブラリと組み合わせて使える https://godoc.org/go.mercari.io/datastore/boom を作りました。
    80  
    81  
    82  本ライブラリへの移行方法（AE, Cloud共通）
    83  
    84  	*datastore.Key を datastore.Key に置き換える。
    85  	*datastore.Query を datastore.Query に置き換える。
    86  	*datastore.Iterator を datastore.Iterator に置き換える。
    87  
    88  AE Datastoreからの移行
    89  
    90  	go.mercari.io/datastore と go.mercari.io/datastore/aedatastore をimportする。
    91  	datastoreパッケージの関数を使っているものをFromContextとClientのメソッド呼び出しに書き換える。
    92  	err.(appengine.MultiError) を err.(datastore.MultiError) に置き換える。
    93  	appengine.BlobKey を使うのをやめ、stringに置き換える。
    94  	google.golang.org/appengine/datastore.Done を google.golang.org/api/iterator.Done に置き換える。
    95  	key.IntID() を key.ID() に置き換える。
    96  	key.StringID() を key.Name() に置き換える。
    97  	structをネストさせている場合、該当フィールドに `datastore:",flatten"` を適用する。
    98  	datastore.TransactionOptions はサポートされないので削除する。
    99  	google.golang.org/appengine/datastore をimportしている箇所がないかチェックし、あれば go.mercari.io/datastore に置き換える。
   100  
   101  Cloud Datastoreからの移行
   102  
   103  	go.mercari.io/datastore と go.mercari.io/datastore/clouddatastore をimportする。
   104  	datastoreパッケージの関数を使っているものをFromContextとClientのメソッド呼び出しに書き換える。
   105  	*datastore.Commit を datastore.Commit に置き換える。
   106  	cloud.google.com/go/datastore をimportしている箇所がないかチェックし、あれば go.mercari.io/datastore に置き換える。
   107  
   108  goonからboomへの移行
   109  
   110  	*goon.Goon を *boom.Boom に置き換える。
   111  	goon.FromContext(ctx) を ds, _ := aedatastore.FromContext(ctx); boom.FromClient(ctx, ds) に置き換える。
   112  */