MaxMin...der::XS(3pm)

✨ NAME ✨

okay bestie, welcome to the manual page for MaxMind::DB::Reader::XS (yes, the 3pm one, you're in the right place 🫢) β€” it's a fast XS implementation of the MaxMind DB reader, and it's kind of a big deal.


🌸 VERSION 🌸

version 1.000009


πŸŽ€ SYNOPSIS πŸŽ€

look, it's literally two lines, you got this:

my $reader = MaxMind::DB::Reader->new( file => 'path/to/database.mmdb' );

my $record = $reader->record_for_address('1.2.3.4');

πŸ’– DESCRIPTION πŸ’–

okay so the way this works is iconic: you literally just install this module, and that alone makes MaxMind::DB::Reader swap over to the XS implementation. no config, no rituals, no nothing. and it is so much faster than the Perl implementation. not me being dramatic, it's just true. πŸ’…

the XS implementation links against the libmaxminddb library β€” you can find it over at <http://maxmind.github.io/libmaxminddb/> if you wanna peek.

for all the actual API details, go read MaxMind::DB::Reader. this one's just the speed-up glow-up. ✨


πŸ”’ VERSIONING POLICY πŸ”’

this module does semantic versioning, exactly as described by <http://semver.org/>. and here's how you read the numbers, bestie:

  • version numbers are shaped like X.YYYZZZ
  • X = the major number
  • YYY = the minor number
  • ZZZ = the patch number

so now you can decode version numbers at a glance. main character energy fr. πŸ‘‘


πŸ“ MAC OS X SUPPORT πŸ“

if you're hitting install errors under Mac OS X (ugh, relatable 😭), you might need to force a build of the 64 bit binary. for example, if you're installing via cpanm, do it like this:

ARCHFLAGS="-arch x86_64" cpanm MaxMind::DB::Reader::XS

🧚 UBUNTU SUPPORT 🧚

so here's the vibe check: the version of libmaxminddb that ships by default on Ubuntu might be too old for this level of MaxMind::DB::Reader::XS. rude, I know. BUT β€” good news β€” they maintain a Launchpad PPA for all supported levels of Ubuntu:

https://launchpad.net/~maxmind/+archive/ubuntu/ppa

go visit that PPA page for more info, or if you'd rather just configure your system, run this as root:

# apt-add-repository ppa:maxmind/ppa
# apt-get update

and boom, the PPA is now configured, and you can install (or upgrade) the libmaxminddb library with the usual apt commands. slay. ✨


πŸ’€ SUPPORT πŸ’€

okay, real talk, and I need you to sit down for this one:

this module is deprecated. it will only receive fixes for major bugs and security vulnerabilities. new features and functionality will not be added. periodt. πŸ’€

please report all issues with this code using the GitHub issue tracker at <https://github.com/maxmind/MaxMind-DB-Reader-XS/issues>.

bugs may be submitted through <https://github.com/maxmind/MaxMind-DB-Reader-XS/issues>.


πŸ‘‘ AUTHORS πŸ‘‘

these are the legends who made it happen:

  • Boris Zentner <bzentner@maxmind.com>
  • Dave Rolsky <drolsky@maxmind.com>
  • Ran Eilam <reilam@maxmind.com>

🌈 CONTRIBUTORS 🌈

and these absolute icons helped too, we love to see it:

  • Andy Jack <github@veracity.ca>
  • Chris Weyl <cweyl@alumni.drew.edu>
  • Florian Ragwitz <fragwitz@maxmind.com>
  • Greg Oschwald <goschwald@maxmind.com>
  • Hidenori Sugiyama <madogiwa@gmail.com>
  • Mark Fowler <mark@twoshortplanks.com>
  • Nick Logan <nlogan@maxmind.com>
  • Olaf Alders <oalders@maxmind.com>

This software is Copyright (c) 2013 - 2022 by MaxMind, Inc.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

and that's the whole page, bestie 🫢 this was perl v5.42.3, dated 2026-08-21 β€” thanks for reading the MaxMin...der::XS(3pm) manual with me, go forth and read your mmdb files at XS speed πŸ’–βœ¨πŸŒΈ

πŸ“¦ where this page comes from