JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Performance on selecting all columns instead of specified attributes
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.3k
- Forks
- 546
- PR merge metrics
- No merged PRs in 30d
Description
Is there a reason the _model_class queries all columns?
This is a huge performance impact on models with many columns that may not ever be used by the resource.
It seems for performance reasons it makes sense to only select the attributes defined in the JSONAPI::Resource class.
A workaround for now is to override each resource using .select to retrieve only the fields that are specifically defined.
attributes :name, :address
def self.records(_options = {})
super.select(self.fields)
end
This should also take into account sparse fieldsets parameters, which would further limit which columns are selected.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in lib/jsonapi/active_relation_resource.rb at the linked _model_class query and trace how Resource attributes and sparse fieldsets are represented. The work is done when those queries select only the fields needed by the resource and request fieldset, while preserving the existing records behavior and covering the relevant query paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rails, ruby
- Domain
- backend-api-design, databases, performance
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 38/100