Skip to content

Commit

Permalink
Several documentation changes: 1) in the chapter about the software i…
Browse files Browse the repository at this point in the history
…nstallation under linux, remove the use of the "sudo make install" command as it requires some packages that are not necessarily installed and replace it by 2 simple sudo cp commands, 2) fix an error in the paragraph named "Alternate location of SQL installation scripts", 3) add a note in the paragraph about the logical replication and 4) provide a more precise url towards the e-maj page on pgxn.org web site. Remove the Makefile file from the distribution as it is now useless.
  • Loading branch information
beaud76 committed Feb 28, 2018
1 parent 750abb3 commit 44fa362
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 43 deletions.
15 changes: 0 additions & 15 deletions Makefile

This file was deleted.

2 changes: 1 addition & 1 deletion docs/en/impactsAdmin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Starting with version 10, PostgreSQL includes logical replication mechanisms. Th
.. image:: images/logical_repl1.png
:align: center

An application table that belongs to a tables group can be replicated, without any particular condition. The effect of any rollback operation that may occur would be simply replicated on *subscriber* side.
An application table that belongs to a tables group can be replicated. The effect of any rollback operation that may occur would be simply replicated on *subscriber* side, as long as no filter has been applied on replicated SQL verbs types.

**Replication of application tables with E-Maj activated on subscriber side**

Expand Down
19 changes: 10 additions & 9 deletions docs/en/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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 is available for download on the Internet site **PGXN**, the PostgreSQL Extension Network (https://pgxn.org/dist/e-maj/).

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

Expand All @@ -17,21 +17,22 @@ E-Maj and its add-ons are also available on the **github.org** Internet site:
Installation on Linux
*********************

Download the latest E-Maj version by any convenient way. If the *pgxn* client is installed, just execute the command::
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>`.
sudo cp emaj.control $(pg_config --sharedir)/extension/.

NB: The *sudo make uninstall* command allows to revert the last command.
sudo cp sql/emaj* $(pg_config --sharedir)/extension/.

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: 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
***********************
Expand All @@ -45,16 +46,16 @@ To install E-Maj on Windows:
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.
The *emaj.control* file located in the *SHAREDIR/extension* 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.
So it is possible to only put the *emaj.control* file into this *SHAREDIR/extension* 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,
* copy the *emaj.contol* file from the root directory of the decompressed structure into the *SHAREDIR/extension* directory,
* adjust the *directory* parameter of the *emaj.control* file to reflect the actual location of the E-Maj SQL scripts.

8 changes: 4 additions & 4 deletions docs/en/quickStart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ The E-Maj installation is described in detail later. But the few following comma
Software install
^^^^^^^^^^^^^^^^

To download and install E-Maj, log on your postgres (or another) account and type::

pgxn download E-Maj
To install E-Maj, log on your postgres (or another) account, download E-Maj from PGXN (https://pgxn.org/dist/e-maj/) and type::

unzip e-maj-<version>.zip

cd e-maj-<version>/

sudo make install
sudo cp emaj.control $(pg_config --sharedir)/extension/.

sudo cp sql/emaj* $(pg_config --sharedir)/extension/.

For more details, or in case of problem, look at :doc:`there <install>`.

Expand Down
2 changes: 1 addition & 1 deletion docs/fr/impactsAdmin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Les versions 10 et suivantes de PostgreSQL intègrent des mécanismes de réplic
.. image:: images/logical_repl1.png
:align: center

Une table applicative appartenant à un groupe de tables E-Maj peut être également mise en réplication, sans condition particulière. Les éventuels rollbacks E-Maj se répliqueront naturellement côté *subscriber*.
Une table applicative appartenant à un groupe de tables E-Maj peut être mise en réplication. Les éventuels rollbacks E-Maj se répliqueront naturellement côté *subscriber*, à condition qu’aucun filtre ne soit appliqué sur les types de verbes SQL répliqués.

**Réplication de tables applicatives avec gestion par E-Maj côté subscriber**

Expand Down
19 changes: 10 additions & 9 deletions docs/fr/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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 est disponible en téléchargement sur le site Internet **PGXN** (https://pgxn.org/dist/e-maj/).

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

Expand All @@ -24,14 +24,15 @@ Télécharger la dernière version d’E-Maj par un moyen à votre convenance. S
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>`.
sudo cp emaj.control $(pg_config --sharedir)/extension/.

NB : La commande *sudo make uninstall* permet d’annuler la dernière commande.
sudo cp sql/emaj* $(pg_config --sharedir)/extension/.

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 : 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
*************************
Expand All @@ -45,14 +46,14 @@ Pour installer E-Maj sous Windows, il faut :
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.
Le fichier *emaj.control*, positionné dans le répertoire *SHAREDIR/extension* 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 :
Il est donc possible de ne mettre dans ce répertoire *SHAREDIR/extension* 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
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*,
* Copier le fichier *emaj.control* fourni dans le répertoire racine de la version décompressée vers le répertoire *SHAREDIR/extension*,
* Adapter la directive *directory* du fichier *emaj.control* pour spécifier le répertoire sql contenant les scripts d’installation d’E-Maj.

8 changes: 4 additions & 4 deletions docs/fr/quickStart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ L’installation d’E-Maj est présentée plus loin en détail. Mais les quelqu
Installation du logiciel
^^^^^^^^^^^^^^^^^^^^^^^^

Pour télécharger et installer le logiciel E-Maj, connectez-vous à votre compte postgres (ou un autre) et tapez ::

pgxn download E-Maj
Pour installer le logiciel E-Maj, connectez-vous à votre compte postgres (ou un autre), téléchargez E-Maj depuis PGXN (https://pgxn.org/dist/e-maj/) et tapez ::

unzip e-maj-<version>.zip

cd e-maj-<version>/

sudo make install
sudo cp emaj.control $(pg_config --sharedir)/extension/.

sudo cp sql/emaj* $(pg_config --sharedir)/extension/.

Pour plus de détails, ou en cas de problème, allez :doc:`ici <install>`.

Expand Down

0 comments on commit 44fa362

Please sign in to comment.