---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: osmium
excerpt: |
  DuckDB Community Extensions
  Read OpenStreetMap data from OSM XML and PBF files

extension:
  name: osmium
  description: Read OpenStreetMap data from OSM XML and PBF files
  version: 0.5.2
  language: C++
  build: cmake
  license: MIT
  maintainers:
    - jake-low
  opt_in_platforms: "linux_amd64_musl;linux_arm64_musl"

repo:
  github: jake-low/duckdb-osmium
  ref: 0319fa36979af646da8bda871759165f469f8f73

docs:
  hello_world: |
    LOAD osmium;
    SELECT id, tags['name'] AS name, geometry
    FROM 'example.osm.pbf'
    WHERE kind = 'node' AND tags['place'] = 'city';
  extended_description: |
    The osmium extension adds support for reading [OpenStreetMap](https://www.openstreetmap.org/)
    data from OSM XML and PBF files via [libosmium](https://osmcode.org/libosmium/). It supports
    constructing Geometries (Point, LineString, Polygon, etc) from OSM elements, which makes it
    easy to transform OSM data into formats like GeoJSON and GeoParquet.

extension_star_count: 28
extension_star_count_pretty: 28
extension_download_count: 12919
extension_download_count_pretty: 12.9k
image: '/images/community_extensions/social_preview/preview_community_extension_osmium.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 |
|---------------|---------------|-------------|---------|----------|
| osmium_read   | 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 |
|-------------------|------------------------------------------------------------------------------------------------|------------|--------|---------|
| osmium_index_path | File path for file-backed index types (e.g. dense_file_array)                                  | VARCHAR    | GLOBAL | []      |
| osmium_index_type | Node location index type (flex_mem, dense_file_array, dense_mem_array, sparse_mem_array, etc.) | VARCHAR    | GLOBAL | []      |