https://github.com/polypheny/polypheny-prism-api

The definition files for the Polypheny Prism API, a multi-model, multi-language query interface.
https://github.com/polypheny/polypheny-prism-api

Last synced: 6 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/polypheny/polypheny-prism-api
• Owner: polypheny
• License: apache-2.0
• Created: 2024-03-05T13:07:37.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-06T13:02:54.000Z (8 days ago)
• Last Synced: 2024-11-06T13:48:53.092Z (8 days ago)
• Language: Python
• Homepage:
• Size: 216 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/protocolbuffers/protobuf/releases/).

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

```