このブログの更新は Twitterアカウント @m_hiyama で通知されます。
Follow @m_hiyama

メールでのご連絡は hiyama{at}chimaira{dot}org まで。

はじめてのメールはスパムと判定されることがあります。最初は、信頼されているドメインから差し障りのない文面を送っていただけると、スパムと判定されにくいと思います。

参照用 記事

MongoDBにJSONオブジェクトを保存するときの注意

1年くらい前に、MongoDBJSONオブジェクトをドキュメントとして保存する方法について調べたことがあります。そのまま眠っていた短いメモを公開します。「最新の状況を確認してから」とも思ったのですが、そうするとメモは永久に眠ったままになりそうなので確認してません。という次第で、現状との食い違いがあるかもしれません。

まず、2010年に書いた記事「唐突に MongoDB の話」の「BSON」、「BSONとJSONの違い」という節で次の注意をしています。

BSONは名前も構造もJSONと似てますが、別物です。



BSONを「JSONのバイナリーフォーマット」と思うと大間違い。データモデルが違います。

そのとき指摘しておいたギャップは:

  1. BSONの数値は、「32-bit signed integer」、「64-bit signed integer」、「64-bit IEEE 754 floating point」の三種類がある。JSONでは、数値フォーマットの違いを区別する記法(例えば、1, 1L, 1.0 のような区別)はない。
  2. BSONのオブジェクトはフィールド(プロパティ)のシーケンスなので、フィールドの順序がある。一方、JSONオブジェクトの実現の多くでは、キーのあいだに順序がないハッシュ(連想配列)データを使っている。

他に問題になるかも知れない点:

  1. プロパティ名(フィールド名)にはドット('.')を入れられない。
  2. プロパティ名の先頭にドル記号('$')は使えない。
  3. プロパティ名の最大長は、UTF-8エンコーディングで255バイトである。
  4. 値の非存在を表すためにnullを使っている。
  5. ObjectIDは特別なデータである。

プロパティ名に使えない文字があるのはけっこう障害になるかもしれません。例えば、JSONではコメントが入れられないので、"$comment": "これはコメント." のようなプロパティで代用していたり、URIを "$ref" という名前のプロパティに入れたりしてました*1。こういう習慣とは衝突します。

「値の非存在がnull」とは、MongoDBの問い合わせオペレータで、{$exists: true} と {$ne: null} が同値なことから分かります。存在しないオブジェクトプロパティや配列項目には、あたかもnullが入っているように扱うのです。更新オペレータ $unset で配列項目を消すと、実際にはnullが代入されます。http://bsonspec.org/ を見ると、Undefinedというデータ型もある(あった)のですが deprecated です。

BSONを扱うライブラリでは、文字列やバイナリとな異なる ObjectID というネイティブ・データ型を用意していることが多いですが、JSONにはそんな特殊なデータ型はありません。ObjectIDを文字列としてエンコードする必要があります。

*1:[追記]これは僕の周辺でのローカルルールですが、ドル記号で始まるプロパティ名を特殊な用途に予約することは、比較的よく行われている気がします。[/追記]