MMDB2 File Format Decoder

Setup

Add the module as a dependency to your mix.exs file:

defp deps do
  [
    # ...
    {:mmdb2_decoder, "~> 1.0"},
    # ...
  ]
end

Depending on your elixir version you should also update your application list:

def application do
  [
    included_applications: [
      # ...
      :mmdb2_decoder,
      # ...
    ]
  ]
end

Usage

For more detailed examples and usage information please refer to the inline documentation of the MMDB2Decoder module.

Regular Flow

database = File.read!("/path/to/database.mmdb")
{:ok, meta, tree, data} = MMDB2Decoder.parse_database(database)

{:ok, ip} = :inet.parse_address(String.to_charlist("8.8.8.8"))

MMDB2Decoder.lookup(ip, meta, tree, data)

Direct Piping

"/path/to/database.mmdb"
|> File.read!()
|> MMDB2Decoder.parse_database()
|> MMDB2Decoder.pipe_lookup({8, 8, 8, 8})

Benchmark

Several (minimal) benchmark scripts are included. Please refer to the Mixfile or mix help output for their names.

By default the benchmarks use the Benchmark.mmdb database provided by :geolix_testdata. To use a different database pass it's path as the sole argument to an individual mix bench.* call. Please be aware that not all benchmark scripts are expected to work without the default database.

License

Apache License, Version 2.0

License information about the supported MaxMind GeoIP2 Country, MaxMind GeoIP2 City and MaxMind GeoLite2 databases can be found on their respective sites.