xinb
/
ip2region_private
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(erlang): update README examples for IPv6 and current test output

This commit is contained in:
Alice39s 2026-06-28 04:58:45 +09:00
parent 507b7bddc1
commit 546ce589a9
No known key found for this signature in database
GPG Key ID: 0E0AA11C3939DDDD
2 changed files with 42 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
binding/erlang/README.md
View File

@ -55,7 +55,7 @@ Place the xdb file in the `priv` directory, then start the Erlang node:
$ rebar3 shell $ rebar3 shell
``` ```
Call the `xdb:search/1` interface in the Erlang shell to query IP address information. This interface supports IP addresses represented as list strings, binary strings, tuples, and integers, as follows: Call the `xdb:search/1` interface in the Erlang shell to query IP address information. This interface supports IP addresses represented as list strings, binary strings, tuples, and integers:
``` ```
1> xdb:search("1.0.8.0"). 1> xdb:search("1.0.8.0").
@ -76,11 +76,11 @@ With dual-stack enabled, IPv6 addresses are supported in the same way:
``` ```
1> io:format("~ts~n", [xdb:search("2001:4860:4860::8888")]). 1> io:format("~ts~n", [xdb:search("2001:4860:4860::8888")]).
... United States|Florida|Miami|Google LLC|US
2> io:format("~ts~n", [xdb:search(<<"2001:4860:4860::8888">>)]). 2> io:format("~ts~n", [xdb:search(<<"2001:4860:4860::8888">>)]).
... United States|Florida|Miami|Google LLC|US
3> io:format("~ts~n", [xdb:search({8193,10304,10304,0,0,0,0,34952})]). 3> io:format("~ts~n", [xdb:search({8193,18528,18528,0,0,0,0,34952})]).
... United States|Florida|Miami|Google LLC|US
``` ```
### Usage ### Usage
@ -95,22 +95,14 @@ With dual-stack enabled, IPv6 addresses are supported in the same way:
* Start the ip2region Application * Start the ip2region Application
``` ```erlang
...... {ok, _} = application:ensure_all_started(ip2region).
application:ensure_started(ip2region),
......
``` ```
* Call the `xdb:search/1` interface to query IP information * Call the `xdb:search/1` interface to query IP information
``` ```erlang
...... xdb:search("1.0.8.0").
ip2region:search("1.0.8.0"),
......
``` ```
### Unit Test ### Unit Test
@ -121,12 +113,12 @@ $ rebar3 eunit
===> Analyzing applications... ===> Analyzing applications...
===> Compiling ip2region ===> Compiling ip2region
===> Performing EUnit tests... ===> Performing EUnit tests...
=INFO REPORT==== 17-Jan-2023::11:52:59.920155 === =INFO REPORT==== 28-Jun-2026::04:53:28 ===
XdbFile:/home/admin/erl-workspace/ip2region/binding/erlang/_build/test/lib/ip2region/priv/ip2region.xdb XdbFile:/Users/nana/Documents/code/ip2region/.worktrees/erlang-ipv6/binding/erlang/_build/test/lib/ip2region/priv/ip2region.xdb
.... ....
Finished in 0.150 seconds Finished in 0.192 seconds
34 tests, 0 failures 38 tests, 0 failures
``` ```
### Benchmark ### Benchmark

54
binding/erlang/README_zh.md
View File

@ -49,20 +49,30 @@ $ rebar3 compile
``` ```
$ rebar3 shell $ rebar3 shell
``` ```
在erlang shell中调用xdb:search/1接口查询Ip地址信息, 该接口支持以list格式字符串、binary格式字符串、tuple和整数表示的IP地址，如下： 在 Erlang shell 中调用 `xdb:search/1` 接口查询 IP 地址信息。该接口支持 list 字符串、binary 字符串、tuple 和整数表示的 IP 地址：
``` ```
1> xdb:search("1.0.8.0"). 1> xdb:search("1.0.8.0").
[20013,22269,124,48,124,24191,19996,30465,124,24191,24030, [20013,22269,124,24191,19996,30465,124,24191,24030,24066,
24066,124,30005,20449] 124,20013,22269,30005,20449,124,67,78]
2> 2>
3> io:format("~ts~n", [xdb:search("1.0.8.0")]). 3> io:format("~ts~n", [xdb:search("1.0.8.0")]).
中国|0|广东省|广州市|电信 中国|广东省|广州市|中国电信|CN
io:format("~ts~n", [xdb:search(<<"1.0.8.0">>)]). 4> io:format("~ts~n", [xdb:search(<<"1.0.8.0">>)]).
中国|0|广东省|广州市|电信 中国|广东省|广州市|中国电信|CN
4> io:format("~ts~n", [xdb:search({1,0,8,0})]). 5> io:format("~ts~n", [xdb:search({1,0,8,0})]).
中国|0|广东省|广州市|电信 中国|广东省|广州市|中国电信|CN
6> io:format("~ts~n", [xdb:search(16779264)]). 6> io:format("~ts~n", [xdb:search(16779264)]).
中国|0|广东省|广州市|电信 中国|广东省|广州市|中国电信|CN
```
启用双栈后，IPv6 地址也按同样方式支持：
```
1> io:format("~ts~n", [xdb:search("2001:4860:4860::8888")]).
United States|Florida|Miami|Google LLC|US
2> io:format("~ts~n", [xdb:search(<<"2001:4860:4860::8888">>)]).
United States|Florida|Miami|Google LLC|US
3> io:format("~ts~n", [xdb:search({8193,18528,18528,0,0,0,0,34952})]).
United States|Florida|Miami|Google LLC|US
``` ```
### 使用方法 ### 使用方法
@ -73,21 +83,13 @@ io:format("~ts~n", [xdb:search(<<"1.0.8.0">>)]).
]}. ]}.
``` ```
* 启动 ip2region Application * 启动 ip2region Application
``` ```erlang
...... {ok, _} = application:ensure_all_started(ip2region).
application:ensure_started(ip2region),
......
``` ```
* 调用xdb:search/1接口查询IP信息 * 调用 `xdb:search/1` 接口查询 IP 信息
``` ```erlang
...... xdb:search("1.0.8.0").
ip2region:search("1.0.8.0"),
......
``` ```
### 单元测试 ### 单元测试
@ -98,12 +100,12 @@ $ rebar3 eunit
===> Analyzing applications... ===> Analyzing applications...
===> Compiling ip2region ===> Compiling ip2region
===> Performing EUnit tests... ===> Performing EUnit tests...
=INFO REPORT==== 17-Jan-2023::11:52:59.920155 === =INFO REPORT==== 28-Jun-2026::04:53:28 ===
XdbFile:/home/admin/erl-workspace/ip2region/binding/erlang/_build/test/lib/ip2region/priv/ip2region.xdb XdbFile:/Users/nana/Documents/code/ip2region/.worktrees/erlang-ipv6/binding/erlang/_build/test/lib/ip2region/priv/ip2region.xdb
.... ....
Finished in 0.074 seconds Finished in 0.192 seconds
4 tests, 0 failures 38 tests, 0 failures
``` ```
### 基准测试 ### 基准测试