---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: sshfs
excerpt: |
  DuckDB Community Extensions
  Allows reading and writing files over SSH

extension:
  name: sshfs
  description: Allows reading and writing files over SSH
  version: '2026102301'
  language: C++
  build: cmake
  license: MIT
  excluded_platforms: "windows_amd64_rtools;windows_amd64_mingw;windows_amd64;wasm_threads;wasm_eh;wasm_mvp;linux_amd64_musl;"
  requires_toolchains: "vcpkg"
  maintainers:
    - onnimonni
  vcpkg_commit: 'dd3097e305afa53f7b4312371f62058d2e665320'
repo:
  github: midwork-finds-jobs/duckdb-sshfs
  andium: 5f2e422f964010d11a0bea040ab421c4d7f7fa41
  variegata: 34d3dddd08f29e7c40bda9a05d56a1b053f9ec7d
  ref: b7ca495c21ea7cec2c59c1e890129a95fdd4a7c3

docs:
  hello_world: |
    -- Install & load the extension
    INSTALL sshfs FROM community;
    LOAD sshfs;

    -- Authenticate with SSH key file
    CREATE SECRET my_hetzner_storagebox (
        TYPE SSH,
        USERNAME 'user',
        KEY_PATH '/Users/' || getenv('USER') || '/.ssh/storagebox_key',
        PORT 23
        SCOPE 'sshfs://u123456.your-storagebox.de'
    );

    -- or with password
    CREATE SECRET my_server (
      TYPE SSH,
      USERNAME 'user',
      PASSWORD 'password',
      SCOPE 'sshfs://your-server.example.com'
    );

    -- Write data to remote server
    COPY (SELECT * FROM large_table)
    TO 'sshfs://your-server.example.com/data.parquet';
    
    -- Read The uploaded parquet file using WebDAV
    SELECT * FROM 'sshfs://your-server.example.com/data.parquet';

  extended_description: |
    DuckDB sshfs extension enables seamless integration with servers through ssh, allowing users to read from and write to remote file systems directly within DuckDB.

    See: https://github.com/midwork-finds-jobs/duckdb-sshfs/blob/main/README.md for more examples and details.

extension_star_count: 14
extension_star_count_pretty: 14
extension_download_count: 866
extension_download_count_pretty: 866
image: '/images/community_extensions/social_preview/preview_community_extension_sshfs.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>

This extension does not add any functions.

### 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 |
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|--------|---------|-------------|
| ssh_keepalive                | SSH keepalive interval in seconds (default: 60, set to 0 to disable). Prevents idle connection timeouts and improves performance.                                | BIGINT     | GLOBAL | []      | 60          |
| sshfs_chunk_size_mb          | Chunk size in MB for uploads (default: 50MB, larger chunks may improve throughput but use more memory)                                                           | BIGINT     | GLOBAL | []      | 50          |
| sshfs_debug_logging          | Enable debug logging for SSHFS operations                                                                                                                        | BOOLEAN    | GLOBAL | []      | false       |
| sshfs_initial_retry_delay_ms | Initial delay in milliseconds between retries, with exponential backoff (default: 1000)                                                                          | BIGINT     | GLOBAL | []      | 1000        |
| sshfs_max_concurrent_uploads | Maximum number of concurrent chunk uploads (default: 2, higher values may improve speed but use more connections)                                                | BIGINT     | GLOBAL | []      | 2           |
| sshfs_max_retries            | Maximum number of connection retry attempts (default: 3)                                                                                                         | BIGINT     | GLOBAL | []      | 3           |
| sshfs_strict_crypto          | Restrict SSH to non-NIST algorithms only (curve25519, ed25519, DH group14+). Removes ecdh-sha2-nistp*, ecdsa-sha2-nistp*, and legacy algorithms (default: false) | BOOLEAN    | GLOBAL | []      | false       |
| sshfs_timeout_seconds        | Timeout in seconds for SSH operations (default: 300 = 5 minutes)                                                                                                 | BIGINT     | GLOBAL | []      | 300         |
| temp_directory               | Set the directory to which temporary files are written.                                                                                                          | VARCHAR    | GLOBAL | []      | post.db.tmp |