---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: rate_limit_fs
excerpt: |
  DuckDB Community Extensions
  Perform rate and burst limit on filesystem operations

extension:
  name: rate_limit_fs
  description: Perform rate and burst limit on filesystem operations
  version: 0.1.0
  language: C++
  build: cmake
  license: MIT
  excluded_platforms: "wasm_mvp;wasm_eh;wasm_threads"
  maintainers:
    - dentiny

repo:
  github: dentiny/duckdb-rate-limit-filesystem
  andium: 2d70a9f86b5d31fd6104980d5bfd47db82fcd020
  ref: 54e1fc7eba7c02b026c749fc7f00586d5fc09ed3

docs:
  hello_world: |
    SELECT rate_limit_fs_wrap('RateLimitFsFakeFileSystem');
    SELECT rate_limit_fs_quota('RateLimitFileSystem - RateLimitFsFakeFileSystem', 'read', 1000000, 'blocking');
  extended_description: |
    This extension implements rate and burst limit for duckdb filesystems.
    It supports a few key features:
    - Support filesystem and operation based limit.
    - Support burst limit and GCRA-based rate limit.
    - Supports wrap custom filesystems, so users don't need to change their query.

extension_star_count: 3
extension_star_count_pretty: 3
extension_download_count: 865
extension_download_count_pretty: 865
image: '/images/community_extensions/social_preview/preview_community_extension_rate_limit_fs.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                                               |
|--------------------------------|---------------|-------------------------------------------------------------------------------------------------|---------|-----------------------------------------------------------------------------------------------------|
| rate_limit_fs_burst            | scalar        | Sets the burst capacity for read or write operations on a rate-limited filesystem.              | NULL    | [SELECT rate_limit_fs_burst('RateLimitFileSystem - LocalFileSystem', 'read', 10485760);]            |
| rate_limit_fs_clear            | scalar        | Clears one or more rate-limit settings; '*' selects every filesystem or operation.              | NULL    | [SELECT rate_limit_fs_clear('RateLimitFileSystem - LocalFileSystem', 'read');]                      |
| rate_limit_fs_configs          | table         | Returns all configured filesystem operation quotas, modes, burst limits, and concurrency caps.  | NULL    | [SELECT * FROM rate_limit_fs_configs();]                                                            |
| rate_limit_fs_list_filesystems | table         | Lists the filesystem implementations registered with DuckDB's virtual filesystem.               | NULL    | [SELECT * FROM rate_limit_fs_list_filesystems();]                                                   |
| rate_limit_fs_max_requests     | scalar        | Sets the maximum number of concurrent requests for a filesystem operation, or -1 for unlimited. | NULL    | [SELECT rate_limit_fs_max_requests('RateLimitFileSystem - LocalFileSystem', 'read', 10);]           |
| rate_limit_fs_quota            | scalar        | Sets the sustained rate limit for a filesystem operation in blocking or non-blocking mode.      | NULL    | [SELECT rate_limit_fs_quota('RateLimitFileSystem - LocalFileSystem', 'read', 1048576, 'blocking');] |
| rate_limit_fs_wrap             | scalar        | Wraps a registered filesystem with rate limiting and registers the wrapped filesystem.          | NULL    | [SELECT rate_limit_fs_wrap('LocalFileSystem');]                                                     |

### 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 |