---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: zipfs
excerpt: |
  DuckDB Community Extensions
  Read files within zip archives

extension:
  name: zipfs
  description: Read files within zip archives
  version: 2.0.0
  language: C++
  build: cmake
  license: MIT
  maintainers:
    - isaacbrodsky

repo:
  github: isaacbrodsky/duckdb-zipfs
  ref: fd9fec45453caef9bd1a89a7f6d92e421da63ca8

docs:
  hello_world: |
    SELECT * FROM 'zip://my_zip.zip/my_file.csv';
  extended_description: |
    The zipfs extension adds support for reading files from within zip files and other archives.

extension_star_count: 72
extension_star_count_pretty: 72
extension_download_count: 33303
extension_download_count_pretty: 33.3k
image: '/images/community_extensions/social_preview/preview_community_extension_zipfs.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                                                                     |
|------------------|---------------|--------------------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| archive_contents | table         | Returns a table of the files in the archive.     | NULL    | [SELECT * FROM archive_contents('example.zip');, SELECT file_name, file_size, is_directory, is_encrypted FROM archive_contents('example.zip');] |
| zip_contents     | table         | Returns a table of the files in the zip archive. | NULL    | [SELECT * FROM zip_contents('example.zip');, SELECT file_name, file_size, is_directory, is_encrypted FROM zip_contents('example.zip');]         |

### 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 |
| zipfs_extension | Extension to look for splitting the zip path and the file path within the zip. To specify an artificial seperator, instead set: `set zipfs_split = '!!';`           | VARCHAR    | GLOBAL | []      | .zip        |
| zipfs_split     | Extension to look for splitting the zip path and the file path within the zip. Will be removed from the zip file name. Overrides zipfs_extension. Defaults to NULL. | VARCHAR    | GLOBAL | []      | NULL        |