Skip to content

Commit

Permalink
Merge pull request #130 from avo-hq/refactor/remove_attachments_eager…
Browse files Browse the repository at this point in the history
…_load

refactor: remove attachments eager load
  • Loading branch information
Paul-Bob authored Nov 9, 2023
2 parents 4cfe4d7 + 5661202 commit 1c5a8bc
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/3.0/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,38 @@ We'll update this page when we release new Avo 3 versions.

If you're looking for the Avo 2 to Avo 3 upgrade guide, please visit [the dedicated page](./avo-2-avo-3-upgrade).

## Upgrade from 3.0.1.beta24 to 3.0.1.beta25

:::option Attachments eager load

Attachments are no longer automatically eager loading. If you want to eager load attachments there are at least two ways:

### Use [`self.includes`](resources.html#self_includes) option

```ruby
class Avo::Resources::PhotoComment < Avo::BaseResource
self.includes = [:user, [photo_attachment: :blob]]

def fields
field :user, as: :belongs_to
field :photo, as: :file, is_image: true
end
```

### Use [`self.index_query`](customization.html#custom-scope-for-index-page) option
```ruby
class Avo::Resources::Product < Avo::BaseResource
self.index_query = -> {
query.includes image_attachment: :blob
}

def fields
field :image, as: :file, is_image: true
end
```

:::

## Upgrade from 3.0.1.beta23 to 3.0.1.beta24

:::option Cards
Expand Down

0 comments on commit 1c5a8bc

Please sign in to comment.