---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: ion
excerpt: |
  DuckDB Community Extensions
  Read AWS Ion data and write Ion text or binary with typed mappings

extension:
  name: ion
  description: Read AWS Ion data and write Ion text or binary with typed mappings
  version: 0.2.0
  language: C++
  build: cmake
  license: MIT
  maintainers:
    - kestra-io
    - proddata

repo:
  github: kestra-io/duckdb-ion
  ref: a144356501ec0432b5025c6b8d19f643761d6f65
  andium: 75c52435dcf48e96afd79b3b9bc1dce1a5547b04

docs:
  hello_world: |
    -- Read Ion files (text or binary)
    SELECT * FROM read_ion('sample.ion');

    -- Control schema and parsing options
    SELECT * FROM read_ion('sample.ion', columns := {id: 'BIGINT', label: 'VARCHAR'});
    SELECT * FROM read_ion('scalars.ion', records := false);
    SELECT * FROM read_ion('array.ion', format := 'array');

    -- Write Ion text or binary
    CREATE TABLE ion_demo AS SELECT 1::INTEGER AS id, 'hello' AS label;
    COPY ion_demo TO 'out.ion' (FORMAT ION);
    COPY ion_demo TO 'out.ion' (FORMAT ION, BINARY TRUE);
  extended_description: |
    The ion extension enables DuckDB to read AWS Ion in text and binary formats and write Ion text or binary,
    preserving Ion types where possible for richer analytics.

extension_star_count: 6
extension_star_count_pretty: 6
extension_download_count: 1063
extension_download_count_pretty: 1.1k
image: '/images/community_extensions/social_preview/preview_community_extension_ion.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 |
|---------------|---------------|-------------|---------|----------|
| read_ion      | table         | NULL        | NULL    |          |
| to_ion        | 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>

This extension does not add any settings.