README
------

E-Maj: logs and rollbacks table updates

Version: 0.10.0


1- License

This software is distributed under the GNU General Public License.


2- Objectives

The main goals of E-Maj are:
	- log updates performed on a set of tables.
	- cancel these updates if needed, and reset this set of tables to a predefined stable state.

In development environments, it brings a good help in testing application, providing an easy way to rollback all updates generated by programs execution, and replay these processings as many times as needed.

In production environments, it brings a good solution to: 
	- set inter-batch savepoints on group of tables,
	- easily "restore" this group of tables at a stable state, without being obliged to stop the cluster,
	- handle several savepoints during batch windows, each of them been usable at any time as "restore point".

It brings a good alternative to the management of several disk images.


3- Supplied files 

- README                            this readme file
- CHANGES                           release notes
- LICENSE                           license information 
- AUTHORS                           who is behind E-Maj
- META.json                         meta file for PGXN
- sql/emaj.sql                      psql installation script 
- sql/emaj--0.10.0.sql              script used to create E-Maj as an extension
- sql/emaj.control_base             base control file to create E-Maj as an extension
- sql/emaj--unpackaged--0.10.0.sql  script to registered an existing installation as an extension
- sql/uninstall.sql                 uninstallation script
- sql/demo.sql                      demonstration psql script
- sql/prep-pr.sql                   psql script to prepare parallel rollback demonstration
- doc/emaj.0.10.0_pres_en.pdf		E-Maj presentation in English
- doc/emaj.0.10.0_doc_en.pdf        E-Maj user's guide in English
- doc/emaj.0.10.0_doc_fr.pdf        E-Maj user's guide in French
- php/emajParallelRollback.php      external client for parallel rollback


4- How to install and use E-Maj

All the information detrails needed to install and use E-Maj are provided in the user's guide that is included in the supplied .tar file.

To reach this user's guide, just untar the supplied file by :
tar -xvzf emaj-<version>.tar.gz

Remark: The user's guide also presents an emaj plugin for phpPgAdmin. In its current implementation, this plugin is very invasive inside phpPgAdmin code. For this reason, this plugin is currently not yet available on pgfoundry. But if you wish to get a copy, simply ask me.


5- Support

For additional support or bug report, please contact Philippe BEAUDOIN (phb <dot> emaj <at> free <dot> fr).

Any feedback is welcome, even to just notice you use E-Maj.