Skip to content

Remove MyISAM requirement from docs #879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RVXD wants to merge 3 commits into
base: 6.1
Choose a base branch
from
Open

Remove MyISAM requirement from docs #879

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ad487b
Remove MyISAM requirement from docs
RVXD Feb 16, 2026
746c4d2
Fixes CI-lint
RVXD Feb 18, 2026
c3af6a5
Fixes CI-lint
RVXD Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 2 additions & 29 deletions en/02_Developer_Guides/12_Search/02_FulltextSearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,14 @@ Fulltext search allows advanced search criteria for searching words within a tex
Fulltext search can be achieved using the built-in [MySQLDatabase](api:SilverStripe\ORM\Connect\MySQLDatabase) class a more powerful wrapper for Fulltext
search is provided through a module.

## Adding fulltext support to `MySQLDatabase`

The [MySQLDatabase](api:SilverStripe\ORM\Connect\MySQLDatabase) class defaults to creating tables using the InnoDB storage engine. As Fulltext search in MySQL
requires the MyISAM storage engine, any DataObject you wish to use with Fulltext search must be changed to use MyISAM
storage engine.

You can do so by adding this static variable to your class definition:

```php
namespace App\Model;

use SilverStripe\ORM\Connect\MySQLSchemaManager;
use SilverStripe\ORM\DataObject;

class MyDataObject extends DataObject
{
private static $create_table_options = [
MySQLSchemaManager::ID => 'ENGINE=MyISAM',
];
}
```

The [FulltextSearchable](api:SilverStripe\ORM\Search\FulltextSearchable) extension will add the correct `Fulltext` indexes to the data model.

> [!CAUTION]
> The [SearchForm](api:SilverStripe\CMS\Search\SearchForm) and [FulltextSearchable](api:SilverStripe\ORM\Search\FulltextSearchable) API's are currently hard coded to be specific to `Page` and `File`
> records and cannot easily be adapted to include custom `DataObject` instances. To include your custom objects in the
> default site search, have a look at those extensions and modify as required.

### Fulltext filter
## Fulltext filter

Silverstripe CMS provides a [FulltextFilter](api:SilverStripe\ORM\Filters\FulltextFilter) which you can use to perform custom fulltext searches on
[DataList](api:SilverStripe\ORM\DataList)s.
Expand All @@ -49,7 +27,6 @@ Example DataObject:
```php
namespace App\Model;

use SilverStripe\ORM\Connect\MySQLSchemaManager;
use SilverStripe\ORM\DataObject;

class SearchableDataObject extends DataObject
Expand All @@ -65,17 +42,13 @@ class SearchableDataObject extends DataObject
'columns' => ['Title', 'Content'],
],
];

private static $create_table_options = [
MySQLSchemaManager::ID => 'ENGINE=MyISAM',
];
}
```

Performing the search:

```php
use App\Model\SearchableDataOBject;
use App\Model\SearchableDataObject;

SearchableDataObject::get()->filter('SearchFields:Fulltext', 'search term');
```
Expand Down