Skip to content

Commit

Permalink
Oups! Forgot to add the new files to the last commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
@beaud76
beaud76 committed Aug 6, 2017
1 parent 6ace319 commit 3561eac
Show file tree
Hide file tree
Showing 4 changed files with 248 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/en/content.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
E-Maj distribution content
==========================

Once :doc:`installed <install>`, an E-Maj version contents the following files.

+---------------------------------------------+---------------------------------------------------------------------+
| Files | Usage |
+=============================================+=====================================================================+
| sql/emaj--2.1.0.sql | installation script of the extension (vers. 2.1.0) |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--2.0.1--2.1.0.sql | extension upgrade script from 2.0.1 to 2.1.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--2.0.0--2.0.1.sql | extension upgrade script from 2.0.0 to 2.0.1 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--1.3.1--2.0.0.sql | extension upgrade script from 1.3.1 to 2.0.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--unpackaged--1.3.1.sql | script that transforms an existing 1.3.1 version into extension |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.3.0-to-1.3.1.sql | psql script that upgrades a 1.3.0 version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.2.0-to-1.3.0.sql | psql script that upgrades a 1.2.0 E-Maj version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.1.0-to-1.2.0.sql | psql script that upgrades a 1.1.0 E-Maj version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.0.2-to-1.1.0.sql | psql script that upgrades a 1.0.2 E-Maj version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.0.1-to-1.0.2.sql | psql script that upgrades a 1.0.1 E-Maj version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.0.0-to-1.0.1.sql | psql script that upgrades a 1.0.0 E-Maj version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-0.11.1-to-1.0.0.sql | psql script that upgrades a 0.11.1 E-Maj version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-0.11.0-to-0.11.1.sql | psql script that upgrades a 0.11.0 E-Maj version |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj_demo.sql | psql E-Maj demonstration script |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj_prepare_parallel_rollback_test.sql | psql test script for parallel rollbacks |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj_uninstall.sql | psql script to uninstall the E-Maj components |
+---------------------------------------------+---------------------------------------------------------------------+
| README.md | reduced extension's documentation |
+---------------------------------------------+---------------------------------------------------------------------+
| CHANGES.md | release notes |
+---------------------------------------------+---------------------------------------------------------------------+
| LICENSE | information about E-Maj license |
+---------------------------------------------+---------------------------------------------------------------------+
| AUTHORS | who are the authors |
+---------------------------------------------+---------------------------------------------------------------------+
| META.json | technical data for PGXN |
+---------------------------------------------+---------------------------------------------------------------------+
| emaj.control | extension control file used by the integrated extensions management |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_doc_en.pdf | English version of the full E-Maj documentation |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_doc_fr.pdf | French version of the full E-Maj documentation |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_pres.en.pdf | English version of the E-Maj presentation |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_pres.fr.pdf | French version of the E-Maj presentation |
+---------------------------------------------+---------------------------------------------------------------------+
| php/emajParallelRollback.php | php tool for parallel rollback |
+---------------------------------------------+---------------------------------------------------------------------+
| php/emajRollbackMonitor.php | php tool for rollbacks monitoring |
+---------------------------------------------+---------------------------------------------------------------------+

60 changes: 60 additions & 0 deletions docs/en/install.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Installing the E-Maj software
=============================

Downloading sources
*******************

E-Maj is available for download on the Internet site **PGXN**, the PostgreSQL Extension Network (http://pgxn.org).

E-Maj and its add-ons are also available on the **github.org** Internet site:

* source components (https://github.com/beaud76/emaj)
* documentation (https://github.com/beaud76/emaj_doc)
* plug-in for phpPgAdmin (https://github.com/beaud76/emaj_ppa_plugin)
* Emaj_web GUI (https://github.com/beaud76/emaj_web)


Installation on Linux
*********************

Download the latest E-Maj version by any convenient way. If the *pgxn* client is installed, just execute the command::

pgxn download E-Maj

Then decompress the downloaded archive file and execute the installation procedure with the following commands::

unzip e-maj-<version>.zip
cd e-maj-<version>/
sudo make install

The latest E-Maj version is now installed and referenced by PostgreSQL. The e-maj-<version> directory contains the file tree :doc:`described here <content>`.

NB: The *sudo make uninstall* command allows to revert the last command.

NB: It is not recommanded to fully install the software with a single *pgxn install E-Maj* command. Indeed, although such a command correctly installs the files needed to :doc:`create later an emaj EXTENSION<setup>` in a database, all other files distributed in the archive (php clients, other sql scripts, documentation) would not be available.

Installation on Windows
***********************

To install E-Maj on Windows:

* Download the extension from the *pgxn.org* site,
* Extract the file tree from the downloaded zip file,
* Copy the files *emaj.control* and *sql/emaj--** into the share\\extension folder of the PostgreSQL installation folder (typically c:\\Program_Files\\PostgreSQL\\<postgres_version>)

Alternate location of SQL installation scripts
**********************************************

The *emaj.control* file located in the *SHAREDIR* directory of the PostgreSQL version, may contain a directive that defines the directory where SQL installation scripts are located.

So it is possible to only put the *emaj.control* file into this *SHAREDIR* directory, by creating a pointer towards the script directory.

To setup this, just:

* identify the precise location of the *SHAREDIR* directory by using the shell command ::

pg_config --sharedir

* copy the *emaj.contol* file from the root directory of the decompressed structure into the *SHAREDIR* directory,
* adjust the *directory* parameter of the *emaj.control* file to reflect the actual location of the E-Maj SQL scripts.

65 changes: 65 additions & 0 deletions docs/fr/content.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
Contenu de la distribution E-Maj
================================

Après :doc:`installation <install>`, une version d’E-Maj contient les fichiers suivants.

+---------------------------------------------+---------------------------------------------------------------------+
| Fichiers | Usage |
+=============================================+=====================================================================+
| sql/emaj--2.1.0.sql | script d’installation de l’extension |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--2.0.1--2.1.0.sql | script d’upgrade de l’extension de 2.0.1 vers 2.1.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--2.0.0--2.0.1.sql | script d’upgrade de l’extension de 2.0.0 vers 2.0.1 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--1.3.1--2.0.0.sql | script d’upgrade de l’extension de 1.3.1 vers 2.0.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj--unpackaged--1.3.1.sql | script de transformation en extension d'une version 1.3.1 existante |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.3.0-to-1.3.1.sql | script de mise à jour d’une version E-Maj 1.3.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.2.0-to-1.3.0.sql | script de mise à jour d’une version E-Maj 1.2.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.1.0-to-1.2.0.sql | script de mise à jour d’une version E-Maj 1.1.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.0.2-to-1.1.0.sql | script de mise à jour d’une version E-Maj 1.0.2 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.0.1-to-1.0.2.sql | script de mise à jour d’une version E-Maj 1.0.1 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-1.0.0-to-1.0.1.sql | script de mise à jour d’une version E-Maj 1.0.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-0.11.1-to-1.0.0.sql | script de mise à jour d’une version E-Maj 0.11.1 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj-0.11.0-to-0.11.1.sql | script de mise à jour d’une version E-Maj 0.11.0 |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj_demo.sql | script psql de démonstration d' E-Maj |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj_prepare_parallel_rollback_test.sql | script psql de test pour les rollbacks parallélisés |
+---------------------------------------------+---------------------------------------------------------------------+
| sql/emaj_uninstall.sql | script psql de désinstallation |
+---------------------------------------------+---------------------------------------------------------------------+
| README.md | documentation réduite de l'extension |
+---------------------------------------------+---------------------------------------------------------------------+
| CHANGES.md | notes de versions |
+---------------------------------------------+---------------------------------------------------------------------+
| LICENSE | information sur la licence utilisée pour E-Maj |
+---------------------------------------------+---------------------------------------------------------------------+
| AUTHORS | identification des auteurs |
+---------------------------------------------+---------------------------------------------------------------------+
| META.json | données techniques destinées à PGXN |
+---------------------------------------------+---------------------------------------------------------------------+
| emaj.control | fichier de contrôle utilisé par la gestion intégrée des extensions |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_doc_en.pdf | documentation en anglais de l'extension E-Maj |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_doc_fr.pdf | documentation en français de l'extension E-Maj |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_pres.en.pdf | présentation en anglais de l'extension E-Maj |
+---------------------------------------------+---------------------------------------------------------------------+
| doc/Emaj.<version>_pres.fr.pdf | présentation en français de l'extension E-Maj |
+---------------------------------------------+---------------------------------------------------------------------+
| php/emajParallelRollback.php | client php pour les rollbacks parallélisés |
+---------------------------------------------+---------------------------------------------------------------------+
| php/emajRollbackMonitor.php | client php pour le suivi des rollbacks |
+---------------------------------------------+---------------------------------------------------------------------+

58 changes: 58 additions & 0 deletions docs/fr/install.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
Installation du logiciel E-Maj
==============================

Source de téléchargement
************************

E-Maj est disponible en téléchargement sur le site Internet **PGXN** (http://pgxn.org).

E-Maj et ses compléments sont également disponibles sur le site Internet **github.org** :

* Composants sources (https://github.com/beaud76/emaj)
* Documentation (https://github.com/beaud76/emaj_doc)
* Plugin pour phpPgAdmin (https://github.com/beaud76/emaj_ppa_plugin)
* Interface graphique Emaj_web (https://github.com/beaud76/emaj_web)


Installation sur Linux
**********************

Télécharger la dernière version d’E-Maj par un moyen à votre convenance. Si le *client pgxn* est installé, on peut simplement exécuter la commande ::

pgxn download E-Maj

Puis décompresser l’archive et exécuter la procédure d’installation, en enchaînant les commandes suivantes ::

unzip e-maj-<version>.zip
cd e-maj-<version>/
sudo make install

La dernière version d’E-Maj est maintenant installée et référencée par PostgreSQL. Le répertoire e-maj-<version> contient l’arborescence :doc:`décrite ici <content>`.

NB : La commande *sudo make uninstall* permet d’annuler la dernière commande.

NB : Il n’est pas recommandé de faire l’installation complète d’E-Maj en une seule commande *pgxn install E-Maj*. En effet, bien que cette commande installe correctement les fichiers nécessaires à la :doc:`création ultérieure de l’EXTENSION emaj<setup>` dans une base de données, elle ne permet pas d’obtenir tous les autres fichiers de la distribution (clients php, autres scripts sql, documentation,…).

Installation sous Windows
*************************

Pour installer E-Maj sous Windows, il faut :

* Télécharger l’extension depuis le site pgxn.org,
* Extraire l’arborescence du fichier zip reçu,
* En copier les fichiers *emaj.control* et *sql/emaj--** dans le dossier *share\\extension* du dossier d’installation de la version de PostgreSQL (typiquement *c:\\Program_Files\\PostgreSQL\\<version_postgres>*).

Localisation alternative des scripts SQL d’installation
*******************************************************

Le fichier *emaj.control*, positionné dans le répertoire *SHAREDIR* de la version de PostgreSQL, peut contenir une directive indiquant à PostgreSQL le répertoire dans lequel sont localisés les scripts SQL d’installation ou d’upgrade.

Il est donc possible de ne mettre dans ce répertoire *SHAREDIR* que le seul fichier *emaj.control* en créant ce pointeur vers le répertoire de scripts. Pour ce faire, il faut :

* Identifier l’emplacement précis du répertoire *SHAREDIR* de l'installation en utilisant la commande shell ::

pg_config --sharedir

* Copier le fichier *emaj.control* fourni dans le répertoire racine de la version décompressée vers le répertoire *SHAREDIR*,
* Adapter la directive *directory* du fichier *emaj.control* pour spécifier le répertoire sql contenant les scripts d’installation d’E-Maj.

0 comments on commit 3561eac

Please sign in to comment.