bson_append_timestamp (3) - Linux Manuals

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.

Command to display bson_append_timestamp manual in Linux: $ man 3 bson_append_timestamp

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 field.

key_length: The length of key in bytes, or -1 to determine the length with strlen(3) \&.

timestamp: A uint32_t.

increment: A uint32_t.

DESCRIPTION

This function is not similar in functionality to bson_append_date_time(3) \&. Timestamp elements are different in that they include only second precision and an increment field.

They are primarily used for intra-MongoDB server communication.

The bson_append_timestamp(3) function shall append a new element of type BSON_TYPE_TIMESTAMP.

RETURNS

true if the operation was applied successfully, otherwise false and bson should be discarded.

COLOPHON

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