Skip to content
This repository was archived by the owner on Aug 27, 2022. It is now read-only.

Commit b540dad

Browse files
authored
Update README.md
1 parent b414cf5 commit b540dad

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,27 @@
22
# Drill Network Functions
33
This library contains a collection of network-related functions for Apache Drill. It includes:
44

5-
* `inet_aton(<IPv4>)`: This function converts an IPv4 address in dotted decimal notation into an integer. This is useful for sorting IP addresses, and reducing the amount of space that they take on disk.
5+
* **`inet_aton(<IPv4>)`**: This function converts an IPv4 address in dotted decimal notation into an integer. This is useful for sorting IP addresses, and reducing the amount of space that they take on disk.
66

7-
* `inet_ntoa(<int>)`: This function returns an IP in dotted decimal notation given its integer representation.
7+
* **`inet_ntoa(<int>)`**: This function returns an IP in dotted decimal notation given its integer representation.
88

9-
* `is_private_ip(<IPv4>)`: Returns true if the IP address is private.
9+
* **`is_private_ip(<IPv4>)`**: Returns true if the IP address is private.
1010

11-
* `in_network( <IPv4>, <CIDR Block>)`: Retunrs true if the IPv4 address is in the CIDR Block
11+
* **`in_network( <IPv4>, <CIDR Block>)`**: Retunrs true if the IPv4 address is in the CIDR Block
1212

13-
* `getAddressCount( <CIDR Block> )`: Returns the number of IP addresses in a given CIDR Block
13+
* **`getAddressCount( <CIDR Block> )`**: Returns the number of IP addresses in a given CIDR Block
1414

15-
* `getBroadcastAddress( <CIDR Block> )`: Returns the broadcast address in dotted decimal notation from a given CIDR block.
15+
* **`getBroadcastAddress( <CIDR Block> )`**: Returns the broadcast address in dotted decimal notation from a given CIDR block.
1616

17-
* `getNetmask( <CIDR Block> )`: Returns the netmask for a given CIDR Block
17+
* **`getNetmask( <CIDR Block> )`**: Returns the netmask for a given CIDR Block
1818

19-
* `getLowAddress( <CIDR Block> )`: Returns the first IPv4 address in dotted decimal notation for a given CIDR Block
19+
* **`getLowAddress( <CIDR Block> )`**: Returns the first IPv4 address in dotted decimal notation for a given CIDR Block
2020

21-
* `getHighAddress( <CIDR Block> )`: Returns the last IPv4 address in dotted decimal notation for a given CIDR Block
21+
* **`getHighAddress( <CIDR Block> )`**: Returns the last IPv4 address in dotted decimal notation for a given CIDR Block
22+
23+
## Installing These Functions
24+
This collection of functions does not have any dependencies that are not already included in Drill. You can build the functions from source by cloning this repository, navigating to the directory and typing:
25+
`mvn clean package -DskipTests`.
26+
Once you've done that, you'll find two `.jar` files in the `target/` folder. Copy both these files to `<drill path>/jars/3rdParty`.
27+
28+
Alternatively, you can download the jar files here: and copy them to `<drill path>/jars/3rdParty`.

0 commit comments

Comments
 (0)