---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: vcatbridge
excerpt: |
  DuckDB Community Extensions
  Add RLS to DuckDB

extension:
  name: vcatbridge
  description: Add RLS to DuckDB
  version: 0.2.3
  language: C++
  build: cmake
  license: MIT
  excluded_platforms: "wasm_mvp;wasm_eh"
  maintainers:
    - srossross

repo:
  github: n6k-io/duckdb-virtual-catalog
  ref: 68adf2cdd3ddf933d42458815e9eb96f91c7e8f8

docs:
  hello_world: |
    -- On the SOURCE instance: register a bridge and grant tables.
    LOAD vcatbridge;
    SELECT vcatbridge_register_source('b1', 'source_catalog', 'my-secret');
    SELECT vcatbridge_configure_policy('b1', '{
      "policy_version": 1,
      "tables": {
        "main.users": {"select": true, "update": "tenant_id = $tenant"}
      }
    }');
    SELECT vcatbridge_set_context('b1', 'tenant', 42);

    -- On the TARGET instance (same process): redeem the token.
    LOAD vcatbridge;
    ATTACH '' AS my_bridge (TYPE vcatbridge, ID 'b1', TOKEN 'my-secret');
    SELECT * FROM my_bridge.main.users;

  extended_description: |
    Row-level security for DuckDB. A private source database shares selected tables
    with a target catalog in the same process, with per-table, per-verb grants and
    row rules.

    [Quack](https://duckdb.org/quack/) serves a DuckDB database over the network but
    can't limit which tables or rows clients see. Serve a `vcatbridge` catalog through
    Quack and clients only see what the policy allows.

    Documentation: https://github.com/n6k-io/duckdb-virtual-catalog/blob/main/docs/vcatbridge.md

extension_star_count: 0
extension_star_count_pretty: 0
extension_download_count: 34
extension_download_count_pretty: 34
image: '/images/community_extensions/social_preview/preview_community_extension_vcatbridge.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 |
|-----------------------------------|---------------|-------------|---------|----------|
| set_by_source                     | scalar        | NULL        | NULL    |          |
| vcatbridge_configure_policy       | scalar        | NULL        | NULL    |          |
| vcatbridge_finalize_context       | scalar        | NULL        | NULL    |          |
| vcatbridge_finalize_policy        | scalar        | NULL        | NULL    |          |
| vcatbridge_init                   | scalar        | NULL        | NULL    |          |
| vcatbridge_lockdown               | scalar        | NULL        | NULL    |          |
| vcatbridge_register_source        | scalar        | NULL        | NULL    |          |
| vcatbridge_set_context            | scalar        | NULL        | NULL    |          |
| vcatbridge_set_policy             | scalar        | NULL        | NULL    |          |
| vcatbridge_table_describe         | table         | NULL        | NULL    |          |
| vcatbridge_table_permissions      | table         | NULL        | NULL    |          |
| vcatbridge_validate_policy_config | 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>

|      name      |                       description                       | input_type | scope  | aliases | typed_value |
|----------------|---------------------------------------------------------|------------|--------|---------|-------------|
| temp_directory | Set the directory to which temporary files are written. | VARCHAR    | GLOBAL | []      | post.db.tmp |