Manage tracked changes in Microsoft SQLServer, letting you list changes from Artisan and inside your Laravel application.
This package was written to read tracked changes from MSSQL 2008 and has not been tested on other versions.
Note: This library is for Change Tracking which is distinct from Change Data Capture (CDC).
You can install the package via composer:
composer require patabugen/laravel-mssql-changes
You can publish the config file with:
php artisan vendor:publish --tag="mssql-changes-config"
The package provides artisan commands as well as a programmatic interface.
Features are provided by Actions, which are used by Artisan commands to give us CLI access.
See the asCommand
method on each action for real-life examples of calling the library from PHP.
use Patabugen\MssqlChanges\Actions\ListTableChanges;
use Patabugen\SqlChanges\Table;
use Patabugen\SqlChanges\Change;
$table = Table::create('Contacts');
/** @var Illuminate\Support\Collection $changes */
$changes = ListTableChanges::handle($table);
$changes->each(function(Change $change) {
var_dump($change->toArray();
});
use Patabugen\MssqlChanges\Actions\ListTableChanges;
use Patabugen\SqlChanges\Table;
use Patabugen\SqlChanges\Change;
$table = Table::create('Contacts');
/** @var Illuminate\Support\Collection $changes */
$changes = ListTableChanges::make()
->fromVersion(100)
->toVersion(200)
->handle($table);
$changes->each(function(Change $change) {
var_dump($change->toArray();
});
Note: This package is in it's early stages, these commands may not work yet.
The default database from your config will be used, or set environment variable MSSQL_CHANGES_CONNECTION
to the name of the connection to use.
artisan mssql:enable-database-change-tracking
artisan mssql:enable-table-change-tracking {TableName}
artisan mssql:disable-table-change-tracking {TableName}
artisan mssql:show-changes
artisan mssql:show-table-changes {tableName}
Use --from
and/or --to
to only show changes before or after a given change (inclusive).
artisan mssql:show-changes --from=200 --to=209
artisan mssql:show-table-changes --from=200 --to=209
$ php artisan mssql:list-table-changes Addresses
+-----------+-------------+---------------------+----------------+
| Table | Primary Key | Columns Changed | Change Version |
+-----------+-------------+---------------------+----------------+
| Addresses | 91750 | Address1, upsize_ts | 5 |
+-----------+-------------+---------------------+----------------+
I'd like to add these commands or features:
- Creating a test database for the tests
artisan mssql:disable-change-tracking
artisan mssql:list-status
- Show the status of databases/tables
You'll need a running instance of SQL server with a database already created, see phpunit.xml.dist
for default values. Copy it to phpunit.xml
to customise the tests.
If you have not already, you may need to take extra steps to allow your PHP to connect to MSSQL.
Note: At the time of writing the tests are not fully functional because I've started getting them to create a test database, but not finished it. You may be able to remove the migrations/setup from TestCase and manually create a table called "Contacts" with tracking enabled.
The tests also have some hard-coded numbers which mean they'll break often. That can be solved by finishing the above so RefreshDatabase works, or by using GetVersion to filter the results within each test before making assertions.
composer test
Please see CHANGELOG for more information on what has changed recently.
This package has been created to solve a specific issue in a one-off project so is not likely to receive long term updates.
I've released it as a package in case it might help somebody else one day.
Pull requests are very welcome, especially if they include tests or round out existing/core features. Feel free to submit an issue to discuss a change you'd like.
The MIT License (MIT). Please see License File for more information.