bson_as_json (3) - Linux Manuals

bson_as_json: The bson_as_json() function shall encode bson as a JSON encoded UTF-8 string.

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 responsible for freeing the resulting UTF-8 encoded string by calling bson_free(3) with the result.

If non-NULL, length will be set to the length of the result in bytes.

RETURNS

If successful, a newly allocated UTF-8 encoded string and length is set.

Upon failure, NULL is returned.

EXAMPLE

char *str = bson_as_json (doc, NULL);
printf ("%s\n", str);
bson_free (str);

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Pages related to bson_as_json

  • bson_append_array (3) - The bson_append_array() function shall append child to bson using the specified key. The type of the field will be an array, but it is the responsibility of the caller to ensure that the keys of child are properly formatted with string keys such as "0", "1", "2" and so forth.
  • bson_append_array_begin (3) - 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().
  • bson_append_array_end (3) - 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.
  • bson_append_binary (3) - The bson_append_binary() function shall append a new element to bson containing the binary data provided.
  • bson_append_bool (3) - The bson_append_bool() function shall append a new element to bson containing the boolean provided.
  • bson_append_code (3) - 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.
  • bson_append_code_with_scope (3) - 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.
  • bson_append_date_time (3) - 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.
  • bson_append_dbpointer (3) - The dbpointer field type is DEPRECATED and should only be used when interacting with legacy systems.
  • bson_append_document (3) - The bson_append_document() function shall append child to bson using the specified key. The type of the field will be a document.