Downloads 5.5kthis week

GitHub stars 9

Extension descriptor (YAML)

WHATWG URLPattern API for matching and extracting components from URLs using pattern syntax

Compatibility Matrix

This table covers all DuckDB releases that have not reached end-of-life, including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

Installing and Loading

INSTALL urlpattern FROM community;
LOAD urlpattern;

Example

-- Test if a URL matches a pattern
SELECT urlpattern_test('https://example.com/users/:id', 'https://example.com/users/123');
-- true

-- Extract a named group from a URL
SELECT urlpattern_extract('https://example.com/users/:id', 'https://example.com/users/123', 'id');
-- '123'

-- Get full match results with all components
SELECT urlpattern_exec('/posts/:slug', '/posts/hello-world');
-- {matched: true, pathname: '/posts/hello-world', groups: {slug: 'hello-world'}, ...}

-- Use the URLPATTERN type for validated patterns
SELECT urlpattern_test(urlpattern('/api/:version/*'), '/api/v2/users/list');
-- true

About urlpattern

The URLPattern extension implements the WHATWG URLPattern API for DuckDB, enabling powerful URL matching, extraction, parsing, and construction.

Features

• Custom URLPATTERN type with validation and implicit casting from VARCHAR
• Pattern matching with named groups (:name), wildcards (*), and regex groups
• URL parsing into components (protocol, host, path, query, hash)
• URL building and modification from components
• Query parameter extraction as MAP or individual values
• Pattern caching for improved performance (~320k matches/sec)

Key Functions

Pattern Syntax

URLPattern uses a syntax similar to Express.js routes:

• :name - Named parameter (matches any segment)
• * - Wildcard (matches everything)
• /path/:id - Path-only patterns match any protocol/host

For full documentation, see duckdb-urlpattern.readthedocs.io.

Added Functions

Overloaded Functions

This extension does not add any function overloads.

Added Types

Added Settings