PBIXRay

Overview

PBIXRay is a Python library designed to parse and analyze PBIX files, which are used with Microsoft Power BI. This library provides a straightforward way to extract valuable information from PBIX files, including tables, metadata, Power Query code, and more.

Installation

Before using PBIXRay, ensure you have the following Python modules installed: apsw, kaitaistruct, and pbixray. You can install them using pip:

pip install pbixray

Getting Started

To start using PBIXRay, import the module and initialize it with the path to your PBIX file:

from pbixray import PBIXRay

model = PBIXRay('path/to/your/file.pbix')

Features and Usage

Tables

To list all tables in the model:

tables = model.tables
print(tables)

Metadata

To get metadata about the Power BI configuration used during model creation:

metadata = model.metadata
print(metadata)

Power Query

To display all M/Power Query code used for data transformation, in a dataframe with TableName and Expression columns:

power_query = model.power_query
print(power_query)

Model Size

To find out the model size in bytes:

size = model.size
print(f"Model size: {size} bytes")

DAX Calculated Tables

To view DAX calculated tables in a dataframe with TableName and Expression columns:

dax_tables = model.dax_tables
print(dax_tables)

DAX Measures

To access DAX measures in a dataframe with TableName, Name, Expression, DisplayFolder, and Description columns:

dax_measures = model.dax_measures
print(dax_measures)

Schema

To get details about the data model schema and column types in a dataframe with TableName, ColumnName, and PandasDataType columns:

schema = model.schema
print(schema)

Get Table Contents

To retrieve the contents of a specified table:

table_name = 'YourTableName'
table_contents = model.get_table(table_name)
print(table_contents)

Statistics

To get statistics about the model, including column cardinality and byte sizes of dictionary, hash index, and data components, in a dataframe with columns TableName, ColumnName, Cardinality, Dictionary, HashIndex, and DataSize:

statistics = model.statistics
print(statistics)

Metadata

Release files for pbixray 0.1.15

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pbixray 0.1.15
File	Size	Uploaded
pbixray-0.1.15.tar.gz	76.9 kB	May 22, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for pbixray 0.1.15
File	Interpreter	ABI	Platform	Reset
pbixray-0.1.15-py3-none-any.whl 80.3 kB May 22, 2024	Python 3	none	any	Details

Total release size: 157.2 kB

Release files / pbixray-0.1.15.tar.gz

Download URL	pbixray-0.1.15.tar.gz
Size	76.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`2ec24094fbb15a0b6fbd703840300ca48d86df0a66f27289ea8a8fccfab84706`
BLAKE2b-256 checksum How to use checksums	`560c4aae88012a632e88c210dff57c654abd31c0417f6b5104c8a7a390d53cb1`
Upload date	May 22, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.2`

Release files / pbixray-0.1.15-py3-none-any.whl

Download URL	pbixray-0.1.15-py3-none-any.whl
Size	80.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c21ff8a736746fde6c319bbd9e94c3ef198cbc4f052f65b79b821c65e71f400d`
BLAKE2b-256 checksum How to use checksums	`bf5c67b046a4e5e0f688148157c915ac277960e10b152839e11c6de203696f5a`
Upload date	May 22, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.2`