mongo.bson.buffer.start.object: Start a subobject within a mongo.bson.buffer

Description Usage Arguments Details Value See Also Examples

View source: R/bson.R

Description

BSON documents may themselves contain nested documents. Call this function to start a subobject within a mongo.bson.buffer.

Usage

1

Arguments

buf

(mongo.bson.buffer) The buffer object to which to append.

name

(string) The name (key) of the subobject to be appended to the buffer.

Details

mongo.bson.buffer.finish.object() must be called when finsihed appending subfields.
(mongo.bson.buffer.start.object(), mongo.bson.buffer.start.array())
and mongo.bson.buffer.finish.object() may be called in a stackwise (LIFO) order to further nest documents and arrays.

Value

TRUE if successful; otherwise, FALSE if an error occured appending the data.

See Also

mongo.bson,
mongo.bson.buffer,
mongo.bson.buffer.finish.object,
mongo.bson.buffer.start.array,
mongo.bson.buffer.append.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
buf <- mongo.bson.buffer.create()
mongo.bson.buffer.start.object(buf, "name")
mongo.bson.buffer.append(buf, "first", "Jeff")
mongo.bson.buffer.append(buf, "last", "Davis")
mongo.bson.buffer.finish.object(buf)
mongo.bson.buffer.append(buf, "city", "Toronto")
b <- mongo.bson.from.buffer(buf)

# the above produces a BSON object of the form:
# { "name" : { "first" : "Jeff", "last" : "Davis" }, "city" : "Toronto" }

jonkatz2/rmongodb documentation built on May 19, 2019, 7:30 p.m.