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.

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

DOC Document using raw SQL to query join tables #508

Merged
merged 1 commit into from
May 13, 2024
Merged

DOC Document using raw SQL to query join tables #508

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion en/02_Developer_Guides/00_Model/02_Relations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,10 +530,20 @@ class TeamSupporter extends DataObject
You can filter on the relation by the extra fields automatically, assuming they don't conflict with names of fields on other tables in the query.

```php
$team = Team::get()->byId(1);
$team = Team::get()->byID(1);
$supporters = $team->Supporters()->filter(['Ranking' => 1]);
```

If the field names conflict, you can explicitly query the field from the join record using raw SQL. There are potential security concerns to consider with this approach. See [raw SQL](/developer_guides/model/data_model_and_orm/#raw-sql) for more information.

```php
use SilverStripe\ORM\DataObject;

$rankingColumn = DataObject::getSchema()->sqlColumnForField(TeamSupporter::class, 'Ranking');
$team = Team::get()->byID(1);
$supporters = $team->Supporters()->where([$rankingColumn => 1]);
```

> [!TIP]
> For records accessed in a [`ManyManyThroughList`](api:SilverStripe\ORM\ManyManyThroughList), you can access the join record (e.g. for our example above a `TeamSupporter` instance) by calling [`getJoin()`](api:SilverStripe\ORM\DataObject::getJoin()) or as the `$Join` property in templates.

Expand Down
Loading