Skip to content

Huluvu424242/nitrite-spring-boot-starter

Repository files navigation

License LGPL%20v3 blue Maven Central Build Status Codacy code quality badge Scrum Board,scaledwidth=

standard-readme compilant

nitrite-spring-boot-starter

Ein Spring Boot Starter zum Einbinden der Nitrite Datenbank

Hintergrund

Die Konfiguration externer Datenbanken wie Nitrite ist für Spring Boot Einsteiger nicht sofort klar durchschaubar. Außerdem müssen in jedem verwendeten spring boot Projekt bei der Einbindung der Datenbank die gleichen "Handgriffe" erledigt werden. Daher bietet sich ein Starter zur Einbindung an.

Dieses Projekt realisiert einen solchen Starter mit folgenden Features:

  • Der Starter ist unabhängig von der konkret eingebundenen Nitrite Version, da er nur die Konfiguration und ein wenig Infrastruktur zur Verfügung stellt.

  • Der Endnutzer kann selbst entscheiden welche Nitrite Version zum Einsatz kommt ohne die Starter Version wechseln zu müssen.

  • Die Abhängigkeit zur Nitrite Datenbank wird im Endnutzerprojekt explizit benötigt → klare Aussage in der pom.xml im Gegensatz zu transitiven Abhängigkeiten.

Installation

Die "Installation" erfolgt durch Einbinden in die pom.xml. Wird wie folgt erledigt:

pom.xml
<!-- nitrite db -->
<dependency>
  <groupId>com.github.funthomas424242</groupId>
  <artifactId>nitrite-spring-boot-starter</artifactId>
  <version>0.0.2</version>
</dependency>
<dependency>
  <groupId>org.dizitart</groupId>
  <artifactId>nitrite</artifactId>
  <version>3.3.0</version>
  <scope>compile</scope>
</dependency>

Folgende Konfigurationsmöglichkeiten werden vom Starter realisiert:

application.properties
nitrite.dbfilePath=<path zur Datenbankdatei | empty für in-memory Datenbank>
nitrite.username=
nitrite.password=
nitrite.disableautocommit=<true | false>
nitrite.compressed=<true | false>

Nutzung

Wie unter Installation beschrieben.

Projektverantwortlicher

Unterstützung

Unterstützung ist jederzeit erwünscht. Ein gelungener Einstieg sollte sich über Duchlesen, Prüfen/Testen, Korrigieren/Weiterentwickeln und Änderungen als Pull-Request einstellen, ergeben. Du kannst aber auch jederzeit gern ein Ticket öffnen unter: Ticket Erstellen.

Dieses Projekt folgt den unter Verhaltenskodex abgelegten Verhaltensregeln. Welche auch unter Verhaltenskodex für Unterstützer veröffentlicht wurden.

Unterstützer

Dieses Projekt lebt vom Support all seiner Unterstützer genau wie auch vom Support all jener welche nicht namentlich bekannt sind aber das Projekt im Internet bekannt machen oder anderweitig unterstützen.

Vielen Dank für all Euren Suppprt!

Lizenz