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.

New in version 1.5.

bson.binary.FUNCTION_SUBTYPE = 1

BSON binary subtype for functions.

New in version 1.5.

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.

New in version 1.7.

bson.binary.OLD_UUID_SUBTYPE = 3

Old BSON binary subtype for a UUID.

uuid.UUID instances will automatically be encoded by bson 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.

New in version 1.5.

bson.binary.JAVA_LEGACY = 5

Used with pymongo.collection.Collection.uuid_subtype to specify that UUIDs should be stored in the legacy byte order used by the Java driver.

uuid.UUID instances will automatically be encoded by bson using OLD_UUID_SUBTYPE.

New in version 2.3.

bson.binary.CSHARP_LEGACY = 6

Used with pymongo.collection.Collection.uuid_subtype to specify that UUIDs should be stored in the legacy byte order used by the C# driver.

uuid.UUID instances will automatically be encoded by bson using OLD_UUID_SUBTYPE.

New in version 2.3.

bson.binary.MD5_SUBTYPE = 5

BSON binary subtype for an MD5 hash.

New in version 1.5.

bson.binary.USER_DEFINED_SUBTYPE = 128

BSON binary subtype for any user defined structure.

New in version 1.5.

class bson.binary.Binary(data[, subtype=BINARY_SUBTYPE])

Bases: str

x.__init__(...) initializes x; see help(type(x)) for signature

subtype

Subtype of this binary data.

class bson.binary.UUIDLegacy(obj)

Bases: bson.binary.Binary

x.__init__(...) initializes x; see help(type(x)) for signature

uuid

UUID instance wrapped by this UUIDLegacy instance.

Previous topic

bson – BSON (Binary JSON) Encoding and Decoding

Next topic

code – Tools for representing JavaScript code

This Page