README

sqlsync/laravel-sqlsync-filament

Filament v4/v5 Admin Panel plugin for sqlsync/laravel-sqlsync.

Compatibility

Installation

# 1. Install base package
composer require sqlsync/laravel-sqlsync
php artisan sqlsync:install

# 2. Install Filament v4 or v5
composer require filament/filament
php artisan filament:install --panels

# 3. Install this plugin
composer require sqlsync/laravel-sqlsync-filament
php artisan sqlsync-filament:install

Setup

Register the plugin in your Filament Panel Provider:

use SqlSync\FilamentSqlSync\SqlSyncFilamentPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            SqlSyncFilamentPlugin::make()
                ->navigationGroup('SqlSync'),
        ]);
}

Feature Flags

Fluent API takes priority over config:

SqlSyncFilamentPlugin::make()
    ->withDashboard(false)  // hide SqlSync dashboard
    ->withRecords(false)    // hide records resource
    ->withAgents(false)     // hide agents resource + widget
    ->withLogs(false)       // hide logs widget

Or via config/sqlsync-filament.php:

'features' => [
    'dashboard' => true,
    'records'   => true,
    'agents'    => true,
    'logs'      => true,
],

Authorization

SqlSyncFilamentPlugin::make()
    ->authorizeUsing(fn ($user) => $user->hasRole('admin'))

Works with any permission system. No direct Spatie dependency.

Multi-Tenancy

SqlSyncFilamentPlugin::make()
    ->modifyRecordsQueryUsing(
        fn ($query) => $query->where('company_id', auth()->user()->company_id)
    )
    ->modifyAgentsQueryUsing(
        fn ($query) => $query->where('company_id', auth()->user()->company_id)
    )
    ->modifyLogsQueryUsing(
        fn ($query) => $query->where('company_id', auth()->user()->company_id)
    )
    // Required when using query scopes — prevents cache data leaks between tenants
    ->statsCacheKeyUsing(
        fn ($user) => "sqlsync.stats.{$user->company_id}"
    )

Important: If you use query scopes without statsCacheKeyUsing, the stats cache is automatically disabled to prevent data leaking between tenants.

Configuration

php artisan vendor:publish --tag=sqlsync-filament-config

// config/sqlsync-filament.php
return [
    'navigation_group'         => 'SqlSync',
    'navigation_icon'          => 'heroicon-o-arrow-path-rounded-square',

    'features' => [
        'dashboard' => true,
        'records'   => true,
        'agents'    => true,
        'logs'      => true,
    ],

    'polling_interval'         => '30s',  // null to disable
    'online_threshold_minutes' => 5,
    'recent_logs_limit'        => 20,
    'stats_cache_seconds'      => 20,
];

What You Get

Dashboard, Agents, and Logs widgets auto-refresh based on polling_interval. The Records table does not poll.

Developer

Muhammad Khalaf — contact@sqlsync.dev