---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: altertable
excerpt: |
  DuckDB Community Extensions
  Query Altertable's lakehouse directly from your local DuckDB.

extension:
  name: altertable
  description: Query Altertable's lakehouse directly from your local DuckDB.
  version: 0.7.0
  language: C++
  build: cmake
  excluded_platforms: wasm_mvp;wasm_eh;wasm_threads
  license: MIT
  maintainers:
    - redox
  vcpkg_commit: 84bab45d415d22042bd0b9081aea57f362da3f35
  requires_toolchains: "vcpkg;parser_tools"
repo:
  github: altertable-ai/duckdb-altertable
  ref: 12fea1270cace5c7446bdc86dc48c98f6e84c398
  variegata: 350de4b8e0dafb87435927c1e31f3670e4335bb5
docs:
  hello_world: |
    INSTALL altertable FROM community;
    LOAD altertable;

    -- Attach an Altertable database
    CREATE SECRET my_altertable (
        TYPE altertable,
        USER 'my-user',
        PASSWORD 'my-pass'
    );
    ATTACH 'catalog=my-altertable-catalog' AS db (TYPE ALTERTABLE, SECRET my_altertable);

    -- Query remote Altertable tables with standard SQL
    SELECT * FROM db.main.events;

    -- Create and load remote tables through the attached database
    CREATE TABLE db.main.example_events (id INTEGER, name VARCHAR);
    INSERT INTO db.main.example_events VALUES (1, 'launch');

    DETACH db;
  extended_description: |
    The Altertable extension connects DuckDB to Altertable databases over the
    high-performance Arrow Flight SQL protocol. It lets you attach remote
    Altertable catalogs and browse remote schemas and tables through DuckDB's
    catalog.

    Features include:
    - `ATTACH` support for remote Altertable databases
    - direct reads from attached schemas and tables
    - attached writes with `CREATE TABLE`, `CREATE TABLE AS`, `INSERT`, `UPDATE` and `DELETE`
    - DuckDB secrets support for storing Altertable credentials

extension_star_count: 1
extension_star_count_pretty: 1
extension_download_count: 827
extension_download_count_pretty: 827
image: '/images/community_extensions/social_preview/preview_community_extension_altertable.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                                          |
|--------------------------|---------------|-----------------------------------------------------------------------------------------------------|---------|-------------------------------------------------------------------------------------------|
| altertable_query         | table         | Execute a SELECT query on an attached Altertable database and return the results as a DuckDB table. | NULL    | [SELECT * FROM altertable_query('db', 'SELECT id, name FROM users WHERE active = true');] |
| altertable_execute       | table         | Execute a remote DDL or DML statement on an attached Altertable database.                           | NULL    | [CALL altertable_execute('db', 'CREATE TABLE my_table (id INTEGER, name VARCHAR)');]      |
| altertable_scan          | table         | NULL                                                                                                | NULL    | NULL                                                                                      |
| altertable_scan_pushdown | table         | NULL                                                                                                | 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 |
|-------------------------------|----------------------------------------------------------------------------------|------------|--------|---------|
| altertable_connection_cache   | Whether to reuse pooled Arrow Flight SQL connections between DuckDB transactions | BOOLEAN    | GLOBAL | []      |
| altertable_debug_show_queries | DEBUG SETTING: print all queries sent to Altertable to stdout                    | BOOLEAN    | GLOBAL | []      |