---
name: "BSON::MaxKey"
section: "3pm"
platform: "linux"
package: "libbson-perl"
version: "1.12.2-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/BSON::MaxKey"
---

# BSON::MaxKey(3pm)

BSON type wrapper for MaxKey

## NAME

BSON::MaxKey - BSON type wrapper for MaxKey

## VERSION

version v1.12.2

## 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://github.com/mongodb/specifications/blob/master/source/extended-json.rst\> 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\>

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