---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: tsfile
excerpt: |
  DuckDB Community Extensions
  Query and write Apache TsFile table-model files from DuckDB

extension:
  name: tsfile
  description: Query and write Apache TsFile table-model files from DuckDB
  version: 0.1.0
  language: C++
  build: cmake
  license: Apache-2.0
  excluded_platforms: "wasm_mvp;wasm_eh;wasm_threads"
  maintainers:
    - ColinLeeo

repo:
  github: TimechoLab/tsfile-duckdb
  ref: 9840c600fec9aefec3d9351d8ee27c643033b752

docs:
  hello_world: |
    INSTALL tsfile FROM community;
    LOAD tsfile;

    SELECT time, device_id, temperature
    FROM read_tsfile('/data/measurements.tsfile', 'sensors')
    WHERE time BETWEEN 1700000000000 AND 1700003600000;

  extended_description: |
    The TsFile extension exposes the read_tsfile(path, table_name) table
    function for querying Apache TsFile table-model files and supports writing
    query results with COPY ... TO ... (FORMAT TSFILE). It maps TsFile columns
    to DuckDB types, pushes projections, time predicates, and TAG predicates
    into the reader, and streams results in DuckDB vector-sized batches.

    The initial release supports one local file and one table per scan.
    Tree-model files, multi-file scans, automatic table discovery, parallel
    scans, and FIELD predicate pushdown are not yet implemented.

extension_star_count: 6
extension_star_count_pretty: 6
extension_download_count: 9728
extension_download_count_pretty: 9.7k
image: '/images/community_extensions/social_preview/preview_community_extension_tsfile.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_tsfile   | 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>

This extension does not add any settings.