How to create a new driver for Datamaintain

THIS IS A WORK IN PROGRESS

Write a driver for Datamaintain

For now, these drivers are available:

• MongoDB

If you want to add a new driver, please start by check the contribution guidelines.

Create a new gradle module

Create a new gradle module, named driver-<DBMS name> with the following tree view:

.
├── build.gradle.kts
└── src
    ├── main
    │   └── kotlin
    │       └── datamaintain
    │           └── db
    │               └── driver
    │                   └── <DBMS-name>
    └── test
        └── kotlin
            └── datamaintain
                └── db
                    └── driver
                        └── <DBMS-name>

Your build.gradle.kts should contain this:

plugins {
    id("org.jetbrains.kotlin.jvm")
    maven // Needed for Jitpack
}

baseProject()

repositories {
    jcenter()
}

dependencies {
    compileOnly(project(":modules:core"))
    testImplementation(project(":modules:core"))
}

Add your module in the settings.gradle.kts in the project root directory.

Implement the drivers interfaces

Your driver is what Datamaintain will use to communicate with your database management system (DBMS). To implement a driver, please implement the following classes:

• DatamaintainDriver
• DatamaintainDriverConfig

Add a sample

Update the documentation