ClickHouse/ClickHouse

Add function to check if an IPv4/6 is in a list of subnets

Open

#6,808 opened on Sep 3, 2019

View on GitHub
 (4 comments) (3 reactions) (0 assignees)C++ (8,400 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (47,419 stars)
PR merge metrics
 (Avg merge 2d 2h) (1,000 merged PRs in 30d)

Description

Use case Using ip_trie, I can check if an IP is in any X subnets I have no easy way to do a quick CLI query to match ~ 5 subnets without creating a dict

Describe the solution you'd like Something like IPmatchNet(ip, [subnet1, subnet2]) ip being IPv4 or IPv6 or UInt32 or FixedString(16) subnet1 is an IPv6 or IPv4 subnet as string (192.168.0.0/21), same as what is accepted by ip_trie

IPmatchNet should return the matched subnet so we can use it in GROUP BY Also IPmatchNet should handle IPv4 mapped IPv6 (#6806)

Additional context I'm bad at naming, IPmatchNet is just an exemple Right now cutIPv6 cuts bytes and not bits, so I can only use it for /24 /16 /8 (for IPv4)

Contributor guide

Research direction
Study the existing ip trie function implementation and how to add new scalar functions in ClickHouse. Understand IPv4 and IPv6 types and the internal representation. Then implement a function that checks if a given IP belongs to any of a list of subnets.
Tech stack
None
Domain
backenddatabase
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++ClickHouse IP types
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40