Skip to main content

Polypheny-Prism-API

The definition files for the Polypheny Prism API, a multi-model, multi-language query interface.

The Prism Interface uses Protocol Buffer (protobuf) messages to define it's services. To keep things clear and well-organized, the message definitions are grouped into several files. This simplifies finding specific messages, based on what they do or what part of the system they relate to. The files itself are grouped in categories. Those are expressed in the file names. Two kinds of categories exist:

Request Response Category

The category type contains messages that are used in communication adhering to a request, response scheme. Here the client sends a request message to the server upon which the server sends back a response message.

  • Requests File: This file contains all messages that are sent from the client to the server. The file name adheres to the following pattern: [category]_requests.proto. For example, all the request messages for making or managing connections would be in connection_requests.proto.

  • Responses File: This is the partner file to Requests. It contains all the messages the server sends back to the client. Following the naming pattern, these files end with _responses.proto. The response messages related to connections would thus be in connection_responses.proto.

Other Category

The other kind of category contains messages that are not directly used as a response to a request. An example therefore would be messages representing a specific datatype supported by the DBMS. This category always contains only one file. The filename adheres to the pattern [category].proto.

Doc Generator

Detailed Documentation of the proto files their messages and enums and much more can automatically be created using the doc generator included in this repo. For this to work, the protobuf compiler must be installed. It's current version can be downloaded here.

To run the doc generator, execute the file generator.py in the doc-generator directory.

This creates a directory called docs containing the generated documentation.

Generate Python files

Generate the Python code:

python -m grpc_tools.protoc -I . --python_out . org/polypheny/prism/*.proto

Test protocol contracts

The Python contract tests compile the checked-out definitions into a temporary directory and check the document metadata messages, wire compatibility, and optional-field presence.

python -m pip install -r requirements.txt
python -m unittest discover -s tests -v

Metadata

Release files for polypheny-prism-api 2.2

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

Source distribution (sdist)

Source distribution for polypheny-prism-api 2.2
File Size Uploaded Provenance Actions
polypheny_prism_api-2.2.tar.gz 20.1 kB With provenance Details for polypheny_prism_api-2.2.tar.gz

Release files / polypheny_prism_api-2.2.tar.gz

Download URL polypheny_prism_api-2.2.tar.gz
Size 20.1 kB
Tags Source
SHA-256 checksum
How to use checksums
d690fe93ad19917e8bd57005e236eaef2a38fbd4d238951176fcc3347c69ab2f
BLAKE2b-256 checksum
How to use checksums
bc8e767b552b4273a1ed491ee9fa732d7506a225eae1ebe1d8147ebe1c0c9f6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

Security for polypheny-prism-api 2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

1 file in this release has been uploaded with provenance metadata.

Attestation for polypheny_prism_api-2.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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