SIARD Suite 2.2

About

SIARD Suite is a comprehensive toolset for archiving relational databases in the SIARD (Software-Independent Archival of Relational Databases) format. The suite ensures long-term preservation and accessibility of database contents, independent of the original database management system.

Key Features:

• Graphical Interface: User-friendly GUI for archiving, restoring, searching, and exporting databases
• Command-Line Tools: Powerful CLI for automated workflows and scripting
• Multi-Database Support: Compatible with PostgreSQL, MySQL, Oracle, MS SQL Server, DB2, and MS Access
• SIARD Format 2.2: Compliant with the latest SIARD standard for database archival

Project Structure: This is a Gradle-based monorepo containing multiple modules:

• siard-suite-app - Desktop application with GUI
• siard-cmd - Command-line interface
• siard-api - Core API for reading/writing SIARD files
• jdbc-* - Database-specific JDBC wrappers
• Supporting libraries and utilities

Developer Setup

Prerequisites

Java 17 with JavaFX is required. Download from:

• Azul Zulu JDK 17 with FX

For asdf users:

asdf install

Docker is required for running integration tests (uses Testcontainers).

Running the Application

GUI Application:

./gradlew :siard-suite-app:run

Command-Line Interface:

First, build the distribution:

./gradlew :siard-cmd:installDist

Then run the CLI tools:

# Download database to SIARD archive
./siard-cmd/build/install/siard-cmd/bin/siard-from-db <arguments>

# Upload SIARD archive to database
./siard-cmd/build/install/siard-cmd/bin/siard-to-db <arguments>

Code Formatting & Git Blame

We recently performed a bulk reformatting of the entire Java codebase to standardize our style. To avoid seeing "style-only" changes when using git blame, we use a .git-blame-ignore-revs file. This file contains the commit hashes of the formatting commits. Github will automatically use this file and does not show the formatting commits in the blame.

To ignore these formatting commits in your local terminal or IDE, run the following command once in the project root:

git config blame.ignoreRevsFile .git-blame-ignore-revs

Building the Project

Build all modules:

./gradlew clean build -x test

Note: running all tests takes quite long!

Build specific module:

./gradlew :module-name:build

The build creates distributions in build/distributions/ with executable scripts and all dependencies.

Running Tests

Run all tests:

./gradlew test

Run tests for a specific module:

./gradlew :module-name:test

Examples:

./gradlew :siard-api:test           # Core API tests
./gradlew :jdbc-postgres:test       # PostgreSQL wrapper tests
./gradlew :siard-cmd:test           # CLI tests

Integration tests (siard-cmd):

./gradlew :siard-cmd:integrationTest                    # All integration tests
./gradlew :siard-cmd:integrationTestPostgres            # PostgreSQL only
./gradlew :siard-cmd:integrationTestMysql               # MySQL only

Note: all tests require Docker to be running (uses Testcontainers).

Dependency Analysis

The project uses the Dependency Analysis Gradle Plugin to detect dependency issues.

Analyze all dependencies:

./gradlew buildHealth

This generates a report showing:

• Unused dependencies: Dependencies declared but not actually used in code
• Used transitive dependencies: Dependencies used in code but not explicitly declared
• Misused dependencies: Dependencies that should use a different configuration (e.g., api instead of implementation)

View the report:

# Console output shows summary
./gradlew buildHealth

# Detailed HTML report
open build/reports/dependency-analysis/build-health-report.html

Fix issues automatically (where possible):

./gradlew buildHealth --auto-correct

Analyze a specific module:

./gradlew :module-name:buildHealth

Note: The plugin may suggest removing dependencies that are actually needed as transitive dependencies. Always verify suggestions before applying them.

Creating Platform-Specific Packages

Create application image:

./gradlew jpackageImage

The image will be available at ./build/jpackage/siard-suite (OS-specific).

Create installer:

./gradlew jpackage

Creates platform-specific installers (DMG, EXE, MSI, DEB, or RPM).

Ubuntu users: Install alien if RPM building fails:

sudo apt install alien

Versioning and Releases

⚠️ Read the release guide before creating releases!

Versions follow the SIARD format version (2.2.x) and are managed with the Axion Release Plugin.

Check current version:

./gradlew currentVersion

Create a release:

./gradlew release

This creates a tag and pushes it to remote, triggering GitHub Actions to build deliverables.

Note: Official GitHub releases must be created manually by BAR.

Documentation

Documentation is written in AsciiDoc and bundled with the application.

Generate PDF documentation:

./gradlew :siard-suite-app:asciidoctorPdf

Available Documentation:

• User Manual
• Software Architecture Document

Declaration

Contributions to the codebase have been made with the support of Windsurf. Windsurf is AI-powered code completion tool, that is trained exclusively on natural language and source code data with permissive licenses.