1 package DBIx::Class::Journal;
3 use base qw/DBIx::Class/;
8 our $VERSION = '0.900001_04';
9 $VERSION = eval $VERSION; # no errors in dev versions
11 ## On create/insert, add new entry to AuditLog
15 $self->result_source->schema->_journal_schema;
19 my ($self, @args) = @_;
21 return if $self->in_storage;
23 my $res = $self->next::method(@args);
25 $self->journal_log_insert;
30 sub journal_log_insert {
33 if ( $self->in_storage ) {
34 my $j = $self->_journal_schema;
35 my $change_id = $j->journal_create_change()->id;
36 $j->journal_update_or_create_log_entry( $self, create_id => $change_id );
37 $j->journal_record_in_history( $self, audit_change_id => $change_id );
41 ## On delete, update delete_id of AuditLog
45 $self->next::method(@_);
46 $self->journal_log_delete(@_);
49 sub journal_log_delete {
52 unless ($self->in_storage) {
53 my $j = $self->_journal_schema;
54 $j->journal_update_or_create_log_entry( $self, delete_id => $j->journal_create_change->id );
58 ## On update, copy previous row's contents to AuditHistory
62 $self->journal_log_update(@_);
63 $self->next::method(@_);
66 sub journal_log_update {
69 if($self->in_storage) {
70 my $j = $self->_journal_schema;
72 my $change = $j->journal_create_change;
73 my $prev = $self->result_source->resultset->find( $self->ident_condition );
74 $j->journal_record_in_history( $prev, audit_change_id => $change );
80 DBIx::Class::Journal - auditing for tables managed by DBIx::Class
85 use base 'DBIx::Class::Schema';
87 __PACKAGE__->load_components(qw/Schema::Journal/);
89 __PACKAGE__->journal_connection(['dbi:SQLite:t/var/Audit.db']);
90 __PACKAGE__->journal_user(['My::Schema::User', {'foreign.userid' => 'self.user_id'}]);
95 $schema->changeset_user($user->id);
96 my $new_artist = $schema->txn_do( sub {
97 return $schema->resultset('Artist')->create({ name => 'Fred' });
103 The purpose of this L<DBIx::Class> component module is to create an
104 audit-trail for all changes made to the data in your database (via a
105 DBIx::Class schema). It creates changesets and assigns each
106 create/update/delete operation an id. The creation and deletion date
107 of each row is stored, as well as the previous contents of any row
110 All queries which need auditing must be called using
111 L<DBIx::Class::Schema/txn_do>, which is used to create changesets for
114 To track who did which changes, the user_id (an integer) of the
115 current user can be set, a session_id can also be set, both are
118 To access the auditing schema to look at the auditdata or revert a
119 change, use C<< $schema->_journal_schema >>.
123 The journal schema contains a number of tables.
129 Each changeset row has an auto-incremented ID, optional user_id and
130 session_id, and a set_date which defaults to the current datetime.
132 A ChangeSet has_many Changes.
136 Each change/operation done in the transaction is recorded as a row in
137 the ChangeLog table. It contains an auto-incrementing ID, the
138 changeset_id and an order column for the ordering of each change in
143 For every table in the original database that is to be audited, an
144 AuditLog table is created. Each auditlog row has an id which will
145 contain the primary key of the table it is associated with. (NB:
146 currently only supports integer-based single column PKs). The
147 create_id and delete_id fields contain the IDs of the Changes that
148 created or deleted this row.
152 For every table in the original database to be audited, an
153 AuditHistory table is created. Each row has a change_id field
154 containing the ID of the ChangeLog row. The other fields correspond to
155 all the fields from the original table. Each time a column value in
156 the original table is changed, the entire row contents before the
157 change are added as a new row in this table.
165 =item journal_connection \@connect_info
167 Set the connection information for the database to save your audit
170 Leaving this blank assumes you want to store the audit data into your current
171 database. The storage object will be shared by the regular schema and the
174 =item journal_sources \@source_names
176 Set a list of source names you would like to audit, if unset, all
179 NOTE: Currently only sources with a single-column PK are supported, so
180 use this method if you have sources with multi-column PKs.
182 =item journal_storage_type $type
184 Enter the special storage type of your journal schema if needed. See
185 L<DBIx::Class::Storage::DBI> for more information on storage types.
187 =item journal_user \@rel
189 The user_id column in the L</ChangeSet> will be linked to your user id
190 with a belongs_to relation, if this is set with the appropriate
193 =item journal_deploy_on_connect $bool
195 If set to a true value will cause C<journal_schema_deploy> to be called on
198 Not reccomended, but present for backwards compatibility.
200 =item changeset_user $user_id
202 Set the user_id for the following changeset(s). This must be an integer.
204 =item changeset_session $session_id
206 Set the session_id for the following changeset(s). This must be an integer.
208 =item txn_do $code_ref, @args
210 Overloaded L<DBIx::Class::Schema/txn_do>, this must be used to start a
211 new changeset to cover a group of changes. Each subsequent change to
212 an audited table will use the changeset_id created in the most recent
215 Currently nested C<txn_do> calls cause a single ChangeSet object to be created.
221 L<DBIx::Class> - You'll need it to use this.
225 Only single-column integer primary key'd tables are supported for auditing so far.
227 Updates made via L<DBIx::Class::ResultSet/update> are not yet supported.
229 No API for viewing or restoring changes yet.
231 Patches for the above welcome ;)
235 Jess Robinson <castaway@desert-island.me.uk>
237 Matt S. Trout <mst@shadowcatsystems.co.uk> (ideas and prodding)
241 You may distribute this code under the same terms as Perl itself.