1GeoIP2::Database::ReadeUrs(e3r)Contributed Perl DocumentGaetoiIoPn2::Database::Reader(3)
2
3
4

NAME

6       GeoIP2::Database::Reader - Perl API for GeoIP2 databases
7

VERSION

9       version 2.006002
10

SYNOPSIS

12         use 5.008;
13
14         use GeoIP2::Database::Reader;
15
16         my $reader = GeoIP2::Database::Reader->new(
17             file    => '/path/to/database',  # e.g. /home/maxmind/db/GeoIP2-Country.mmdb
18             locales => [ 'en', 'de', ]
19         );
20
21         my $city = $reader->city( ip => '24.24.24.24' );
22         my $country = $city->country();
23         print $country->iso_code(), "\n";
24

DESCRIPTION

26       This class provides a reader API for all GeoIP2 databases. Each method
27       returns a different model class.
28
29       If the database does not return a particular piece of data for an IP
30       address, the associated attribute is not populated.
31

USAGE

33       The basic API for this class is the same for all database types.  First
34       you create a database reader object with your "file" and "locale"
35       params.  Then you call the method corresponding to your database type,
36       passing it the IP address you want to look up.
37
38       If the request succeeds, the method call will return a model class for
39       the method point you called.
40
41       If the database cannot be read, the reader class throws an exception.
42

IP GEOLOCATION USAGE

44       IP geolocation is inherently imprecise. Locations are often near the
45       center of the population. Any location provided by a GeoIP2 database
46       should not be used to identify a particular address or household.
47

CONSTRUCTOR

49       This class has a single constructor method:
50
51   GeoIP2::Database::Reader->new()
52       This method creates a new object. It accepts the following arguments:
53
54       •   file
55
56           This is the path to the GeoIP2 database which you'd like to query.
57           The path should include the filename.
58
59       •   locales
60
61           This is an array reference where each value is a string indicating
62           a locale.  This argument will be passed on to record classes to use
63           when their "name()" methods are called.
64
65           The order of the locales is significant. When a record class has
66           multiple names (country, city, etc.), its "name()" method will look
67           at each element of this array ref and return the first locale for
68           which it has a name.
69
70           Note that the only locale which is always present in the GeoIP2
71           data in "en".  If you do not include this locale, the "name()"
72           method may end up returning "undef" even when the record in
73           question has an English name.
74
75           Currently, the valid list of locale codes is:
76
77           •       de - German
78
79           •       en - English
80
81                   English names may still include accented characters if that
82                   is the accepted spelling in English. In other words,
83                   English does not mean ASCII.
84
85           •       es - Spanish
86
87           •       fr - French
88
89           •       ja - Japanese
90
91           •       pt-BR - Brazilian Portuguese
92
93           •       ru - Russian
94
95           •       zh-CN - simplified Chinese
96
97           Passing any other locale code will result in an error.
98
99           The default value for this argument is "['en']".
100

REQUEST METHODS

102       All of the request methods accept a single argument:
103
104       •   ip
105
106           This must be a valid IPv4 or IPv6 address. This is the address that
107           you want to look up using the GeoIP2 web service.
108
109           Unlike the web service client class, you cannot pass the string
110           "me" as your ip address.
111
112   $reader->asn()
113       This method returns a GeoIP2::Model::ASN object.
114
115   $reader->connection_type()
116       This method returns a GeoIP2::Model::ConnectionType object.
117
118   $reader->country()
119       This method returns a GeoIP2::Model::Country object.
120
121   $reader->city()
122       This method returns a GeoIP2::Model::City object.
123
124   $reader->domain()
125       This method returns a GeoIP2::Model::Domain object.
126
127   $reader->isp()
128       This method returns a GeoIP2::Model::ISP object.
129
130   $reader->enterprise()
131       This method returns a GeoIP2::Model::Enterprise object.
132
133   $reader->anonymous_ip()
134       This method returns a GeoIP2::Model::AnonymousIP object.
135

OTHER METHODS

137   $reader->metadata()
138       This method returns a MaxMind::DB::Metadata object containing
139       information about the database.
140

EXCEPTIONS

142       In the case of a fatal error, the reader will throw a
143       GeoIP2::Error::Generic or GeoIP2::Error::IPAddressNotFound exception
144       object.
145
146       This error class has an "$error->message()" method and overload
147       stringification to show that message. This means that if you don't
148       explicitly catch errors they will ultimately be sent to "STDERR" with
149       some sort of (hopefully) useful error message.
150

WHAT DATA IS RETURNED?

152       While many of the databases return the same basic records, the
153       attributes which can be populated vary between model classes. In
154       addition, while a database may offer a particular piece of data,
155       MaxMind does not always have every piece of data for any given IP
156       address.
157
158       Because of these factors, it is possible for any model class to return
159       a record where some or all of the attributes are unpopulated.
160
161       See <http://dev.maxmind.com/geoip/geoip2/web-services> for details on
162       what data each end point may return.
163
164       Every record class attribute has a corresponding predicate method so
165       you can check to see if the attribute is set.
166

SUPPORT

168       Bugs may be submitted through
169       <https://github.com/maxmind/GeoIP2-perl/issues>.
170

AUTHORS

172       •   Dave Rolsky <drolsky@maxmind.com>
173
174       •   Greg Oschwald <goschwald@maxmind.com>
175
176       •   Mark Fowler <mfowler@maxmind.com>
177
178       •   Olaf Alders <oalders@maxmind.com>
179
181       This software is copyright (c) 2013 - 2019 by MaxMind, Inc.
182
183       This is free software; you can redistribute it and/or modify it under
184       the same terms as the Perl 5 programming language system itself.
185
186
187
188perl v5.32.1                      2021-01-27       GeoIP2::Database::Reader(3)
Impressum