Network Address Functions and Operators

cidr and inet Operators

The operators <<, <<=, >>, and >>= test for subnet inclusion. They consider only the network parts of the two addresses (ignoring any host part) and determine whether one network is identical to or a subnet of the other.

• <

  Description: Is less than

  For example:

  mogdb=# SELECT inet '192.168.1.5' < inet '192.168.1.6' AS RESULT;
   result
  --------
   t
  (1 row)

• <=

  Description: Is less than or equals

  For example:

  mogdb=# SELECT inet '192.168.1.5' <= inet '192.168.1.5' AS RESULT;
   result
  --------
   t
  (1 row)

• =

  Description: Equals

  For example:

  mogdb=# SELECT inet '192.168.1.5' = inet '192.168.1.5' AS RESULT;
   result
  --------
   t
  (1 row)

• >=

  Description: Is greater than or equals

  For example:

  mogdb=# SELECT inet '192.168.1.5' >= inet '192.168.1.5' AS RESULT;
   result
  --------
   t
  (1 row)

• >

  Description: Is greater than

  For example:

  mogdb=# SELECT inet '192.168.1.5' > inet '192.168.1.4' AS RESULT;
   result
  --------
   t
  (1 row)

• <>

  Description: Does not equal to

  For example:

  mogdb=# SELECT inet '192.168.1.5' <> inet '192.168.1.4' AS RESULT;
   result
  --------
   t
  (1 row)

• <<

  Description: Is contained in

  For example:

  mogdb=# SELECT inet '192.168.1.5' << inet '192.168.1/24' AS RESULT;
   result
  --------
   t
  (1 row)

• <<=

  Description: Is contained in or equals

  For example:

  mogdb=# SELECT inet '192.168.1/24' <<= inet '192.168.1/24' AS RESULT;
   result
  --------
   t
  (1 row)

• >>

  Description: Contains

  For example:

  mogdb=# SELECT inet '192.168.1/24' >> inet '192.168.1.5' AS RESULT;
   result
  --------
   t
  (1 row)

• >>=

  Description: Contains or equals

  For example:

  mogdb=# SELECT inet '192.168.1/24' >>= inet '192.168.1/24' AS RESULT;
   result
  --------
   t
  (1 row)

• ~

  Description: Bitwise NOT

  For example:

  mogdb=# SELECT ~ inet '192.168.1.6' AS RESULT;
      result
  ---------------
   63.87.254.249
  (1 row)

• &

  Description: The AND operation is performed on each bit of the two network addresses.

  For example:

  mogdb=# SELECT inet '192.168.1.6' & inet '10.0.0.0' AS RESULT;
   result
  ---------
   0.0.0.0
  (1 row)

• |

  Description: The OR operation is performed on each bit of the two network addresses.

  For example:

  mogdb=# SELECT inet '192.168.1.6' | inet '10.0.0.0' AS RESULT;
     result
  -------------
   202.168.1.6
  (1 row)

• +

  Description: Addition

  For example:

  mogdb=# SELECT inet '192.168.1.6' + 25 AS RESULT;
      result
  --------------
   192.168.1.31
  (1 row)

• -

  Description: Subtraction

  For example:

  mogdb=# SELECT inet '192.168.1.43' - 36 AS RESULT;
     result
  -------------
   192.168.1.7
  (1 row)

• -

  Description: Subtraction

  For example:

  mogdb=# SELECT inet '192.168.1.43' - inet '192.168.1.19' AS RESULT;
   result
  --------
       24
  (1 row)

cidr and inet Functions

The abbrev, host, and text functions are primarily intended to offer alternative display formats.

• abbrev(inet)

  Description: Abbreviated display format as text

  Return type: text

  For example:

  mogdb=# SELECT abbrev(inet '10.1.0.0/16') AS RESULT;
     result
  -------------
   10.1.0.0/16
  (1 row)

• abbrev(cidr)

  Description: Abbreviated display format as text

  Return type: text

  For example:

  mogdb=# SELECT abbrev(cidr '10.1.0.0/16') AS RESULT;
   result
  ---------
   10.1/16
  (1 row)

• broadcast(inet)

  Description: Broadcast address for network

  Return type: inet

  For example:

  mogdb=# SELECT broadcast('192.168.1.5/24') AS RESULT;
        result
  ------------------
   192.168.1.255/24
  (1 row)

• family(inet)

  Description: Extracts family of address; 4 for IPv4, 6 for IPv6

  Return type: int

  For example:

  mogdb=# SELECT family('::1') AS RESULT;
   result
  --------
        6
  (1 row)

• host(inet)

  Description: Extracts IP address as text.

  Return type: text

  For example:

  mogdb=# SELECT host('192.168.1.5/24') AS RESULT;
     result
  -------------
   192.168.1.5
  (1 row)

• hostmask(inet)

  Description: Constructs host mask for network.

  Return type: inet

  For example:

  mogdb=# SELECT hostmask('192.168.23.20/30') AS RESULT;
   result
  ---------
   0.0.0.3
  (1 row)

• masklen(inet)

  Description: Extracts subnet mask length.

  Return type: int

  For example:

  mogdb=# SELECT masklen('192.168.1.5/24') AS RESULT;
   result
  --------
       24
  (1 row)

• netmask(inet)

  Description: Constructs subnet mask for network.

  Return type: inet

  For example:

  mogdb=# SELECT netmask('192.168.1.5/24') AS RESULT;
      result
  ---------------
   255.255.255.0
  (1 row)

• network(inet)

  Description: Extracts network part of address.

  Return type: cidr

  For example:

  mogdb=# SELECT network('192.168.1.5/24') AS RESULT;
       result
  ----------------
   192.168.1.0/24
  (1 row)

• set_masklen(inet, int)

  Description: Sets subnet mask length for inet value.

  Return type: inet

  For example:

  mogdb=# SELECT set_masklen('192.168.1.5/24', 16) AS RESULT;
       result
  ----------------
   192.168.1.5/16
  (1 row)

• set_masklen(cidr, int)

  Description: Sets subnet mask length for cidr value.

  Return type: cidr

  For example:

  mogdb=# SELECT set_masklen('192.168.1.0/24'::cidr, 16) AS RESULT;
       result
  ----------------
   192.168.0.0/16
  (1 row)

• text(inet)

  Description: Extracts IP address and subnet mask length as text.

  Return type: text

  For example:

  mogdb=# SELECT text(inet '192.168.1.5') AS RESULT;
       result
  ----------------
   192.168.1.5/32
  (1 row)

Any cidr value can be cast to inet implicitly or explicitly; therefore, the functions shown above as operating on inet also work on cidr values. An inet value can be cast to cidr. After the conversion, any bits to the right of the subnet mask are silently zeroed to create a valid cidr value. In addition, you can cast a text string to inet or cidr using normal casting syntax. For example, inet(expression) or colname::cidr.

macaddr Functions

The function trunc(macaddr) returns a MAC address with the last 3 bytes set to zero.

trunc(macaddr)

Description: Sets last 3 bytes to zero.

Return type: macaddr

For example:

mogdb=# SELECT trunc(macaddr '12:34:56:78:90:ab') AS RESULT;
      result
-------------------
 12:34:56:00:00:00
(1 row)

The macaddr type also supports the standard relational operators (such as > and <=) for lexicographical ordering, and the bitwise arithmetic operators (~, & and |) for NOT, AND and OR.