README

:globe_with_meridians: 中文简体 | English

 ip2region

ip2region - 是一个离线IP地址定位库和IP定位数据管理框架，同时支持 IPv4 和 IPv6 ，10微秒级别的查询效率，提供了众多主流编程语言的 xdb 数据生成和查询客户端实现。


 项目特性

 1、离线定位库

项目本身同时了提供了一份 IPv4 (data/ipv4_source.txt) 和 IPv6 (data/ipv6_source.txt) 的原始数据和对应的 xdb 文件(data/ip2region_v4.xdb 和 data/ip2region_v6.xdb) 用于实现精确到城市的查询定位功能，字段格式为：国家|省份|城市|ISP|iso-alpha2-code(国家两字母简称)，中国的定位信息全部为中文，非中国地区的地域信息全部为英文。

 2、数据管理框架

xdb 支持亿级别的 IP 数据段行数，region 信息支持完全自定义，自带数据的 region 信息固定了格式为：国家|省份|城市|ISP|iso-alpha2-Code，你可以在 region 中追加特定业务需求的数据，例如：GPS信息/国际统一地域信息编码/邮编等。也就是你完全可以使用 ip2region 来管理你自己的 IP 定位数据。

 3、数据去重和压缩

xdb 格式生成程序会自动处理输入的原始数据，检查并且完成相连 IP 段的的合并以及相同地域信息的去重和压缩。

 4、极速查询响应

即使是完全基于 xdb 文件的查询，单次查询响应时间在十微秒级别，可通过如下两种方式开启内存加速查询：

1. vIndex 索引缓存 ：使用固定的 512KiB 的内存空间缓存 vector index 数据，减少一次 IO 磁盘操作，保持平均查询效率稳定在100微秒之内。
2. xdb 整个文件缓存：将整个 xdb 文件全部加载到内存，内存占用等同于 xdb 文件大小，无磁盘 IO 操作，保持10微秒级别的查询效率。

 5、统一的查询接口

xdb 提供了版本兼容的查询实现，一个统一的 API 可以同时提供对 IPv4 和 IPv6 数据的查询并且返回统一的数据。


 xdb 查询

API 介绍，使用文档和测试程序请参考对应 searcher 查询客户端下的 README 介绍，全部查询 binding 实现情况如下：
| 编程语言 | 描述 | IPv4 支持 | IPv6 支持 |
| --- | --- | --- | --- |
| Golang         | golang 查询客户端       | :white_check_mark: | :white_check_mark: |
| PHP               | php 查询客户端          | :white_check_mark: | :white_check_mark: |
| Java             | java 查询客户端         | :white_check_mark: | :white_check_mark: |
| C                   | C[std=c99] 查询客户端   | :white_check_mark: | :white_check_mark: |
| Lua_c           | lua c 扩展查询客户端    | :white_check_mark: | :white_check_mark: |
| Lua               | lua 查询客户端          | :white_check_mark: | :white_check_mark: |
| Rust             | rust 查询客户端         | :white_check_mark: | :white_check_mark: |
| Python         | python 查询客户端       | :white_check_mark: | :white_check_mark: |
| Javascript | javascript 查询客户端   | :white_check_mark: | :white_check_mark: |
| Csharp                      | csharp 查询客户端       | :white_check_mark: | :white_check_mark: |
| Erlang         | erlang 查询客户端       | :white_check_mark: | :white_check_mark: |
| Nginx                        | nginx 扩展查询客户端    | :white_check_mark: | :white_check_mark: |
| C++               | C++ 查询客户端          | :white_check_mark: | :white_check_mark: |
| Cangjie          | 仓颉 查询客户端         | :white_check_mark: | :white_check_mark: |
| Logstash     | logstash 过滤插件       | :white_check_mark: | :white_check_mark: |


以下工具链实现由社区开发者通过第三方仓库贡献：
| 编程语言 | 描述 |
| --- | --- |
| ip2region-composer    | php composer 管理客户端 |
| ip2region-ts   | node.js addon 管理客户端|
| ruby-ip2region | ruby xdb 查询客户端实现 |
| Ip2regionTool     | ip2region 数据转换工具  |


 xdb 生成

API 介绍，使用文档和测试程序请参考如下 maker 生成程序下的 README 文档：

| 编程语言 | 描述 | IPv4 支持 | IPv6 支持 |
| --- | --- | --- | --- |
| Golang | golang xdb 生成程序  | :white_check_mark: | :white_check_mark: |
| Java     | java xdb 生成程序    | :white_check_mark: | :white_check_mark: |
| Python | python xdb 生成程序  | :white_check_mark: | :x:                |
| Csharp | c