MongoDB Inc > BSON > BSON::Timestamp

Download:
BSON-v1.0.0.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: v1.0.0   Source  

NAME ^

BSON::Timestamp - BSON type wrapper for timestamps

VERSION ^

version v1.0.0

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) 2016 by Stefan G. and MongoDB, Inc.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
syntax highlighting: