Skip to main content

Tesseract OLAP

A semantic layer for your data, enabling OLAP operations over relational databases. Tesseract OLAP provides a Python interface to translate multidimensional queries into optimized SQL, executing them against a backend, and returning the results in a structured format.

Key Capabilities

  • Multidimensional Analysis: Supports standard OLAP operations like drilling down, slicing, dicing, and pivoting.
  • Backend Agnostic: Designed to work with various data backends. Currently supports ClickHouse with specialized drivers.
  • Schema Validation: Uses a robust XML schema definition to validate queries and ensure data integrity.
  • High Performance: leverages polars for efficient data handling and transformation.
  • Caching: Built-in support for caching query results to improve performance (supports Redis).

Installation

Install the package using pip:

pip install tesseract-olap

Optional Dependencies

To use specific backends or features, install the corresponding extras:

  • ClickHouse Backend:
    pip install "tesseract-olap[clickhouse]"
    
  • Redis Caching:
    pip install "tesseract-olap[redis]"
    

Getting Started

In its most basic form, the tesseract-olap package provides a way to translate OLAP-type queries into request statements that a data backend can understand and execute safely.

1. Define your Schema

Tesseract uses a schema to define cubes, dimensions, and measures. Supported formats include XML, JSON, and YAML. See the OLAP Model Concepts and examples in the repository for schema details.

2. Initialize the Server

from tesseract_olap.backend.clickhouse import ClickhouseBackend
from tesseract_olap import OlapServer

# Initialize the backend connection
backend = ClickhouseBackend("clickhouse://user:pass@localhost:9000/database")

# Create the server instance with the schema
server = OlapServer(backend=backend, schema="./path/to/schema.xml")

3. Execute a Query

from tesseract_olap.query import DataRequest, DataQuery

def get_data():
    # Create a request object defining the query
    request = DataRequest.new("cube_name", {
        "drilldowns": ["Time", "Country"],
        "measures": ["Units", "Price"],
    })

    # Validate and compile the request against the schema
    query = DataQuery.from_request(server.schema, request)

    # Execute the query
    with server.session() as session:
        # Fetch results in different formats
        # result = session.fetch(query)           # Returns a Result object
        # result = session.fetch_records(query)   # Returns a list of dicts
        result = session.fetch_dataframe(query)   # Returns a Polars DataFrame

    return result.data

if __name__ == "__main__":
    data = get_data()
    print(data)

The server instance can be integrated into web applications (like FastAPI or LogicLayer) to provide a full-fledged OLAP API.


© 2022-2024 Datawheel, LLC.

Release files for tesseract-olap 0.23.3

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

Source distribution (sdist)

Source distribution for tesseract-olap 0.23.3
File Size Uploaded
tesseract_olap-0.23.3.tar.gz 111.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tesseract-olap 0.23.3
File Interpreter ABI Platform
tesseract_olap-0.23.3-py3-none-any.whl Python 3 none any Details

Total release size: 249.5 kB

Release files / tesseract_olap-0.23.3.tar.gz

Download URL tesseract_olap-0.23.3.tar.gz
Size 111.2 kB
Tags Source
SHA-256 checksum
How to use checksums
29359d7b9afa754197fac2664c4a5ceb86c3071d05c33388dfbef4201ae9cf9d
BLAKE2b-256 checksum
How to use checksums
bea38022d901eed8a9bed0392bcd1073740605f0c54c74ecd54a51dd29907b43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.3 CPython/3.12.3 Linux/6.17.0-1022-azure

Release files / tesseract_olap-0.23.3-py3-none-any.whl

Download URL tesseract_olap-0.23.3-py3-none-any.whl
Size 138.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
de414f3aed66dd544b92e70709af44ec115f8e0c283560a73949af47982b4780
BLAKE2b-256 checksum
How to use checksums
0cab93842a719f53507a5dfa44e44307c8522719396e8d5e300a6c09943d5422
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.3 CPython/3.12.3 Linux/6.17.0-1022-azure

Release history Release notifications | RSS feed

This release

0.23.3 This release

2 release files

0.23.2

2 release files

0.23.1

2 release files

0.23.0

2 release files

0.22.9

2 release files

0.22.8

2 release files

0.22.7

2 release files

0.22.6

2 release files

0.22.4

2 release files

0.22.3

2 release files

0.22.2

2 release files

0.22.1

2 release files

0.21.2

2 release files

0.21.1

2 release files

0.21.0

2 release files

0.20.2

2 release files

0.20.1

2 release files

0.20.0

2 release files

0.19.1

2 release files

0.19.0

2 release files

0.18.8

2 release files

0.18.7

2 release files

0.18.6

2 release files

0.18.5

2 release files

0.18.4

2 release files

0.18.3

2 release files

0.18.2

2 release files

0.18.1

2 release files

0.18.0

2 release files

0.17.0

2 release files

0.16.1

2 release files

0.16.0

2 release files

0.15.2

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.14.6

2 release files

0.14.4

2 release files

0.14.3

2 release files

0.14.2

2 release files

0.14.0

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.4

2 release files

0.10.3

2 release files

0.10.1

2 release files

0.9.9

2 release files

0.9.8

2 release files

0.9.7

2 release files

0.9.6

2 release files

0.9.5

2 release files

0.9.4

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page