Skip to content

xebialabs-community/xlr-sql-export-hook

Repository files navigation

XLR SQL Export Hook

Build Status Codacy Badge License: MIT Github All Releases

Overview

This export hook exports release data into sql database. It also exports phases, tasks, teams, permissions, team members, variables and tags of the release.

Prerequisites

My SQL or MariaDB

  1. Install MySQL or MariaDB
  2. Create new database with name will be used in JDBC URL
  3. Download the latest version of MySQL connector/J and put into <XLRELEASE_SERVER_HOME>/plugins

PostgreSQL

  1. Install PostgreSQL
  2. Create new database with name that will be used in JDBC URL
  3. Download the latest version of PostgreSQL driver and put into <XLRELEASE_SERVER_HOME>/plugins

Setup

  1. Make sure that your database server uses UTF-8 as default encoding otherwise, check this mySQL link / PostgreSQL link

  2. Set up database schema:

    • MySQL mysql -u<user> -p<password> -D <database> < ./myTables.sql
    • PostgreSQL psql <database> -U <user> -W <password> < ./pgTable.sql
  3. Copy plugin JAR to plugins folder (<XLRELEASE_SERVER_HOME>/plugins)

  4. restart XL Release server

  5. in XL Release go to Setting -> Configuration -> Add Sql export hook. Fill in your username, password, JDBC url:

    • MySQL
    Description Property
    JDBC URL jdbc:mysql://<host>:<port>/<database>
    Driver com.mysql.jdbc.Driver

    MySQL Configuraiton

    • PostgreSQL
    Description Property
    JDBC URL jdbc:postgresql://<host>:<port>/<database>
    Driver org.postgresql.Driver

    PostgreSQL Configuraiton

  6. Check that archiving is enabled