Section 3: library functions
bson_append_oid() – The bson_append_oid() function shall append a new element to bson of type BSON_TYPE_OID. oid MUST be a pointer to a bson_oid_t. Synopsisbool bson_append_oid (bson_t *bson, const char *key, int key_length, const bson_oid_t *oid);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or…
bson_append_null() – The bson_append_null() function shall append a new element to bson of type BSON_TYPE_NULL. Synopsisbool bson_append_null (bson_t *bson, const char *key, int key_length);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine the length with strlen(3) \&.DescriptionThe bson_append_null(3) function shall…
bson_append_now_utc() – The bson_append_now_utc() function is a helper to get the current date and time in UTC and append it to bson as a BSON_TYPE_DATE_TIME element. Synopsisbool bson_append_now_utc (bson_t *bson, const char *key, int key_length);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or…
bson_append_minkey() – The bson_append_minkey() function shall append an element of type BSON_TYPE_MINKEY to a bson document. This is primarily used in queries and unlikely to be used when storing a document to MongoDB. Synopsisbool bson_append_minkey (bson_t *bson, const char *key, int key_length);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length…
bson_append_maxkey() – The bson_append_maxkey() function shall append an element of type BSON_TYPE_MAXKEY to a bson document. This is primarily used in queries and unlikely to be used when storing a document to MongoDB. Synopsisbool bson_append_maxkey (bson_t *bson, const char *key, int key_length);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length…
bson_append_iter() – TODO: Synopsisbool bson_append_iter (bson_t *bson, const char *key, int key_length, const bson_iter_t *iter);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine the length with strlen(3) \&.iter A bson_iter_t.DescriptionTODO: ReturnsTODO: ColophonThis page is part of libbson. Please report any…
bson_append_int64() – The bson_append_int64() function shall append a new element to bson containing a 64-bit signed integer. Synopsisbool bson_append_int64 (bson_t *bson, const char *key, int key_length, int64_t value);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine the length with strlen(3)…
bson_append_int32() – The bson_append_int32() function shall append a new element to bson containing a 32-bit signed integer. Synopsisbool bson_append_int32 (bson_t *bson, const char *key, int key_length, int32_t value);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine the length with strlen(3)…
bson_append_double() – The bson_append_double() function shall append a new element to a bson document of type double. Synopsisbool bson_append_double (bson_t *bson, const char *key, int key_length, double value);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine the length with strlen(3)…
bson_append_document_end() – The bson_append_document_end() function shall complete the appending of a document with bson_append_document_begin(). child is invalid after calling this function. Synopsisbool bson_append_document_end (bson_t *bson, bson_t *child);Parametersbson A bson_t \&.child The child bson_t initialized in a call to bson_append_document_begin(3) \&.DescriptionThe bson_append_document_end(3) function shall complete the appending of a document with bson_append_document_begin(3) \&. child is invalid…
bson_append_document_begin() – The bson_append_document_begin() function shall begin appending a sub-document to bson. Use child to add fields to the sub-document. When completed, call bson_append_document_end() to complete the element. Synopsisbool bson_append_document_begin (bson_t *bson, const char *key, int key_length, bson_t *child);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of…
bson_append_document() – The bson_append_document() function shall append child to bson using the specified key. The type of the field will be a document. Synopsisbool bson_append_document (bson_t *bson, const char *key, int key_length, const bson_t *value);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or…
bson_append_dbpointer() – The dbpointer field type is DEPRECATED and should only be used when interacting with legacy systems. Synopsisbool bson_append_dbpointer (bson_t *bson, const char *key, int key_length, const char *collection, const bson_oid_t *oid);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to…
bson_append_date_time() – The bson_append_date_time() function shall append a new element to a bson document containing a date and time with no timezone information. value is assumed to be in UTC format of milliseconds since the UNIX epoch. value MAY be negative. Synopsisbool bson_append_date_time (bson_t *bson, const char *key, int key_length, int64_t value);Parametersbson A bson_t \&.key…
bson_append_code_with_scope() – The bson_append_code_with_scope() function shall perform like bson_append_code() except it allows providing a scope to the javascript function in the form of a bson document. Synopsisbool bson_append_code_with_scope (bson_t *bson, const char *key, int key_length, const char *javascript, const bson_t *scope);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The…
bson_append_code() – The bson_append_code() function shall append a new element to bson using the UTF-8 encoded javascript provided. javascript must be a NULL terminated C string. Synopsisbool bson_append_code (bson_t *bson, const char *key, int key_length, const char *javascript);Parametersbson A bson_t \&.key The key name.key_length The length of key or -1 to use strlen().javascript A UTF-8…
bson_append_bool() – The bson_append_bool() function shall append a new element to bson containing the boolean provided. Synopsisbool bson_append_bool (bson_t *bson, const char *key, int key_length, bool value);Parametersbson A bson_t \&.key The name of the field.key_length The length of key or -1 to use strlen().value true or false.DescriptionThe bson_append_bool(3) function shall append a new element to…
bson_append_binary() – The bson_append_binary() function shall append a new element to bson containing the binary data provided. Synopsisbool bson_append_binary (bson_t *bson, const char *key, int key_length, bson_subtype_t subtype, const uint8_t *binary, uint32_t length);Parametersbson A bson_t \&.key The key name.key_length The length of key in bytes or -1 to use strlen().subtype A bson_subtype_t indicationg the binary…
bson_append_array_end() – The bson_append_array_end() function shall complete the appending of an array field started with bson_append_array_begin(). child is invalid after calling this function. Synopsisbool bson_append_array_end (bson_t *bson, bson_t *child);Parametersbson A bson_t \&.child The bson_t initialized in a call to bson_append_array_begin(3) \&.DescriptionThe bson_append_array_end(3) function shall complete the appending of an array field started with bson_append_array_begin(3) \&….
bson_append_array_begin() – The bson_append_array_begin() function shall begin appending an array field to bson. This allows for incrementally building a sub-array. Doing so will generally yield better performance as you will serialize to a single buffer. When done building the sub-array, the caller MUST call bson_append_array_end(). Synopsisbool bson_append_array_begin (bson_t *bson, const char *key, int key_length, bson_t…