---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: pbix
excerpt: |
  DuckDB Community Extensions
  Extension that allows parsing the data model embedded in PowerBI (pbix) files

extension:
  name: pbix
  description: Extension that allows parsing the data model embedded in PowerBI (pbix) files
  version: 0.5.3
  language: C++
  build: cmake
  excluded_platforms: "linux_amd64_musl"
  license: MIT
  maintainers:
    - Hugoberry
repo:
  github: Hugoberry/duckdb-pbix-extension
  ref: 3d863fc006d22e9a6dcfae59fbf4a46edca8fd13
docs:
  hello_world: |
    -- Get metadata tables from a PowerBI file
    SELECT Name FROM pbix_meta('Adventure Works DW 2020.pbix','table') WHERE isHidden=0;
    
    -- Read data from a specific table in the PowerBI file
    SELECT 
      ResellerKey, 
      "Business Type", 
      Reseller, 
      "Reseller ID" 
    FROM pbix_read('Adventure Works DW 2020.pbix','Reseller') 
    LIMIT 10;

    -- Read metadata about models in a folder of pbix files
    SELECT
      file,
      list_transform(pbix2vpax(file).Tables, t->t.TableName) as tab
    FROM glob('data/**/*.pbix');
  extended_description: >
    The PBIX extension allows you to parse the data model embedded in PowerBI (pbix) files directly in DuckDB.
    
    
    It provides three functions:
    - `pbix_meta()`: Returns metadata tables for a data model (consult [MS-SSAS-T](https://learn.microsoft.com/en-us/openspecs/sql_server_protocols/ms-ssas-t/f85cd3b9-690c-4bc7-a1f0-a854d7daecd8) for metadata structures)
    - `pbix_read()`: Returns the contents of a specific table from a pbix file
    - `pbix2vpax()`: Generate comprehensive VPAX serialisation of the entire data model (scalar function)
    
    
    For a pure Python implementation of the pbix parser, check out the [PBIXray](https://github.com/Hugoberry/pbixray) library.
    
    
    *Note:* Current limitations include the inability of the WASM version to parse `https` hosted files, and that pbix_read() will decompress the entire model in memory. 

extension_star_count: 39
extension_star_count_pretty: 39
extension_download_count: 991
extension_download_count_pretty: 991
image: '/images/community_extensions/social_preview/preview_community_extension_pbix.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 |
|---------------|---------------|-------------|---------|----------|
| pbix2vpax     | scalar        | NULL        | NULL    |          |
| pbix_meta     | table         | NULL        | NULL    |          |
| pbix_read     | 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 |
|-----------------------------------|----------------------------------------------------------------------------|------------|--------|---------|
| pbix_ignore_errors                | Return empty VPAX structure instead of throwing exceptions on parse errors | BOOLEAN    | GLOBAL | []      |
| pbix_trailing_chunks_optimization | Number of trailing chunks to read for optimized file parsing               | INTEGER    | GLOBAL | []      |