Scroll to navigation

BSON::Timestamp(3pm) User Contributed Perl Documentation BSON::Timestamp(3pm)

NAME

BSON::Timestamp - BSON type wrapper for timestamps

VERSION

version v1.12.2

SYNOPSIS

    use BSON::Types ':all';
    bson_timestamp( $seconds );
    bson_timestamp( $seconds, $increment );

DESCRIPTION

This module provides a BSON type wrapper for a BSON timestamp value.

Generally, it should not be used by end-users, but is provided for backwards compatibility.

ATTRIBUTES

seconds

A value representing seconds since the Unix epoch. The default is current value of "time()".

increment

A numeric value to disambiguate timestamps in the same second. The default is 0.

METHODS

TO_JSON

If the "BSON_EXTJSON" option is true, returns a hashref compatible with MongoDB's extended JSON <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst> format, which represents it as a document as follows:

    {"$timestamp" : { "t":<seconds>, "i":<increment> }}

If the "BSON_EXTJSON" option is false, an error is thrown, as this value can't otherwise be represented in JSON.

AUTHORS

  • David Golden <david@mongodb.com>
  • Stefan G. <minimalist@lavabit.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Stefan G. and MongoDB, Inc.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2020-08-14 perl v5.30.3