Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/polypheny/polypheny-fram
Polypheny-FRAM is a plugin for Polypheny-DB making it the distributed polystore.
https://github.com/polypheny/polypheny-fram
Last synced: 6 days ago
JSON representation
Polypheny-FRAM is a plugin for Polypheny-DB making it the distributed polystore.
- Host: GitHub
- URL: https://github.com/polypheny/polypheny-fram
- Owner: polypheny
- License: apache-2.0
- Created: 2020-02-13T15:20:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T13:22:12.000Z (over 1 year ago)
- Last Synced: 2024-02-16T12:37:09.394Z (9 months ago)
- Language: Java
- Homepage:
- Size: 2.51 MB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Polypheny-FRAM #
[](https://github.com/polypheny/Polypheny-FRAM/actions?query=workflow%3ACI)
[](https://www.codefactor.io/repository/github/polypheny/polypheny-fram/overview/master)
[](https://nexus.dmi.unibas.ch/#browse/search/maven=attributes.maven2.groupId%3Dorg.polypheny%20AND%20attributes.maven2.artifactId%3Dpolypheny-fram)
_Polypheny-FRAM_ is a plugin for Polypheny-DB making it the distributed polystore.
Polypheny-FRAM is a research system developed at the University of Basel, Switzerland.
Polypheny-FRAM is not intended to be used in a productive environment! Instead, it helps distributed database researchers to test and evaluate novel data management protocols.
## Getting Started (Standalone Mode) ##
1) Clone the repository
2) Run `gradlew jdk11_zipLinux64Package` to build a Linux distribution or `gradlew jdk11_zipWindows64Package` to build a Windows distribution. `gradlew jdk11_zipAll` builds both.
> Note: OpenJDK 8 or 11 required to run this step.
3) Enter either the Windows or the Linux distribution which have been assembled in `build/distributions`
- Linux: run `bin/polypheny-fram`
- Windows: run `bin\polypheny-fram`
> Note for the Windows JDK 8 release (built with the target `jdk8_zipWindows64Package`):\
Append the console arguments "bin\polypheny-fram.exe -c --console" to attach a console to the process. Otherwise, Polypheny-FRAM would run as background process. This is a limitation of [packr](https://github.com/libgdx/packr). See [here](https://github.com/libgdx/packr#executable-command-line-interface) for details.
4) a) Benchmark Polypheny-FRAM using [OLTPBench for Polypheny-FRAM](https://github.com/nouda/oltpbench). Working benchmarks:
- TPC-C (Transaction Processing Performance Council, Benchmark C)
> Limitations:
> - only one terminal if using writes
> - without the "StockLevel" transaction
- YCSB (Yahoo! Cloud Serving Benchmark)
> Limitations:
> - only one terminal if using writes
b) Connect to Polypheny-FRAM using [polypheny-jdbc-driver:1.3](https://nexus.dmi.unibas.ch/#browse/search/maven=attributes.maven2.groupId%3Dorg.polypheny%20AND%20attributes.maven2.artifactId%3Dpolypheny-jdbc-driver%20AND%20version%3D1.3) with the following connection details:
- Driver Class: `org.polypheny.jdbc.Driver`
- Connection URL: `jdbc:polypheny://localhost/`
> Note: You can also use the Apache Calcite Avatica driver [avatica-core:1.16.0](https://mvnrepository.com/artifact/org.apache.calcite.avatica/avatica-core/1.16.0).
Use the following connection details:
> - Driver Class: `org.apache.calcite.avatica.remote.Driver`
> - Connection URL: `jdbc:avatica:remote:url=http://localhost:20591;serialization=protobuf`
### Configuration ###
Polypheny-FRAM uses the [typesafe](https://github.com/lightbend/config) library.
Copy the file `conf/sample-application.conf` to `conf/application.conf` and edit the `conf/application.conf` to fit your needs.
You can find the HOCON syntax [here](https://github.com/lightbend/config/blob/master/HOCON.md).
### Persistency of Data ###
In the standalone mode, Polypheny-FRAM uses HSQLDB as the underlying data storage. By default, HSQLDB is configured to use in memory databases. Therefore, after Polypheny-FRAM has terminated, all data is lost.
## Polypheny-DB Plugin ##
Polypheny-FRAM can extend Polypheny-DB to provide data management protocols running on top of a cluster of Polypheny-DB nodes. Basically, distributing the polystore.
> Note: The extension mode is currently not available. Use the standalone mode to explore Polypheny-FRAM.
## Credits ##
_Polypheny-FRAM_ is based on the [Apache Calcite](https://calcite.apache.org/) server project and uses several other projects:
* [Apache Avatica](https://calcite.apache.org/avatica/): A framework for building JDBC drivers
* [Apache Calcite](https://calcite.apache.org/): A framework for building databases
* [HSQLDB](http://hsqldb.org/): A relational database written in Java
* [JavaCC](https://javacc.org/): A parser generator
* [JGroups](http://www.jgroups.org/): A powerful library for reliable messaging
* [Project Lombok](https://projectlombok.org/): A library providing compiler annotations
* [Micrometer](https://micrometer.io/): A library providing a facade for metrics
* [Typesafe Config](https://lightbend.github.io/config/): A library managing the configuration of the application
* and many more! Please check the dependencies in the build.gradle file.
Those projects are used "as is" and are integrated as libraries.
## Acknowledgements ##
The Polypheny-DB project is supported by the Swiss National Science Foundation (SNSF) under the contract no. 200021_172763.
## License ##
The Apache License, Version 2.0