Documentation

Here you should be able to find everything you need to know to use and interact with Polypheny. If you think that something is missing, please let us know. Should you discover a mistake in the docs (or a bug in general) feel free to open an issue on GitHub.

Getting started

• Setup — How to setup and run Polypheny.
• Data Types — Overview on the type system.

Schema Model

• Basics — Overview on the schema model.
• Data Partitioning — Overview on Polypheny’s partition essentials.
• Views — (Materialized) views in Polypheny.

Query Languages

• PolySQL — The Polypheny SQL dialect.
• MongoQL — Documentation for the MongoDB Query Language.
• REST — How to use the REST-based query interface.
• CQL — Documentation for the Contextual Query Language.
• PolyPig — Documentation for the PolyPig Query Language.

Connectors & Drivers

• JDBC Driver — Documentation for Polyhenys JDBC Driver.
• Python Connector — Documentation on Polypheny Connector for Python

Data Storage

• Data Stores — Supported data stores.
• Data Sources — Available data source adapters.

For developers

• Project Structure — Basic overview on the different parts of Polypheny.
• GitHub Labels — Best practices for handling issues and pull requests.
• Polypheny Control — The automated build system used for benchmarking and testing Polypheny-DB.
• Testing — Overview on the test suites.
• Logging — Dealing with the logger.
• Documentation Guidelines — What and how to document.
• Dependency Management — How we deal with dependencies.
• DB Development Environment — Setup a Polypheny-DB in an IDE.
• UI Development Environment — Setup a Polypheny-UI development environment.
• Adapter Development — Guidline for developing data store and data source adapters.