SysTutorials Posts

NAME bson_context_new() – Creates a new bson_context_t. This is rarely needed as bson_context_get_default() serves most use-cases. SYNOPSIS bson_context_t * bson_context_new (bson_context_flags_t flags); PARAMETERS flags A bson_context_flags_t \&. DESCRIPTION Creates a new bson_context_t \&. This is rarely needed as bson_context_get_default(3) serves most use-cases. RETURNS A newly allocated bson_context_t that should be freed with bson_context_destroy \&. COLOPHON…

NAME bson_context_get_default() – None SYNOPSIS bson_context_t * bson_context_get_default (void) BSON_GNUC_CONST; RETURNS The bson_context_get_default(3) function shall return the default, thread-safe, bson_context_t for the process. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index

NAME bson_context_destroy() – The bson_context_destroy() function shall release all resources associated with context. SYNOPSIS void bson_context_destroy(bson_context_t *context); PARAMETERS context A bson_context_t \&. DESCRIPTION The bson_context_destroy(3) function shall release all resources associated with context \&. This should be called when you are no longer using a bson_context_t that you have allocated with bson_context_new(3) \&. COLOPHON This…

NAME bson_concat() – The bson_concat() function shall append the contents of src to dst. SYNOPSIS bool bson_concat (bson_t *dst, const bson_t *src); PARAMETERS dst A bson_t \&. src A bson_t \&. DESCRIPTION The bson_concat(3) function shall append the contents of src to dst \&. RETURNS true if the operation was applied successfully, otherwise false and…

NAME bson_compare() – The bson_compare() function shall compare two bson documents for equality. SYNOPSIS int bson_compare(const bson_t *bson, const bson_t *other); PARAMETERS bson A bson_t \&. other A bson_t \&. DESCRIPTION The bson_compare(3) function shall compare two bson documents for equality. This can be useful in conjunction with _qsort()_. If equal, 0 is returned. NOTE…

NAME bson_check_version() – Check at runtime if this release of libbson meets a required version. SYNOPSIS bool bson_check_version(int required_major, int required_minor, int required_micro); PARAMETERS required_major The minimum major version required. required_minor The minimum minor version required. required_micro The minimum micro version required. DESCRIPTION Check at runtime if this release of libbson meets a required version….

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…