---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: prometheus
excerpt: |
  DuckDB Community Extensions
  Query Prometheus-compatible HTTP APIs directly from DuckDB

extension:
  name: prometheus
  description: Query Prometheus-compatible HTTP APIs directly from DuckDB
  version: 0.3.0
  language: Rust
  build: cargo
  license: Apache-2.0
  excluded_platforms: "linux_amd64_musl;wasm_mvp;wasm_eh;wasm_threads"
  requires_toolchains: "rust;python3"
  maintainers:
    - botan

repo:
  github: botan/duckdb-prometheus
  ref: 7dff993bacd1fca00a4bc7e5ff4018757eaee1b4
  variegata: b20a37bb2423e41cc2e67aa3db91bd49318cead9

docs:
  hello_world: |
    -- Replace localhost:9090 with your Prometheus-compatible endpoint.
    SELECT timestamp, job, instance, value
    FROM prometheus_scan(
        'up',
        current_timestamp - INTERVAL '15 minutes',
        current_timestamp,
        endpoint := 'http://localhost:9090',
        step := INTERVAL '1 minute',
        labels := ['job', 'instance']
    )
    ORDER BY timestamp DESC, job, instance;
  extended_description: |
    Run instant PromQL queries with `prometheus_query` and range queries with
    `prometheus_scan`; their `_many` variants accept multiple expressions. Each sample
    contains `labels MAP(VARCHAR, VARCHAR)`, `timestamp TIMESTAMPTZ`, and `value DOUBLE`.
    Pass `labels := [...]` to expose selected labels as columns.

    Discovery functions list labels, label values, series, and metric metadata. Requests
    are unauthenticated. See the [README](https://github.com/botan/duckdb-prometheus) for
    function signatures and limitations.

extension_star_count: 7
extension_star_count_pretty: 7
extension_download_count: 848
extension_download_count_pretty: 848
image: '/images/community_extensions/social_preview/preview_community_extension_prometheus.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 |
|-------------------------|---------------|-------------|---------|----------|
| prometheus_label_values | table         | NULL        | NULL    |          |
| prometheus_labels       | table         | NULL        | NULL    |          |
| prometheus_metadata     | table         | NULL        | NULL    |          |
| prometheus_query        | table         | NULL        | NULL    |          |
| prometheus_query_many   | table         | NULL        | NULL    |          |
| prometheus_scan         | table         | NULL        | NULL    |          |
| prometheus_scan_many    | table         | NULL        | NULL    |          |
| prometheus_series       | table         | 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 |