Documentation

This document in English.

L’utilisation de ce logiciel vous soumet à nos Conditions d’utilisation.

version 1.1.0

Introduction:

DerbyOOo fait partie d’une Suite d’extensions LibreOffice ~~et/ou OpenOffice~~ permettant de vous offrir des services inovants dans ces suites bureautique.

Cette extension vous permet d’utiliser la base de données Apache Derby en mode intégré, rendant la base de donnée portable (un seul fichier odb).
Elle permet de profiter des propriétés ACID de la base de données Apache Derby sous jancente.

Etant un logiciel libre je vous encourage:

A dupliquer son code source.
A apporter des modifications, des corrections, des améliorations.
D’ouvrir un dysfonctionnement si nécessaire.

Bref, à participer au developpement de cette extension.
Car c’est ensemble que nous pouvons rendre le Logiciel Libre plus intelligent.

Prérequis:

L’extension DerbyOOo utilise l’extension jdbcDriverOOo pour fonctionner.
Elle doit donc répondre aux prérequis de l’extension jdbcDriverOOo.

Depuis la version 1.1.0, seul LibreOffice 24.2.x ou supérieur est pris en charge.
S’il ne vous est pas possible d’utiliser une telle version, utilisez la version précédente de DerbyOOo. Mais dans ce cas, cette extension ne peut pas être installée avec l’extension HyperSQLOOo, voir bug #156471.
De plus, il vous sera difficile de migrer les fichiers odb créés sous des versions inférieures de DerbyOOo. Je vous recommande d’utiliser LibreOffice 24.2.x minimum avec DerbyOOo 1.1.0 ou supérieur.

Sous Linux et macOS les paquets Python utilisés par l’extension, peuvent s’il sont déja installé provenir du système et donc, peuvent ne pas être à jour.
Afin de s’assurer que vos paquets Python sont à jour il est recommandé d’utiliser l’option Info système dans les Options de l’extension accessible par:
Outils -> Options -> Pilotes Base -> Pilote SQLite intégré -> Voir journal -> Info système
Si des paquets obsolètes apparaissent, vous pouvez les mettre à jour avec la commande:
pip install --upgrade <package-name>

Installation:

Il semble important que le fichier n’ait pas été renommé lors de son téléchargement.
Si nécessaire, renommez-le avant de l’installer.

Installer l’extension jdbcDriverOOo.oxt

Cette extension est nécessaire pour utiliser Apache Derby avec toutes ses fonctionnalités.
Installer l’extension DerbyOOo.oxt

Redémarrez LibreOffice après l’installation.
Attention, redémarrer LibreOffice peut ne pas suffire.

Sous Windows pour vous assurer que LibreOffice redémarre correctement, utilisez le Gestionnaire de tâche de Windows pour vérifier qu’aucun service LibreOffice n’est visible après l’arrêt de LibreOffice (et tuez-le si ç’est le cas).
Sous Linux ou macOS vous pouvez également vous assurer que LibreOffice redémarre correctement, en le lançant depuis un terminal avec la commande soffice et en utilisant la combinaison de touches Ctrl + C si après l’arrêt de LibreOffice, le terminal n’est pas actif (pas d’invité de commande).

Utilisation:

Comment créer une nouvelle base de données:

Dans LibreOffice / OpenOffice aller à: Fichier -> Nouveau -> Base de données…:

DerbyOOo screenshot 1

A l’étape: Sélectionner une base de données:

selectionner: Créer une nouvelle base de données
Dans: Base de données intégrée: choisir: Pilote SQLite intégré
cliquer sur le bouton: Suivant

DerbyOOo screenshot 2

A l’étape: Enregistrer et continuer:

ajuster les paramètres selon vos besoins…
cliquer sur le bouton: Terminer

DerbyOOo screenshot 3

Maintenant à vous d’en profiter…

Comment ça marche:

DerbyOOo est un service com.sun.star.sdbc.Driver UNO écrit en Python.
Il s’agit d’une surcouche à l’extension jdbcDriverOOo permettant de stocker la base de données Derby dans un fichier odb (qui est, en fait, un fichier compressé).

Son fonctionnement est assez basique, à savoir:

Lors d’une demande de connexion, plusieurs choses sont faites:
- S’il n’existe pas déjà, un sous-répertoire avec le nom: . + nom_du_fichier_odb + .lck est créé à l’emplacement du fichier odb dans lequel tous les fichiers Derby sont extraits du répertoire database du fichier odb (décompression).
- L’extension jdbcDriverOOo est utilisée pour obtenir l’interface com.sun.star.sdbc.XConnection à partir du chemin du sous-répertoire + /Derby.
- Si la connexion réussi, un DocumentHandler est ajouté en tant que com.sun.star.util.XCloseListener et com.sun.star.document.XStorageChangeListener au fichier odb.
- Si la connexion échoue et que les fichiers ont été extraits lors de la phase 1, le sous-répertoire est supprimé.
Lors de la fermeture ou du changement de nom (Enregistrer sous) du fichier odb, si la connexion a réussi, le DocumentHandler copie tous les fichiers présents dans le sous-répertoire dans le (nouveau) répertoire database du fichier odb (zip), puis supprime le sous-répertoire.

Le but principal de ce mode de fonctionnement est de profiter des caractéristiques ACID de la base de données sous-jacente en cas de fermeture anormale de LibreOffice. En contre partie, la fonction: fichier -> Sauvegarder n’a aucun effet sur la base de données sous jacente. Seul la fermeture du fichier odb ou son enregistrement sous un nom different (Fichier -> Enregistrer sous) effectura la sauvegarde de la base de donnée dans le fichier odb.

A été testé avec:

LibreOffice 24.2.1.2 - Ubuntu 22.04

Je vous encourage en cas de problème
de créer un dysfonctionnement
J’essaierai de le résoudre

Historique:

Ce qui a été fait pour la version 1.0.0:

Implémentation d’un nouveau format dans les fichiers odb permettant de prendre en compte le nom du catalogue de la base de données sous-jacente.

Ce qui a été fait pour la version 1.1.0:

Cette version est basée sur la correction #154989 disponible depuis LibreOffice 24.2.x. Elle peut donc fonctionner avec les autres extensions proposant des services de bases de données intégrées.
Désormais, DerbyOOo nécessite LibreOffice 24.2.x minimum et se chargera pour l’url: sdbc:embedded:derby.

Que reste-t-il à faire pour la version 1.1.0:

Ajouter de nouvelles langue pour l’internationalisation…
Tout ce qui est bienvenu…