diff --git a/velox/docs/develop/types.rst b/velox/docs/develop/types.rst index 73559bdab672..0af9c1dd7217 100644 --- a/velox/docs/develop/types.rst +++ b/velox/docs/develop/types.rst @@ -147,6 +147,14 @@ Supported range of milliseconds is [0xFFF8000000000000L, 0x7FFFFFFFFFFFF] store timezone ID. Supported range of timezone ID is [1, 1680]. The definition of timezone IDs can be found in ``TimeZoneDatabase.cpp``. +IPADDRESS represents an IPV6 or IPV4 formatted IPV6 address. Its physical +type is BIGINT. The format that the address is stored in is defined as part of `(RFC 4291#section-2.5.5.2) `_ +As Velox is run on Little Endian systems and the standard is network byte(Big Endian) +order, we reverse the bytes to allow for masking and other bit operations +used in IPADDRESS/IPPREFIX related functions. This type can be used to +create IPPREFIX networks as well as to check IPADDRESS validity within +IPPREFIX netowrks. + Spark Types ~~~~~~~~~~~~ The `data types `_ in Spark have some semantic differences compared to those in