pymongo にて、insert_one() を実行した際の成功失敗の判定

Question

pymongo にて、insert_one() を実行した際、
成功したかどうかを知る為に、
皆様はどのように書かれていますでしょうか。。。
どなた様かどうかご教示いただけませんでしょうか。
どうぞよろしくお願いいたします。

成功すると、inserted_id には、_id の値が入ると思うのですが、

失敗した場合は、何も入らない！？(None)
もしくは、
inserted_id 自体が存在しなく、result には
オブジェクトが返って来るのではなく、None が帰ってくる！？
もし、前者なら、
以下のような感じでいいような気もするのですが、
いかがなものでしょうか。。。

result = collection.insert_one(document)

if result.inserted_id:
    status = True
else:
    status = False

print(status)

補足情報

Python: 3.8, MongoDB: 4.2

Answer 1

pymongo の insert_one() を見たのですが、pymongo.results.InsertOneResult が返ってきます。None は返ってきません。

mongodb のドキュメントをみたら、 db.collection.insertOne() の戻り値が以下になっていました。

Returns: A document containing:

* A boolean acknowledged as true if the operation ran with write concern or false if write concern was disabled.
* A field insertedId with the _id value of the inserted document.

acknowledged かな？ 書き込みに問題があったら False になるみたい。

mongodb のドキュメントの内容が、 pymongo のソースコードに書いてあるので、インタラクティブシェルで、内容を確認してみてください。

>>> from pymongo.results import InsertOneResult
>>> help(InsertOneResult)

or

>>> ...
>>> result = collection.insert_one(document)
>>> help(result)

Comments

[iBETA]

A boolean acknowledged as true if the operation ran with write concern or false if write concern was disabled.
ということは。。。
僕のプログラミングで言うのなら、
if result.inserted_id: で比較するのではなく
if result: に直した方が正解ということでしょうか。。。
どうぞよろしくお願いいたします。m(._.)m

[Bindi]

いえ、ここでの result は InserOneResult というオブジェクトです。そして、必ず返ってきます。なので、その条件式では常に 真になります。

私なら insert_one() に pymongo.write_concern.WriteConcern が引数で渡せるので、それで判断するかな。もしくは、get_collection() に pymongo.write_concern.WriteConcern を渡して、そっちのオブジェクトで。（ソースコードをみたら、 get_collection() に渡した、WriteConcern は、 index_one() で渡した WriteConncern と同じなので、どっちにするかは書いた人次第。）

なぜ、 WriteConncern で判断するかというと、 insertOneResult.acknowledged の値は、 WriteConcern があったら、pymongo.write_concern.WriteConcern.acknowledged の値を、 InsertOneResult.acknowledged にいれていて、無ければ insert_one の戻り値 acknowledged だけになるので、 WriteConncern がなくて False だったら、どうしようもなくなるから。

replication できるし、 index_one() って、そう単純ではなさそうですね。
説明するのも大変になってきた。これ見た人もよくわからないかもしれません。私もわからなくなってきた。

insert したときに取得できる _id って、すぐにそのあとで使うことはないとおもうので、_id で、insert の成功判断をしないのが、良いかもしれませんね。

mongodb をしっかり理解することが大事です。 pymongo って、 python で mongodb を操作できるドライバーですから、pymongo を理解しても mongodb は扱えない。