binary
– Tools for representing binary data to be stored in MongoDB¶
-
bson.binary.
BINARY_SUBTYPE
= 0¶ BSON binary subtype for binary data.
This is the default subtype for binary data.
-
bson.binary.
FUNCTION_SUBTYPE
= 1¶ BSON binary subtype for functions.
-
bson.binary.
OLD_BINARY_SUBTYPE
= 2¶ Old BSON binary subtype for binary data.
This is the old default subtype, the current default is
BINARY_SUBTYPE
.
-
bson.binary.
OLD_UUID_SUBTYPE
= 3¶ Old BSON binary subtype for a UUID.
uuid.UUID
instances will automatically be encoded bybson
using this subtype.New in version 2.1.
-
bson.binary.
UUID_SUBTYPE
= 4¶ BSON binary subtype for a UUID.
This is the new BSON binary subtype for UUIDs. The current default is
OLD_UUID_SUBTYPE
but will change to this in a future release.Changed in version 2.1: Changed to subtype 4.
-
bson.binary.
STANDARD
= 4¶ The standard UUID representation.
uuid.UUID
instances will automatically be encoded to and decoded from BSON binary, using RFC-4122 byte order with binary subtypeUUID_SUBTYPE
.New in version 3.0.
-
bson.binary.
PYTHON_LEGACY
= 3¶ The Python legacy UUID representation.
uuid.UUID
instances will automatically be encoded to and decoded from BSON binary, using RFC-4122 byte order with binary subtypeOLD_UUID_SUBTYPE
.New in version 3.0.
-
bson.binary.
JAVA_LEGACY
= 5¶ The Java legacy UUID representation.
uuid.UUID
instances will automatically be encoded to and decoded from BSON binary subtypeOLD_UUID_SUBTYPE
, using the Java driver’s legacy byte order.Changed in version 3.6: BSON binary subtype 4 is decoded using RFC-4122 byte order.
New in version 2.3.
-
bson.binary.
CSHARP_LEGACY
= 6¶ The C#/.net legacy UUID representation.
uuid.UUID
instances will automatically be encoded to and decoded from BSON binary subtypeOLD_UUID_SUBTYPE
, using the C# driver’s legacy byte order.Changed in version 3.6: BSON binary subtype 4 is decoded using RFC-4122 byte order.
New in version 2.3.
-
bson.binary.
MD5_SUBTYPE
= 5¶ BSON binary subtype for an MD5 hash.
-
bson.binary.
USER_DEFINED_SUBTYPE
= 128¶ BSON binary subtype for any user defined structure.
-
class
bson.binary.
Binary
(data, subtype=BINARY_SUBTYPE)¶ Bases:
str
Representation of BSON binary data.
This is necessary because we want to represent Python strings as the BSON string type. We need to wrap binary data so we can tell the difference between what should be considered binary data and what should be considered a string when we encode to BSON.
Raises TypeError if data is not an instance of
str
(bytes
in python 3) or subtype is not an instance ofint
. Raises ValueError if subtype is not in [0, 256).Note
In python 3 instances of Binary with subtype 0 will be decoded directly to
bytes
.Parameters: - data: the binary data to represent
- subtype (optional): the binary subtype to use
-
subtype
¶ Subtype of this binary data.
-
class
bson.binary.
UUIDLegacy
(obj)¶ Bases:
bson.binary.Binary
UUID wrapper to support working with UUIDs stored as PYTHON_LEGACY.
>>> import uuid >>> from bson.binary import Binary, UUIDLegacy, STANDARD >>> from bson.codec_options import CodecOptions >>> my_uuid = uuid.uuid4() >>> coll = db.get_collection('test', ... CodecOptions(uuid_representation=STANDARD)) >>> coll.insert_one({'uuid': Binary(my_uuid.bytes, 3)}).inserted_id ObjectId('...') >>> coll.find({'uuid': my_uuid}).count() 0 >>> coll.find({'uuid': UUIDLegacy(my_uuid)}).count() 1 >>> coll.find({'uuid': UUIDLegacy(my_uuid)})[0]['uuid'] UUID('...') >>> >>> # Convert from subtype 3 to subtype 4 >>> doc = coll.find_one({'uuid': UUIDLegacy(my_uuid)}) >>> coll.replace_one({"_id": doc["_id"]}, doc).matched_count 1 >>> coll.find({'uuid': UUIDLegacy(my_uuid)}).count() 0 >>> coll.find({'uuid': {'$in': [UUIDLegacy(my_uuid), my_uuid]}}).count() 1 >>> coll.find_one({'uuid': my_uuid})['uuid'] UUID('...')
Raises TypeError if obj is not an instance of
UUID
.Parameters: - obj: An instance of
UUID
.
-
uuid
¶ UUID instance wrapped by this UUIDLegacy instance.
- obj: An instance of