Skip to content
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.

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

[10.x] v10 Upgrade guide #676

Merged
merged 3 commits into from
Dec 16, 2022
Merged
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
# Upgrade Guide

## Upgrading To 10.0 From 9.x

### Minimum Versions

The following dependency versions have been updated:

- The minimum PHP version is now v8.0
- The minimum Laravel version is now v9.0

### The `getScoutKeyName` Method

PR: https://github.com/laravel/scout/pull/509

In Scout 10.x, the `getScoutKeyName` method will return the unqualified key name and no longer qualifies the key name with the table name. If you are overriding the `getScoutKeyName` method you will need to account for this change and make sure you return an unqualified key name.

```diff
public function getScoutKeyName()
{
- return 'posts.id';
+ return 'id';
}
```

### Removal Of `getUnqualifiedScoutKeyName`

PR: https://github.com/laravel/scout/pull/657

Due to the `getScoutKeyName` change discussed above, the `getUnqualifiedScoutKeyName` method was removed as it is no longer necessary.

## Upgrading To 9.0 From 8.x

### Minimum Laravel Version
Expand Down