PolarDB:ip4r (network address storage)

Single-address types

Three types store a single IP address:

• ip4: Accepts input in nnn.nnn.nnn.nnn format. Stored as a 32-bit unsigned integer.

• ip6: Accepts input in standard hexadecimal format. Stored as two 64-bit values.

• ipaddress: Accepts either ip4 or ip6 format.

In the conversion table below, ipX represents any of these three types.

Address range types

Three types store a range of IP addresses:

• ip4r: Stores an IPv4 address range. For example, 192.0.2.100-192.0.2.200. The CIDR notation 192.0.2.0/24 is equivalent to 192.0.2.0-192.0.2.255.

• ip6r: Stores an IPv6 address range. For example, 2001::1234-2001::2000:0000. The CIDR notation 2001::/112 is equivalent to 2001::-2001::ffff.

• iprange: Accepts either ip4r or ip6r format.

In the conversion table below, ipXr represents any of these three types.

Install the extension

CREATE EXTENSION ip4r;

Create a table and load test data

CREATE TABLE ipranges (r iprange, r4 ip4r, r6 ip6r);

INSERT INTO ipranges
    SELECT r, null, r
    FROM (
        SELECT ip6r(regexp_replace(ls, E'(....(?!$))', E'\\1:', 'g')::ip6,
               regexp_replace(substring(ls FOR n + 1) || substring(us FROM n + 2),
               E'(....(?!$))', E'\\1:', 'g')::ip6) AS r
        FROM (
            SELECT md5(i || ' lower 1') AS ls,
                   md5(i || ' upper 1') AS us,
                   (i % 11) + (i/11 % 11) + (i/121 % 11) AS n
            FROM generate_series(1,13310) i) s1) s2;

Create a GiST index

CREATE INDEX ipranges_r ON ipranges USING gist (r);

Query with the contains operator

The following query uses the GiST index to find all ranges that contain the address 5555:::

EXPLAIN (COSTS OFF) SELECT * FROM ipranges WHERE r >>= '5555::' ORDER BY r;

The query plan confirms index use:

                     QUERY PLAN
-----------------------------------------------------
 Sort
   Sort Key: r
   ->  Bitmap Heap Scan on ipranges
         Recheck Cond: (r >>= '5555::'::iprange)
         ->  Bitmap Index Scan on ipranges_r
               Index Cond: (r >>= '5555::'::iprange)
(6 rows)

Remove the extension

DROP EXTENSION ip4r;