1BSON::MaxKey(3)       User Contributed Perl Documentation      BSON::MaxKey(3)
2
3
4

NAME

6       BSON::MaxKey - BSON type wrapper for MaxKey
7

VERSION

9       version v1.12.2
10

SYNOPSIS

12           use BSON::Types ':all';
13
14           bson_maxkey();
15

DESCRIPTION

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

METHODS

21   TO_JSON
22       If the "BSON_EXTJSON" option is true, returns a hashref compatible with
23       MongoDB's extended JSON
24       <https://github.com/mongodb/specifications/blob/master/source/extended-
25       json.rst> format, which represents it as a document as follows:
26
27           {"$maxKey" : 1}
28
29       If the "BSON_EXTJSON" option is false, an error is thrown, as this
30       value can't otherwise be represented in JSON.
31

AUTHORS

33       •   David Golden <david@mongodb.com>
34
35       •   Stefan G. <minimalist@lavabit.com>
36

38       This software is Copyright (c) 2020 by Stefan G. and MongoDB, Inc.
39
40       This is free software, licensed under:
41
42         The Apache License, Version 2.0, January 2004
43
44
45
46perl v5.38.0                      2023-07-20                   BSON::MaxKey(3)
Impressum