Utility for creating a BSONObj. More...

#include <bsonobjbuilder.h>

Inheritance diagram for mongo::BSONObjBuilder:

Public Member Functions
	BSONObjBuilder (int initsize=512)

	BSONObjBuilder (BufBuilder &baseBuilder)

BSONObjBuilder &	appendElements (BSONObj x)
	add all the fields from the object specified to this object

BSONObjBuilder &	appendElementsUnique (BSONObj x)
	add all the fields from the object specified to this object if they don't exist already

BSONObjBuilder &	append (const BSONElement &e)
	append element to the object we are building

BSONObjBuilder &	appendAs (const BSONElement &e, const StringData &fieldName)
	append an element but with a new name

BSONObjBuilder &	append (const StringData &fieldName, BSONObj subObj)
	add a subobject as a member

BSONObjBuilder &	appendObject (const StringData &fieldName, const char *objdata, int size=0)
	add a subobject as a member

BufBuilder &	subobjStart (const StringData &fieldName)
	add header for a new subobject and return bufbuilder for writing to the subobject's body

BSONObjBuilder &	appendArray (const StringData &fieldName, const BSONObj &subObj)
	add a subobject as a member with type Array.

BufBuilder &	subarrayStart (const StringData &fieldName)
	add header for a new subarray and return bufbuilder for writing to the subarray's body

BSONObjBuilder &	appendBool (const StringData &fieldName, int val)
	Append a boolean element.

BSONObjBuilder &	append (const StringData &fieldName, bool val)
	Append a boolean element.

BSONObjBuilder &	append (const StringData &fieldName, int n)
	Append a 32 bit integer element.

BSONObjBuilder &	append (const StringData &fieldName, unsigned n)
	Append a 32 bit unsigned element - cast to a signed int.

BSONObjBuilder &	append (const StringData &fieldName, long long n)
	Append a NumberLong.

BSONObjBuilder &	appendIntOrLL (const StringData &fieldName, long long n)
	appends a number.

BSONObjBuilder &	appendNumber (const StringData &fieldName, int n)
	appendNumber is a series of method for appending the smallest sensible type mostly for JS

BSONObjBuilder &	append (const StringData &fieldName, double n)
	Append a double element.

bool	appendAsNumber (const StringData &fieldName, const std::string &data)
	tries to append the data as a number

BSONObjBuilder &	appendOID (const StringData &fieldName, OID *oid=0, bool generateIfBlank=false)
	Append a BSON Object ID (OID type).

BSONObjBuilder &	append (const StringData &fieldName, OID oid)
	Append a BSON Object ID.

BSONObjBuilder &	genOID ()
	Generate and assign an object id for the _id field.

BSONObjBuilder &	appendTimeT (const StringData &fieldName, time_t dt)
	Append a time_t date.

BSONObjBuilder &	appendDate (const StringData &fieldName, Date_t dt)
	Append a date.

BSONObjBuilder &	appendRegex (const StringData &fieldName, const StringData &regex, const StringData &options="")
	Append a regular expression value.

BSONObjBuilder &	append (const StringData &fieldName, const char *str, int sz)
	Append a string element.

BSONObjBuilder &	append (const StringData &fieldName, const char *str)
	Append a string element.

BSONObjBuilder &	append (const StringData &fieldName, const std::string &str)
	Append a string element.

BSONObjBuilder &	append (const StringData &fieldName, const StringData &str)
	Append a string element.

void	appendNull ()
	Implements builder interface but no-op in ObjBuilder.

BSONObjBuilder &	appendNull (const StringData &fieldName)
	Append a Null element to the object.

BSONObjBuilder &	appendTimestamp (const StringData &fieldName, const Timestamp_t &ts=Timestamp_t())
	Append a Timestamp element to the object.

BSONObjBuilder &	appendBinData (const StringData &fieldName, int len, BinDataType type, const void *data)
	Append a binary data element.

BSONObjBuilder &	appendBinDataArrayDeprecated (const char fieldName, const void data, int len)
	Subtype 2 is deprecated.

BSONObjBuilder &	appendCodeWScope (const StringData &fieldName, const StringData &code, const BSONObj &scope)
	Append to the BSON object a field of type CodeWScope.

void	appendMinForType (const StringData &fieldName, int type)
	these are the min/max when comparing, not strict min/max elements for a given type

template<class T >
BSONObjBuilder &	append (const StringData &fieldName, const std::vector< T > &vals)
	Append an array of values.

template<class T >
BSONObjBuilder &	append (const StringData &fieldName, const std::set< T > &vals)
	Append a set of values.

template<class K , class T >
BSONObjBuilder &	append (const StringData &fieldName, const std::map< K, T > &vals)
	Append a map of values as a sub-object.

BSONObj	obj ()
	destructive The returned BSONObj will free the buffer when it is finished.

BSONObj	done ()
	Fetch the object we have built.

BSONObj	asTempObj ()
	Peek at what is in the builder, but leave the builder ready for more appends.

void	abandon ()
	Make it look as if "done" has been called, so that our destructor is a no-op.

BSONObjBuilderValueStream &	operator<< (const StringData &name)
	Stream oriented way to add field names and values.

BSONObjBuilder &	operator<< (GENOIDLabeler)
	Stream oriented way to add field names and values.

bool	owned () const

Detailed Description

Utility for creating a BSONObj.

See also the BSON() and BSON_ARRAY() macros.

Constructor & Destructor Documentation

◆ BSONObjBuilder() [1/2]

mongo::BSONObjBuilder::BSONObjBuilder ( int initsize = 512 )

inline

Parameters

initsize this is just a hint as to the final size of the object

◆ BSONObjBuilder() [2/2]

mongo::BSONObjBuilder::BSONObjBuilder ( BufBuilder & baseBuilder )

inline

Parameters

baseBuilder construct a BSONObjBuilder using an existing BufBuilder This is for more efficient adding of subobjects/arrays. See docs for subobjStart for example.

Member Function Documentation

◆ abandon()

void mongo::BSONObjBuilder::abandon ( )

inline

Make it look as if "done" has been called, so that our destructor is a no-op.

Do this if you know that you don't care about the contents of the builder you are destroying.

Note that it is invalid to call any method other than the destructor after invoking this method.

◆ append() [1/3]

BSONObjBuilder & mongo::BSONObjBuilder::append	(	const StringData &	fieldName,
		const char *	str,
		int	sz
	)

inline

Append a string element.

Parameters

sz	size includes terminating null character

◆ append() [2/3]

template<class K , class T >

BSONObjBuilder & mongo::BSONObjBuilder::append	(	const StringData &	fieldName,
		const std::map< K, T > &	vals
	)

inline

Append a map of values as a sub-object.

Note: the keys of the map should be StringData-compatible (i.e. strings).

◆ append() [3/3]

BSONObjBuilder & mongo::BSONObjBuilder::append	(	const StringData &	fieldName,
		OID	oid
	)

inline

Append a BSON Object ID.

Parameters

fieldName Field name, e.g., "_id".

Returns: the builder object

◆ appendArray()

BSONObjBuilder & mongo::BSONObjBuilder::appendArray	(	const StringData &	fieldName,
		const BSONObj &	subObj
	)

inline

add a subobject as a member with type Array.

Thus arr object should have "0", "1", ... style fields in it.

◆ appendAsNumber()

bool mongo::BSONObjBuilder::appendAsNumber	(	const StringData &	fieldName,
		const std::string &	data
	)

tries to append the data as a number

Returns: true if the data was able to be converted to a number

◆ appendBinData()

BSONObjBuilder & mongo::BSONObjBuilder::appendBinData	(	const StringData &	fieldName,
		int	len,
		BinDataType	type,
		const void *	data
	)

inline

Append a binary data element.

Parameters

fieldName	name of the field
len	length of the binary data in bytes
subtype	subtype information for the data.

See also: enum BinDataType in bsontypes.h. Use BinDataGeneral if you don't care about the type.

Parameters

data	the byte array

◆ appendBinDataArrayDeprecated()

BSONObjBuilder & mongo::BSONObjBuilder::appendBinDataArrayDeprecated	(	const char *	fieldName,
		const void *	data,
		int	len
	)

inline

Subtype 2 is deprecated.

Append a BSON bindata bytearray element.

Parameters

data	a byte array
len	the length of data

◆ appendCodeWScope()

BSONObjBuilder & mongo::BSONObjBuilder::appendCodeWScope	(	const StringData &	fieldName,
		const StringData &	code,
		const BSONObj &	scope
	)

inline

Append to the BSON object a field of type CodeWScope.

This is a javascript code fragment accompanied by some scope that goes with it.

◆ appendDate()

BSONObjBuilder & mongo::BSONObjBuilder::appendDate	(	const StringData &	fieldName,
		Date_t	dt
	)

Append a date.

Parameters

dt	a Java-style 64 bit date value, that is the number of milliseconds since January 1, 1970, 00:00:00 GMT

◆ appendIntOrLL()

BSONObjBuilder & mongo::BSONObjBuilder::appendIntOrLL	(	const StringData &	fieldName,
		long long	n
	)

inline

appends a number.

if n < max(int)/2 then uses int, otherwise long long

◆ appendOID()

BSONObjBuilder & mongo::BSONObjBuilder::appendOID	(	const StringData &	fieldName,
		OID *	oid = `0`,
		bool	generateIfBlank = `false`
	)

inline

Append a BSON Object ID (OID type).

Deprecated:: Generally, it is preferred to use the append append(name, oid) method for this.

◆ appendRegex()

BSONObjBuilder & mongo::BSONObjBuilder::appendRegex	(	const StringData &	fieldName,
		const StringData &	regex,
		const StringData &	options = `""`
	)

inline

Append a regular expression value.

Parameters

regex	the regular expression pattern
regex	options such as "i" or "g"

◆ appendTimeT()

BSONObjBuilder & mongo::BSONObjBuilder::appendTimeT	(	const StringData &	fieldName,
		time_t	dt
	)

inline

Append a time_t date.

Parameters

dt	a C-style 32 bit date value, that is the number of seconds since January 1, 1970, 00:00:00 GMT

◆ asTempObj()

BSONObj mongo::BSONObjBuilder::asTempObj ( )

inline

Peek at what is in the builder, but leave the builder ready for more appends.

The returned object is only valid until the next modification or destruction of the builder. Intended use case: append a field if not already there.

◆ done()

BSONObj mongo::BSONObjBuilder::done ( )

inline

Fetch the object we have built.

BSONObjBuilder still frees the object when the builder goes out of scope – very important to keep in mind. Use obj() if you would like the BSONObj to last longer than the builder.

◆ genOID()

BSONObjBuilder & mongo::BSONObjBuilder::genOID ( )

inline

Generate and assign an object id for the _id field.

_id should be the first element in the object for good performance.

◆ obj()

BSONObj mongo::BSONObjBuilder::obj ( )

inline

destructive The returned BSONObj will free the buffer when it is finished.

Returns: owned BSONObj

◆ owned()

bool mongo::BSONObjBuilder::owned ( ) const

inline

Returns: true if we are using our own bufbuilder, and not an alternate that was given to us in our constructor

◆ subobjStart()

BufBuilder & mongo::BSONObjBuilder::subobjStart ( const StringData & fieldName )

inline

add header for a new subobject and return bufbuilder for writing to the subobject's body

example:

BSONObjBuilder b; BSONObjBuilder sub (b.subobjStart("fieldName")); // use sub sub.done() // use b and convert to object

The documentation for this class was generated from the following file:

src/mongo/bson/bsonobjbuilder.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BSONObjBuilder() [1/2]

◆ BSONObjBuilder() [2/2]

Member Function Documentation

◆ abandon()

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ appendArray()

◆ appendAsNumber()

◆ appendBinData()

◆ appendBinDataArrayDeprecated()

◆ appendCodeWScope()

◆ appendDate()

◆ appendIntOrLL()

◆ appendOID()

◆ appendRegex()

◆ appendTimeT()

◆ asTempObj()

◆ done()

◆ genOID()

◆ obj()

◆ owned()

◆ subobjStart()