This document provides the necessary steps to upgrade from a previous version.
{tip} Version 6.1.x uses the same database structure as the previous version (5.0.x).
Support for PHP 5.5.x/5.6.x has been dropped since version 5.0.0. From version 5.0.0 onward, PHP 7.0.13 or greater is required.
The doctrine/dbal
package is required to successfully execute the upgrade migrations, so make sure it's installed.
composer require doctrine/dbal
{note} Any changes made to the initial Audit Migration should be taken into account, do not blindly copy and paste!
Use the following migration to convert a default 4.1.x table structure into the 6.1.x version:
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class UpdateAuditsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('audits', function (Blueprint $table) {
$table->string('tags')->nullable();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
// There's no turning back
}
}
All Auditable
models must implement the OwenIt\Auditing\Contracts\Auditable
interface.
{tip} Take a look at the brief example in the Model Setup.
Use the following migration to convert a default 3.1.x table structure into the 6.1.x version:
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class UpdateAuditsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('audits', function (Blueprint $table) {
$table->increments('id')->change();
$table->renameColumn('type', 'event');
$table->renameColumn('old', 'old_values');
$table->renameColumn('new', 'new_values');
$table->unsignedInteger('user_id')->nullable()->change();
$table->renameColumn('route', 'url');
$table->string('user_agent')->nullable();
$table->string('tags')->nullable();
$table->timestamp('updated_at')->nullable();
});
// Set the updated_at value and keep the current created_at value.
DB::table('audits')->whereNull('updated_at')->update([
'created_at' => DB::raw('created_at'),
'updated_at' => DB::raw('created_at'),
]);
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
// There's no turning back
}
}
All Auditable
models must implement the OwenIt\Auditing\Contracts\Auditable
interface.
{tip} Take a look at the brief example in the Model Setup.
Use the following migration to convert a default 2.4.x table structure into the 6.1.x version:
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class UpdateAuditsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('audits', function (Blueprint $table) {
$table->unsignedInteger('user_id')->nullable()->change();
$table->unsignedInteger('owner_id')->change();
$table->renameColumn('owner_id', 'auditable_id');
$table->renameColumn('owner_type', 'auditable_type');
$table->index([
'auditable_id',
'auditable_type',
]);
$table->renameColumn('type', 'event');
$table->renameColumn('old_value', 'old_values');
$table->renameColumn('new_value', 'new_values');
$table->renameColumn('route', 'url');
$table->renameColumn('ip', 'ip_address');
$table->string('user_agent')->nullable();
$table->string('tags')->nullable();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
// There's no turning back
}
}
Version 6.1.0 brings a slight change in the way Audit Resolvers are registered.
{tip} When in doubt, check the bundled configuration file and update or simply replace your current file and make the appropriate changes.
Audit queue support has been removed since version 4.0.0.
Since version 4.0.0, Auditable
custom message and fields are no longer supported.
Models should be updated to reflect this change, by removing the $auditCustomMessage
and $auditCustomFields
attributes.
{tip} Documentation on how to display changes can be seen in the Audit Presentation section.