IBM Cloud Community Summit 2018 での紹介資料 IBM Cloudant の変更履歴自動管理機能を紹介

1. IBM Cloudant の細かすぎて
伝わりにくい機能（その２）
データの変更履歴が自動管理できるらしい

2. BMXUG つきじ #4
IBM Cloudant 超活用法！ 禁断の「アレ」に挑戦してみました。。
https://bmxug.connpass.com/event/74656/

3. IBM Cloudant
• Apache CouchDB をベースに IBM が DBaaS 化して IBM Cloud から提供し
ているデータベースサービス
• Apache CouchDB の最新バージョンは 2.1.0
• IBM Cloudant は CouchDB 2.0.0 ベース
• この後に紹介する Design Document 機能は Apache CouchDB が所有している機能
• JSON ドキュメントをスケーラブルに格納する高速データベース
• 分散データベース
• 検索、トランザクション処理は苦手
• 「とにかく大量のデータを保存する」用途向き（ログ、IoT、・・・）
• Design Document という特殊なドキュメントで、設計要素を管理する
• View / List / Show
https://bmxug.connpass.com/event/74656/
→ 2.1.1
→ 2.2.0
2018/12 現在現在現在現在

4. 自己紹介
日本アイ・ビー・エム クラウドエバンジェリスト
Twitter: @dotnsf
Blog: http://dotnsf.blog.jp/
Email: dotnsf@jp.ibm.com
趣味： マンホール
木村 桂（きむら けい）
プログラマー
マンホールマップ: http://manholemap.juge.me/

5. Cloudant NoSQL データベース
使ってますか？
mongoDB でもいいですか？でもいいですか？でもいいですか？でもいいですか？ 別にいいよ。
でもね、、、

6. Cloudant で幸せになれること
• IBM Cloud のライトプランなら無料で 1GB まで使える
• デザインドキュメントでデータの UI も定義できる
• https://bmxug.connpass.com/event/74656/ 参照
• 単体で日本語全文検索できる（インデックスが日本語対応済み）
：
：
• ビルトインの変更履歴管理変更履歴管理変更履歴管理変更履歴管理機能

7. Cloudant のドキュメント操作 REST API 例
API 説明説明説明説明 リクエスト例リクエスト例リクエスト例リクエスト例 結果例結果例結果例結果例
GET /{db}/{_id} データベースから _id を指
定してドキュメントを１件取
得する
GET /db/123 {
_id: "123",
_rev: "1-1234",
name: "Kimura"
}
POST /{db} データベースにドキュメン
トを追加する
POST /db
{ name: "dotnsf" }
{
ok: true,
id: "456",
rev: "1-5678"
}
PUT /{db}/{_id} データベース内の既存ド
キュメントを更新する
PUT /db/123
{ rev: "1-1234", name: "木村" }
{
ok: true,
id: "123",
rev: "2-2345"
}
DELETE
/{db}/{_id}?rev={_rev}
データベース内の既存ド
キュメントを削除する（ソフ
トデリート）
DELETE /db/123?rev=2-2345 {
ok: true,
id: "123",
rev: "2-2345"
}
https://console.bluemix.net/docs/services/Cloudant/api/index.html

8. "_rev" ？

9. この _rev がリビジョンを管理している
{
_id: 1,
_rev: 1,
country: "Japan",
capital: "Tokyo"
}
{
_id: 2,
_rev: 1,
country: "USA",
capital: "N.Y."
}
{
_id: 3,
_rev: 1,
country: "China",
capital: "Beijing"
}
{
_id: 4,
_rev: 1,
country: "Spain",
capital: "Madrid"
}
{
_id: 5,
_rev: 1,
country: "France",
capital: "Paris"
}
{
_id: 6,
_rev: 1,
country: "Italy",
capital: "Roma"
}
{
_id: 2,
_rev: 2,
country: "USA",
capital: "Washington DC"
}
{
_id: 6,
_rev: 2,
country: "Italy",
capital: "Rome"
}
{
_id: 1,
_rev: 2,
country: "日本",
capital: "東京"
}
{
_id: 1,
_rev: 3,
country: "Japan",
capital: "Tokyo"
}
リビジョン（_rev）の値は自動管理 過去のリビジョンのデータも保存されている
実は同じ _id のドキュメントが複数存在している
（ただし最新リビジョンのものが有効とみなされる）

10. Cloudant のドキュメント操作 REST API 例
API 説明説明説明説明 リクエスト例リクエスト例リクエスト例リクエスト例 結果例結果例結果例結果例
GET /{db}/{_id} データベースから _id を指
定してドキュメントの最新
リビジョンの内容を１件取
得する
GET /db/123 {
_id: "123",
_rev: "1-1234",
name: "Kimura"
}
POST /{db} データベースにドキュメン
トとリビジョン管理を追加
する
POST /db
{ name: "dotnsf" }
{
ok: true,
id: "456",
rev: "1-5678"
}
PUT /{db}/{_id} データベース内の既存ド
キュメントのリビジョンを追
加する
PUT /db/123
{ rev: "1-1234", name: "木村" }
{
ok: true,
id: "123",
rev: "2-2345"
}
DELETE
/{db}/{_id}?rev={_rev}
データベース内の既存ド
キュメントをリビジョンを指
定して削除する（ソフトデ
リート）
DELETE /db/123?rev=2-2345 {
ok: true,
id: "123",
rev: "2-2345"
}
https://console.bluemix.net/docs/services/Cloudant/api/index.html
「更新」ではなく「更新」ではなく「更新」ではなく「更新」ではなく
「追加」している「追加」している「追加」している「追加」している

11. Cloudant のドキュメント操作 REST API 例
API 説明説明説明説明 リクエスト例リクエスト例リクエスト例リクエスト例 結果例結果例結果例結果例
GET /{db}/{_id} データベースから _id を指
定してドキュメントの全リビ
ジョンを取得する
GET /db/123?revs_info=true {
_id: "123",
_rev: "2-2345",
name: "Kimura",
_revs_info: [
{ id: "123", rev: "1-1234" },
{ id: "123", rev: "2-2345" }
]
}
データベースから _id と
_rev を指定してドキュメン
トの特定リビジョンの内容
を１件取得する
GET /db/123?rev=1-1234 {
_id: "123",
_rev: "1-1234",
name: "Kimura"
}
https://console.bluemix.net/docs/services/Cloudant/api/index.html
全リビジョン一覧全リビジョン一覧全リビジョン一覧全リビジョン一覧
特定リビジョン特定リビジョン特定リビジョン特定リビジョン
の詳細の詳細の詳細の詳細

12. デモ
https://github.com/dotnsf/cloudant_update_history

13. まとめ
• IBM Cloudant のドキュメントは _rev でリビジョンが自動管理されている
• Update 時も、実際は同じ _id と新しい _rev で新規作成している
• Delete 時は最新リビジョンのドキュメントがソフトデリートされる
• 論理的には _id はユニーク ID であるが、物理的には _id と _rev でユニーク ID
になる
• 特殊なパラメータをつけて API を実行することで古いリビジョンのドキュ
メントを取得することができる
• IBM Cloudant をデータストアに採用するだけで、ドキュメントの変更履
歴管理を行うことができる。

14. おまけ１
• IBM Cloudant(CouchDB) の文書をハードデリートする API
• POST /db/_purge
(http://docs.couchdb.org/en/stable/api/database/misc.html)
• npm(@cloudant/cloudant) では見当たらない・・・
• ただし、IBM Cloudant では未実装らしい・・・
$ curl -XPOST 'https://xxxxxxxxx-bluemix.cloudant.com/db20181130/_purge' -u 'xxxxxxxxx-bluemix:password' -H
'Content-Type: application/json' -d '{"_id":["_rev"]}'
{"error":"not_implemented","reason":"this feature is not yet implemented"}

15. おまけ２
• 本日の内容を IBM Cloud アドベントカレンダー(12/3)で紹介してます
：
https://qiita.com/advent-calendar/2018/ibmcloud

16. おまけ２
• 12:50 - 14:40 ブロックチェーン体験ハンズオンやります！