wip

Author: freekmurze

.github/workflows/run-tests.yml

@@ -21,20 +21,52 @@ jobs:
           - 7700:7700
         options: --health-cmd "curl -f http://localhost:7700/health" --health-interval 2s --health-timeout 5s --health-retries 15
 
+      mysql:
+        image: mysql:8
+        env:
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_DATABASE: site_search_test
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: site_search_test
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
         php: [8.5, 8.4]
         laravel: ['12.*', '13.*']
         stability: [prefer-stable]
+        db: [sqlite]
         include:
           - laravel: 12.*
             testbench: 10.*
           - laravel: 13.*
             testbench: 11.*
+          - os: ubuntu-latest
+            php: '8.4'
+            laravel: '12.*'
+            testbench: '10.*'
+            stability: prefer-stable
+            db: mysql
+          - os: ubuntu-latest
+            php: '8.4'
+            laravel: '12.*'
+            testbench: '10.*'
+            stability: prefer-stable
+            db: pgsql
 
-    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.db }} - ${{ matrix.stability }}
 
     steps:
       - name: Checkout code
@@ -44,7 +76,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, pdo_mysql, pdo_pgsql, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
           coverage: none
 
       - name: Setup problem matchers
@@ -59,3 +91,10 @@ jobs:
 
       - name: Execute tests
         run: vendor/bin/pest
+        env:
+          DB_DRIVER: ${{ matrix.db }}
+          DB_HOST: 127.0.0.1
+          DB_PORT: ${{ matrix.db == 'mysql' && '3306' || matrix.db == 'pgsql' && '5432' || '' }}
+          DB_DATABASE: ${{ matrix.db != 'sqlite' && 'site_search_test' || '' }}
+          DB_USERNAME: ${{ matrix.db == 'mysql' && 'root' || matrix.db == 'pgsql' && 'postgres' || '' }}
+          DB_PASSWORD: ${{ matrix.db != 'sqlite' && 'password' || '' }}

UPGRADING.md

@@ -172,13 +172,48 @@ return new class extends Migration {
 
 These columns are automatically populated after each crawl and shown in `site-search:list`.
 
+#### 6. `SqliteDriver` replaced by `DatabaseDriver`
+
+**Likelihood of impact:** 🔴 **HIGH** - Affects all users using the default driver
+
+The `SqliteDriver` has been replaced by `DatabaseDriver`, which uses your application's database for full-text search. It supports SQLite, MySQL, and PostgreSQL.
+
+If you were using the default `SqliteDriver`, update your config:
+
+**Before:**
+```php
+'default_driver' => Spatie\SiteSearch\Drivers\SqliteDriver::class,
+```
+
+**After:**
+```php
+'default_driver' => Spatie\SiteSearch\Drivers\DatabaseDriver::class,
+```
+
+The new driver stores documents in a `site_search_documents` table instead of separate `.sqlite` files. Publish and run the new migration:
+
+```bash
+php artisan vendor:publish --tag="site-search-migrations"
+php artisan migrate
+```
+
+Then re-index your sites:
+
+```bash
+php artisan site-search:crawl
+```
+
+After re-indexing, you can safely delete the old `storage/site-search` directory.
+
+If you were using a custom `database.connection` in the `extra` config, the key has changed from `sqlite.storage_path` to `database.connection`.
+
 ### New Features
 
 After upgrading, you can:
 
-1. **Use the SQLite driver** (now the default). No external dependencies required.
+1. **Use the database driver** (now the default). Supports SQLite, MySQL, and PostgreSQL with no external dependencies.
    ```php
-   'default_driver' => Spatie\SiteSearch\Drivers\SqliteDriver::class,
+   'default_driver' => Spatie\SiteSearch\Drivers\DatabaseDriver::class,
    ```
 
 2. **Deep linking**. Search results now include anchor links to specific sections. Use `$hit->urlWithAnchor()` to get URLs like `https://example.com/page#section-id`. Requires re-indexing.

config/site-search.php

@@ -65,11 +65,11 @@
      * to a search index.
      *
      * Available drivers:
+     * - DatabaseDriver: uses your application's database with full-text search (SQLite FTS5, MySQL FULLTEXT, PostgreSQL tsvector)
      * - MeiliSearchDriver: uses Meilisearch as the search engine (requires a running Meilisearch instance)
-     * - SqliteDriver: uses a local SQLite database with FTS5 full-text search (no external dependencies)
      * - ArrayDriver: in-memory driver for testing
      */
-    'default_driver' => Spatie\SiteSearch\Drivers\SqliteDriver::class,
+    'default_driver' => Spatie\SiteSearch\Drivers\DatabaseDriver::class,
 
     /*
      * This job is responsible for crawling your site. To customize this job,

database/migrations/create_site_search_documents_table.php.stub

@@ -0,0 +1,27 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up(): void
+    {
+        Schema::create('site_search_documents', function (Blueprint $table) {
+            $table->id();
+            $table->string('index_name')->index();
+            $table->string('document_id');
+            $table->text('url');
+            $table->text('anchor')->nullable();
+            $table->text('page_title')->nullable();
+            $table->text('h1')->nullable();
+            $table->text('entry')->nullable();
+            $table->text('description')->nullable();
+            $table->integer('date_modified_timestamp')->nullable();
+            $table->json('extra')->nullable();
+            $table->timestamps();
+
+            $table->unique(['index_name', 'document_id']);
+        });
+    }
+};

docs/advanced-usage/using-the-database-driver.md

@@ -0,0 +1,46 @@
+---
+title: Using the database driver
+weight: 5
+---
+
+The database driver is the default driver. It stores search documents in your application's database and uses the database's native full-text search capabilities. SQLite (FTS5), MySQL (FULLTEXT), and PostgreSQL (tsvector) are all supported.
+
+## How it works
+
+The database driver stores all indexed documents in a single `site_search_documents` table. Each document is associated with an `index_name`, which allows multiple search indexes to coexist in the same table.
+
+Full-text search infrastructure (virtual tables, indexes, triggers) is created automatically at runtime based on which database you are using. The migration itself is database-agnostic.
+
+### Database-specific behavior
+
+**SQLite** uses FTS5 virtual tables with porter stemming and unicode support. BM25 ranking weights matches in headings higher than body content. Highlighted snippets are generated natively by FTS5.
+
+**MySQL** uses FULLTEXT indexes with boolean mode search. Highlighting is done in PHP after the query.
+
+**PostgreSQL** uses tsvector columns with GIN indexes and weighted vectors. `ts_rank()` is used for ranking and `ts_headline()` for highlighting.
+
+### Search features
+
+All three databases provide:
+
+- Full-text search with stemming (e.g. "running" matches "run")
+- Prefix matching (e.g. "auth" matches "authentication")
+- Relevance ranking with field-specific weights
+- Highlighted snippets with matching terms wrapped in `<em>` tags
+- Deep linking with anchor links to specific sections (see [Retrieving results](/docs/laravel-site-search/v1/basic-usage/retrieving-results#deep-linking-to-sections))
+
+## Using a different database connection
+
+By default, the database driver uses your application's default database connection. You can use a different connection by setting a `database.connection` value in the `extra` attribute of the `site_search_configs` table:
+
+```json
+{"database": {"connection": "mysql"}}
+```
+
+This lets you store search data in a separate database from your application data.
+
+## Differences from the Meilisearch driver
+
+- No external service required, uses your existing database
+- No support for synonyms or custom ranking rules
+- Indexing is synchronous (no background processing)

docs/advanced-usage/using-the-sqlite-driver.md

@@ -5,7 +5,7 @@ weight: 1
 
 This package will crawl your entire site and will put the content in a search index. This way, the entire content of your site is searchable. Think of it as a private Google search index.
 
-The package supports two search drivers: SQLite (default) and Meilisearch. The search and indexing API is the same regardless of which driver you use.
+The package supports two search drivers: Database (default, supporting SQLite, MySQL, and PostgreSQL) and Meilisearch. The search and indexing API is the same regardless of which driver you use.
 
 The configuration for each site that needs to be crawled is saved in the `site_search_configs` table. You can manually create a row in that table or run this artisan command: [`site-search:create-index`](https://spatie.be/docs/laravel-site-search/v1/basic-usage/indexing-your-first-site).
 

docs/basic-usage/high-level-overview.md

@@ -118,11 +118,11 @@ return [
      * to a search index.
      *
      * Available drivers:
+     * - DatabaseDriver: uses your application's database with full-text search (SQLite FTS5, MySQL FULLTEXT, PostgreSQL tsvector)
      * - MeiliSearchDriver: uses Meilisearch as the search engine (requires a running Meilisearch instance)
-     * - SqliteDriver: uses a local SQLite database with FTS5 full-text search (no external dependencies)
      * - ArrayDriver: in-memory driver for testing
      */
-    'default_driver' =>  Spatie\SiteSearch\Drivers\SqliteDriver::class,
+    'default_driver' => Spatie\SiteSearch\Drivers\DatabaseDriver::class,
 
     /*
      * This job is responsible for crawling your site. To customize this job,
@@ -135,6 +135,6 @@ return [
 
 ## Search driver
 
-The default driver is SQLite, which uses SQLite FTS5 for full-text search. It requires no external services. The SQLite databases will be stored in `storage/site-search` by default. See [Using the SQLite driver](/docs/laravel-site-search/v1/advanced-usage/using-the-sqlite-driver) for more configuration options.
+The default driver is the database driver, which uses your application's database for full-text search. It supports SQLite (FTS5), MySQL (FULLTEXT), and PostgreSQL (tsvector) with no external services required. See [Using the database driver](/docs/laravel-site-search/v1/advanced-usage/using-the-database-driver) for more configuration options.
 
 If you need advanced features like synonyms and custom ranking rules, you can [use the Meilisearch driver](/docs/laravel-site-search/v1/advanced-usage/using-the-meilisearch-driver) instead.

docs/installation-setup.md

@@ -7,7 +7,7 @@ This package can crawl and index one or more sites. You can think of it as a pri
 
 Two search drivers are available:
 
-- SQLite (default): uses SQLite FTS5 for full-text search with no external dependencies. A great choice for most use cases.
+- Database (default): uses your application's database for full-text search. Supports SQLite (FTS5), MySQL (FULLTEXT), and PostgreSQL (tsvector). No external dependencies required.
 - Meilisearch: blazing fast search speeds, supports [synonyms](/docs/laravel-site-search/v1/advanced-usage/using-the-meilisearch-driver#customizing-index-settings) and other advanced Meilisearch features. Requires a running Meilisearch instance.
 
 When crawling your site, multiple concurrent connections are used to speed up the crawling process.

docs/introduction.md

@@ -5,5 +5,5 @@ weight: 3
 
 Laravel Site Search requires PHP 8.4+ and Laravel 12+.
 
-The default SQLite driver has no additional dependencies. When using the Meilisearch driver, a running Meilisearch instance is also required.
+The default database driver supports SQLite, MySQL, and PostgreSQL with no additional dependencies. When using the Meilisearch driver, a running Meilisearch instance is also required.