---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: html_query
excerpt: |
  DuckDB Community Extensions
  Query HTML using CSS selectors, extract JSON from LD+JSON, JavaScript variables, and Next.js RSC

extension:
  name: html_query
  description: Query HTML using CSS selectors, extract JSON from LD+JSON, JavaScript variables, and Next.js RSC
  version: 0.6.0
  language: Rust
  build: cargo
  license: MIT
  excluded_platforms: "wasm_mvp;wasm_eh;wasm_threads;linux_amd64_musl"
  requires_toolchains: "rust;python3"
  maintainers:
    - onnimonni

repo:
  github: midwork-finds-jobs/duckdb_html_query
  variegata: a78df2bfb6ad547ceae25cac70277bbaf0ecba62
  ref: 87af2dc57ae7c16cc281157af979789bf1772f25

docs:
  hello_world: |
    -- Extract text from first matching element
    SELECT html_query('<html><title>Hello World</title></html>', 'title', '@text');
    ┌─────────────┐
    │ html_query  │
    │   varchar   │
    ├─────────────┤
    │ Hello World │
    └─────────────┘

    -- Extract all matching elements as VARCHAR[]
    SELECT html_query_all('<div><p>First</p><p>Second</p></div>', 'p', '@text');
    ┌────────────────┐
    │ html_query_all │
    │   varchar[]    │
    ├────────────────┤
    │ [First,Second] │
    └────────────────┘

    -- Extract JSON from LD+JSON scripts (returns array)
    SELECT html_extract_json(
      '<script type="application/ld+json">{"name":"Product"}</script>',
      'script[type="application/ld+json"]'
    );
    ┌──────────────────────────┐
    │    html_extract_json     │
    │         varchar          │
    ├──────────────────────────┤
    │ [{"name":"Product"}]     │
    └──────────────────────────┘

  extended_description: |
    html_query is a DuckDB extension for querying HTML using CSS selectors.

    ## Functions

    | Function | Returns | Description |
    |----------|---------|-------------|
    | `html_query(html, selector?, extract?)` | VARCHAR | First matching element |
    | `html_query_all(html, selector?, extract?)` | VARCHAR[] | All matching elements as list |
    | `html_extract_json(html, selector, var_pattern?)` | JSON array | JSON from script tags |

    All functions accept both VARCHAR and BLOB input types.

    ### Extract Parameter

    The `extract` parameter specifies what to extract from matched elements:

    | Value | Description |
    |-------|-------------|
    | (omitted) | Full HTML of element |
    | `@text` or `text` | Inner text content |
    | `@href`, `href` | href attribute |
    | `@src`, `src` | src attribute |
    | `data-test-id` | Any attribute name |
    | `['@href', '@text']` | Multiple attributes as JSON object |

    ### `html_query(html, selector, extract)`

    Extract first HTML element matching CSS selector.

    **Examples:**
    ```sql
    SELECT html_query(html, 'title', '@text') FROM pages;
    SELECT html_query(html, 'a.nav-link', '@href') FROM pages;
    SELECT html_query(html, 'div.content') FROM pages;  -- returns HTML
    ```

    ### `html_query_all(html, selector, extract)`

    Extract all HTML elements matching CSS selector as VARCHAR[].

    **Examples:**
    ```sql
    SELECT html_query_all(html, 'a', '@href') FROM pages;
    -- Returns: [/home, /about, /contact]

    SELECT list_extract(html_query_all(html, 'a', '@href'), 2) FROM pages;
    -- Access second element

    SELECT html_query_all(html, 'a', ['@href', '@text']) FROM pages;
    -- Returns: [{"href":"/home","text":"Home"}, ...]
    ```

    ### `html_extract_json(html, selector, var_pattern)`

    Extract JSON from HTML scripts. Supports LD+JSON, JavaScript variables, and Next.js RSC.
    Always returns a JSON array.

    **Examples:**
    ```sql
    -- Extract LD+JSON (decodes HTML entities)
    SELECT html_extract_json(html, 'script[type="application/ld+json"]')->0 FROM pages;

    -- Extract JS variable (decodes hex escapes like \x22)
    SELECT html_extract_json(html, 'script', 'var config')->0 FROM pages;

    -- Extract JSON from Next.js RSC payloads by key name
    SELECT html_extract_json(html, 'script', '@nextjs_rsc:productDisplay')->0 FROM pages;
    ```

    ## CSS Selectors

    - Tag: `div`, `p`, `a`
    - Class: `.classname`
    - ID: `#idname`
    - Attribute: `[href]`, `[type="application/ld+json"]`
    - Pseudo: `:first-child`, `:last-child`, `:nth-child(n)`
    - Combinators: `div > p`, `div p`

extension_star_count: 2
extension_star_count_pretty: 2
extension_download_count: 565
extension_download_count_pretty: 565
image: '/images/community_extensions/social_preview/preview_community_extension_html_query.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), 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.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| Linux ARM64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| macOS AMD64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| macOS ARM64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| Windows AMD64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ❌ | ❌ | ❌ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

|   function_name   | function_type | description | comment | examples |
|-------------------|---------------|-------------|---------|----------|
| html_extract_json | scalar        | NULL        | NULL    |          |
| html_query        | scalar        | NULL        | NULL    |          |
| html_query_all    | scalar        | NULL        | NULL    |          |

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

|      name      |                       description                       | input_type | scope  | aliases | typed_value |
|----------------|---------------------------------------------------------|------------|--------|---------|-------------|
| temp_directory | Set the directory to which temporary files are written. | VARCHAR    | GLOBAL | []      | post.db.tmp |