NAME

       MaxMind::DB::Metadata - A class for metadata related to a MaxMind DB database

VERSION

       version 0.040001

SYNOPSIS

           my $reader = MaxMind::DB::Reader->new( file => $path );
           my $metadata = $reader->metadata();

           print $metadata->description()->{en};

DESCRIPTION

       This class provides an API for representing the metadata of a MaxMind DB database. See
       http://maxmind.github.io/MaxMind-DB/ for the official format spec.

API

       This class provides methods for each metadata attribute in a database.

   $metadata->binary_format_major_version()
       Returns the binary format major version number.

   $metadata->binary_format_minor_version()
       Returns the binary format minor version number.

   $metadata->build_epoch()
       Returns the database's build timestamp as an epoch value.

   $metadata->database_type()
       Returns a string indicating the database's type.

   $metadata->languages()
       Returns an arrayref of locale codes indicating what languages this database has
       information for.

   $metadata->description()
       Returns a hashref of descriptions. The keys should be locale codes like "en" or "pt-BR"
       and the values are the description in that language.

   $metadata->ip_version()
       Returns a 4 or 6 indicating what type of IP addresses this database can be used to look
       up.

   $metadata->node_count()
       Returns the number of nodes in the database's search tree.

   $metadata->record_size()
       Returns the record size for nodes in the database's search tree.

AUTHORS

       •   Dave Rolsky <drolsky@maxmind.com>

       •   Olaf Alders <oalders@maxmind.com>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2016 by MaxMind, Inc..

       This is free software, licensed under:

         The Artistic License 2.0 (GPL Compatible)