---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: duckpgq
excerpt: |
  DuckDB Community Extensions
  Extension that adds support for SQL/PGQ and graph algorithms

extension:
  name: duckpgq
  description: Extension that adds support for SQL/PGQ and graph algorithms
  version: 1.0.0
  language: C++
  build: cmake
  license: MIT
  opt_in_platforms: "windows_arm64"
  maintainers:
    - Dtenwolde

repo:
  github: cwida/duckpgq-extension
  andium: 42eea114b22fad93f04cb7edf50d2b0077e464fa
  variegata: 61f5d08270bef2c81fc4e5d9af32739e67adc2be
  ref: 9c11bc192a071c9e44cef16cced90a22d7d7db2c

docs:
  hello_world: |
    SET active_grammar_extensions = ['duckpgq'];

    CREATE TABLE Person AS SELECT * FROM 'https://gist.githubusercontent.com/Dtenwolde/2b02aebbed3c9638a06fda8ee0088a36/raw/8c4dc551f7344b12eaff2d1438c9da08649d00ec/person-sf0.003.csv';
    CREATE TABLE Person_knows_person AS SELECT * FROM 'https://gist.githubusercontent.com/Dtenwolde/81c32c9002d4059c2c3073dbca155275/raw/8b440e810a48dcaa08c07086e493ec0e2ec6b3cb/person_knows_person-sf0.003.csv';

    CREATE PROPERTY GRAPH snb
      VERTEX TABLES (
        Person
      )
      EDGE TABLES (
        Person_knows_person SOURCE KEY (Person1Id) REFERENCES Person (id)
                            DESTINATION KEY (Person2Id) REFERENCES Person (id)
        LABEL knows
      );

    FROM GRAPH_TABLE (snb
      MATCH (a:Person)-[k:knows]->(b:Person)
      COLUMNS (a.id, b.id)
    )
    LIMIT 1;

    FROM GRAPH_TABLE (snb 
      MATCH p = ANY SHORTEST (a:person)-[k:knows]->{1,3}(b:Person) 
      COLUMNS (a.id, b.id, path_length(p))
    ) 
    LIMIT 1;

    FROM local_clustering_coefficient(snb, person, knows);

    DROP PROPERTY GRAPH snb;

  extended_description: >
    The DuckPGQ extension supports the SQL/PGQ syntax as part of the official SQL:2023 standard developed by ISO.


    It introduces visual graph pattern matching and a more concise syntax for path-finding.
    For more information, please see the [DuckPGQ documentation](https://duckpgq.org).

    *Note:* Starting with DuckDB v2.0, you have to opt in to the DuckPGQ grammar after loading the extension by running `SET active_grammar_extensions = ['duckpgq'];`.

    *Disclaimer:* As this extension is part of an ongoing research project by the Database Architectures group at CWI, some features may still be under development. We appreciate your understanding and patience as we continue to improve it.

extension_star_count: 510
extension_star_count_pretty: 510
extension_download_count: 27155
extension_download_count_pretty: 27.2k
image: '/images/community_extensions/social_preview/preview_community_extension_duckpgq.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 |
|------------------------------|---------------|-------------|---------|----------|
| cheapest_path_length         | scalar        | NULL        | NULL    |          |
| create_csr_edge              | scalar        | NULL        | NULL    |          |
| create_csr_vertex            | scalar        | NULL        | NULL    |          |
| create_property_graph        | table         | NULL        | NULL    |          |
| create_vertex_table          | pragma        | NULL        | NULL    |          |
| csr_get_w_type               | scalar        | NULL        | NULL    |          |
| delete_csr                   | scalar        | NULL        | NULL    |          |
| describe_property_graph      | table         | NULL        | NULL    |          |
| drop_property_graph          | table         | NULL        | NULL    |          |
| duckpgq_match                | table         | NULL        | NULL    |          |
| get_csr_e                    | table         | NULL        | NULL    |          |
| get_csr_ptr                  | table         | NULL        | NULL    |          |
| get_csr_v                    | table         | NULL        | NULL    |          |
| get_csr_w                    | table         | NULL        | NULL    |          |
| get_pg_ecolnames             | table         | NULL        | NULL    |          |
| get_pg_etablenames           | table         | NULL        | NULL    |          |
| get_pg_vcolnames             | table         | NULL        | NULL    |          |
| get_pg_vtablenames           | table         | NULL        | NULL    |          |
| iterativelength              | scalar        | NULL        | NULL    |          |
| iterativelength2             | scalar        | NULL        | NULL    |          |
| iterativelengthbidirectional | scalar        | NULL        | NULL    |          |
| local_clustering_coefficient | scalar        | NULL        | NULL    |          |
| local_clustering_coefficient | table         | NULL        | NULL    |          |
| pagerank                     | scalar        | NULL        | NULL    |          |
| pagerank                     | table         | NULL        | NULL    |          |
| reachability                 | scalar        | NULL        | NULL    |          |
| shortestpath                 | scalar        | NULL        | NULL    |          |
| show_property_graphs         | pragma        | NULL        | NULL    |          |
| summarize_property_graph     | table         | NULL        | NULL    |          |
| weakly_connected_component   | scalar        | NULL        | NULL    |          |
| weakly_connected_component   | 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 |
|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|------------|--------|---------|-------------|
| duckpgq_factorized_join_directory | Let FACTORIZED_GROUP_JOIN count into a dense array indexed by the key when the key bounds are known, instead of a hash table                          | BOOLEAN    | GLOBAL | []      | true        |
| duckpgq_factorized_join_operator  | Use the FACTORIZED_GROUP_JOIN operator when both sides of a join are only counted or summed, instead of separate GROUP BY aggregates and a hash join  | BOOLEAN    | GLOBAL | []      | true        |
| duckpgq_factorized_joins          | Pre-aggregate join sides that are only counted or summed above the join, so that path counts become degree products instead of enumerating every path | BOOLEAN    | GLOBAL | []      | true        |
| duckpgq_vertex_join_elimination   | Leave vertex tables out of the MATCH translation when the query only uses their key, joining the incident edge tables to each other instead           | BOOLEAN    | GLOBAL | []      | true        |
| temp_directory                    | Set the directory to which temporary files are written.                                                                                               | VARCHAR    | GLOBAL | []      | post.db.tmp |