Man pages sections > man3 > BSON::MaxKey

BSON::MaxKey - BSON type wrapper for MaxKey

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

NAME

BSON::MaxKey - BSON type wrapper for MaxKey

VERSION

version v1.4.0

SYNOPSIS

    use BSON::Types ':all';
    bson_maxkey();

DESCRIPTION

This module provides a BSON type wrapper for the special BSON "MaxKey" type. The object returned is a singleton.

METHODS

TO_JSON

If the "BSON_EXTJSON" option is true, returns a hashref compatible with MongoDB's extended JSON <https://docs.mongodb.org/manual/reference/mongodb-extended-json/> format, which represents it as a document as follows:
    {"$maxKey" : 1}
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>
This software is Copyright (c) 2017 by Stefan G. and MongoDB, Inc.
This is free software, licensed under:
  The Apache License, Version 2.0, January 2004
2017-09-06 perl v5.26.0