Perl Diver 2.33
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

BSON::Timestamp

Name BSON::Timestamp
Version v1.12.2
Located at /usr/share/perl5
File /usr/share/perl5/BSON/Timestamp.pm
Is Core No
Search CPAN for this module BSON::Timestamp
Documentation BSON::Timestamp
Module Details BSON::Timestamp


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


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

Perl Diver brought to you by ScriptSolutions.com © 1997- 2026