Skip to content

Commit

Permalink
Minor documentation changes in the extractionFunctions.rst file.
Browse files Browse the repository at this point in the history
  • Loading branch information
beaud76 committed Jun 9, 2023
1 parent fa76b0b commit 3d6db81
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
10 changes: 4 additions & 6 deletions docs/en/extractionFunctions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ It may be useful to take images of all tables and sequences belonging to a group
The directory/folder name must be supplied as an absolute pathname and must have been previously created. This directory/folder must have the appropriate permission so that the PostgreSQL instance can write in it.

The third parameter defines the output files format. It is a character string that matches the precise syntax available for the *COPY TO* SQL statement.
The third parameter defines the output files format. It is a character string that matches the precise syntax available for the *COPY TO* SQL statement. Look at the PostgreSQL documentation to get more details about the available options (https://www.postgresql.org/docs/current/sql-copy.html).

The function returns the number of tables and sequences contained by the group.

Expand Down Expand Up @@ -130,11 +130,11 @@ The keyword *'EMAJ_LAST_MARK'* can be used as mark name, representing the last s

The directory/folder name must be supplied as an absolute pathname and must have been previously created. This directory/folder must have the appropriate permission so that the PostgreSQL instance can write in it.

The fifth parameter defines the output files format. It is a character string that matches the precise syntax available for the *COPY TO* SQL statement.
The fifth parameter defines the output files format. It is a character string that matches the precise syntax available for the *COPY TO* SQL statement. Look at the PostgreSQL documentation to get more details about the available options (https://www.postgresql.org/docs/current/sql-copy.html).

The function returns the number of generated files.

This *emaj_snap_log_group()* function generates one file per log table, containing the part of this table that corresponds to the updates performed between both supplied marks. Created files name has the following pattern: *<schema.name>_<table/sequence.name>_log.snap*
This *emaj_snap_log_group()* function generates one file per log table, containing the part of this table that corresponds to the updates performed between both supplied marks. Records are sorted in ascending ordered of change execution. Created files name has the following pattern: *<schema.name>_<table/sequence.name>_log.snap*

The function also generates two files, containing the application sequences state at the time of the respective supplied marks, and named: *<log.table.name>.snap*. So most of the time, they look like: *<group.name>_sequences_at_<mark.name>*.

Expand All @@ -148,6 +148,4 @@ It is not necessary that the tables group be in *IDLE* state to snap log tables.

As this function may generate large or very large files (of course depending on tables sizes), it is user's responsibility to provide a sufficient disk space.

The structure of log tables is directly derived from the structure of the related application table. The log tables contain the same columns with the same type. But they also have some additional technical columns:

The structure of log tables is described :ref:`here <logTableStructure>`.
The log tables structure is described :ref:`here <logTableStructure>`.
8 changes: 3 additions & 5 deletions docs/fr/extractionFunctions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Il peut s'avérer utile de prendre des images de toutes les tables et séquences

Le nom du répertoire fourni doit être un chemin absolu. Ce répertoire doit exister au préalable et avoir les permissions adéquates pour que l'instance PostgreSQL puisse y écrire.

Le troisième paramètre précise le format souhaité pour les fichiers générés. Il prend la forme d'une chaîne de caractères reprenant la syntaxe précise des options disponibles pour la commande SQL *COPY TO*.
Le troisième paramètre précise le format souhaité pour les fichiers générés. Il prend la forme d'une chaîne de caractères reprenant la syntaxe précise des options disponibles pour la commande SQL *COPY TO*. Voir la documentation de PostgreSQL pour le détail des options disponibles (https://www.postgresql.org/docs/current/sql-copy.html).

La fonction retourne le nombre de tables et de séquences contenues dans le groupe.

Expand Down Expand Up @@ -127,11 +127,11 @@ Le mot clé *'EMAJ_LAST_MARK'* peut être utilisé comme marque de fin. Il repr

Le nom du répertoire fourni doit être un chemin absolu. Ce répertoire doit exister au préalable et avoir les permissions adéquates pour que l'instance PostgreSQL puisse y écrire.

Le cinquième paramètre précise le format souhaité pour les fichiers générés. Il prend la forme d'une chaîne de caractères reprenant la syntaxe précise des options disponibles pour la commande SQL *COPY TO*.
Le cinquième paramètre précise le format souhaité pour les fichiers générés. Il prend la forme d'une chaîne de caractères reprenant la syntaxe précise des options disponibles pour la commande SQL *COPY TO*. Voir la documentation de PostgreSQL pour le détail des options disponibles (https://www.postgresql.org/docs/current/sql-copy.html).

La fonction retourne le nombre de fichiers générés.

Cette fonction *emaj_snap_log_group()* génère un fichier par table de log, contenant la partie de cette table correspond aux mises à jour effectuées entre les deux marques citées ou la marque de début et la situation courante. Le nom des fichiers créés pour chaque table est du type : *<nom.de.la.table.de.log>.snap*. Le plus souvent, ce nom ressemblera donc à : *<nom.du.schema>_<nom.de.table>_log.snap*
Cette fonction *emaj_snap_log_group()* génère un fichier par table de log, contenant la partie de cette table correspond aux mises à jour effectuées entre les deux marques citées ou la marque de début et la situation courante. Les enregistrements sont triés dans l’ordre croissant d’exécution des mises à jour. Le nom des fichiers créés pour chaque table est du type : *<nom.de.la.table.de.log>.snap*. Le plus souvent, ce nom ressemblera donc à : *<nom.du.schema>_<nom.de.table>_log.snap*

La fonction génère également deux fichiers, contenant l'état des séquences applicatives lors de la pose respective des deux marques citées, et nommés *<nom.du.groupe>_sequences_at_<nom.de.marque>*.

Expand All @@ -147,6 +147,4 @@ Il n'est pas nécessaire que le groupe de tables soit dans un état inactif, c'e

Comme la fonction peut générer de gros, voire très gros, fichiers (en fonction du volume des tables), il est de la responsabilité de l'utilisateur de prévoir un espace disque suffisant.

Les tables de log ont une structure qui découlent directement des tables applicatives dont elles enregistrent les mises à jour. Elles contiennent les mêmes colonnes avec les mêmes types. Mais elles possèdent aussi quelques colonnes techniques complémentaires :

La structure des tables de log est décrite :ref:`ici <logTableStructure>`.

0 comments on commit 3d6db81

Please sign in to comment.