Linux Manuals session 3

NAME bson_as_json() – The bson_as_json() function shall encode bson as a JSON encoded UTF-8 string. SYNOPSIS char * bson_as_json(const bson_t *bson, size_t *length); PARAMETERS bson A bson_t \&. length An optional location for the length of the resulting string. DESCRIPTION The bson_as_json(3) function shall encode bson as a JSON encoded UTF-8 string. The caller is…

NAME bson_append_value() – Appends a new field to bson by determining the boxed type in value. This is useful if you want to copy fields between documents but do not know the field type until runtime. SYNOPSIS bool bson_append_value(bson_t *bson, const char *key, int key_length, const bson_value_t *value); PARAMETERS bson A bson_t \&. key An…

NAME bson_append_utf8() – The bson_append_utf8() function shall append a UTF-8 encoded string to bson. SYNOPSIS bool bson_append_utf8(bson_t *bson, const char *key, int key_length, const char *value, int length); PARAMETERS bson 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…

NAME bson_append_undefined() – The bson_append_undefined() function shall append a new element to bson of type BSON_TYPE_UNDEFINED. Undefined is common in Javascript. However, this element type is deprecated and should not be used in new code. SYNOPSIS bool bson_append_undefined(bson_t *bson, const char *key, int key_length); PARAMETERS bson A bson_t \&. key An ASCII C string containing…

NAME bson_append_timeval() – The bson_append_timeval() function is a helper that takes a _struct timeval_ instead of milliseconds since the UNIX epoch. SYNOPSIS bool bson_append_timeval(bson_t *bson, const char *key, int key_length, struct timeval *value); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of the field. key_length The length of key in…

NAME bson_append_timestamp() – This function is not similar in functionality to bson_append_date_time(). Timestamp elements are different in that they include only second precision and an increment field. SYNOPSIS bool bson_append_timestamp(bson_t *bson, const char *key, int key_length, uint32_t timestamp, uint32_t increment); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of the…

NAME bson_append_time_t() – The bson_append_time_t() function is a helper that takes a time_t instead of milliseconds since the UNIX epoch. SYNOPSIS bool bson_append_time_t(bson_t *bson, const char *key, int key_length, time_t value); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of the field. key_length The length of key in bytes, or…

NAME bson_append_symbol() – Appends a new field to bson of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code. SYNOPSIS bool bson_append_symbol(bson_t *bson, const char *key, int key_length, const char *value, int length); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of the field….

NAME bson_append_regex() – Appends a new field to bson of type BSON_TYPE_REGEX. regex should be the regex string. options should contain the options for the regex. SYNOPSIS bool bson_append_regex(bson_t *bson, const char *key, int key_length, const char *regex, const char *options); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of…

NAME 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. SYNOPSIS bool bson_append_oid(bson_t *bson, const char *key, int key_length, const bson_oid_t *oid); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of the field. key_length The length…

NAME bson_append_null() – The bson_append_null() function shall append a new element to bson of type BSON_TYPE_NULL. SYNOPSIS bool bson_append_null(bson_t *bson, const char *key, int key_length); PARAMETERS bson 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…

NAME 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. SYNOPSIS bool bson_append_now_utc(bson_t *bson, const char *key, int key_length); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of the field. key_length The length…

NAME 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. SYNOPSIS bool bson_append_minkey(bson_t *bson, const char *key, int key_length); PARAMETERS bson A bson_t \&. key An ASCII C string containing the…

NAME 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. SYNOPSIS bool bson_append_maxkey(bson_t *bson, const char *key, int key_length); PARAMETERS bson A bson_t \&. key An ASCII C string containing the…

NAME bson_append_iter() – TODO: SYNOPSIS bool bson_append_iter(bson_t *bson, const char *key, int key_length, const bson_iter_t *iter); PARAMETERS bson 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. DESCRIPTION TODO: RETURNS TODO:…

NAME bson_append_int64() – The bson_append_int64() function shall append a new element to bson containing a 64-bit signed integer. SYNOPSIS bool bson_append_int64(bson_t *bson, const char *key, int key_length, int64_t value); PARAMETERS bson 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…

NAME bson_append_int32() – The bson_append_int32() function shall append a new element to bson containing a 32-bit signed integer. SYNOPSIS bool bson_append_int32(bson_t *bson, const char *key, int key_length, int32_t value); PARAMETERS bson 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…

NAME bson_append_double() – The bson_append_double() function shall append a new element to a bson document of type double. SYNOPSIS bool bson_append_double(bson_t *bson, const char *key, int key_length, double value); PARAMETERS bson 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…

NAME 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. SYNOPSIS bool bson_append_document_end (bson_t *bson, bson_t *child); PARAMETERS bson A bson_t \&. child The child bson_t initialized in a call to bson_append_document_begin(3) \&. DESCRIPTION The bson_append_document_end(3) function shall complete the appending of a…

NAME 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. SYNOPSIS bool bson_append_document_begin(bson_t *bson, const char *key, int key_length, bson_t *child); PARAMETERS bson A bson_t \&. key An ASCII C string containing the name of the…