Provides a DSL for the graphql
gem that allows ActiveRecord associations to be preloaded in field definitions. Based on a gist by @theorygeek.
Add this line to your application's Gemfile:
gem 'graphql-preload'
And then execute:
$ bundle
Or install it yourself as:
$ gem install graphql-preload
First, enable preloading in your GraphQL::Schema
:
Schema = GraphQL::Schema.define do
use GraphQL::Batch
enable_preloading
end
Call preload
when defining your field:
PostType = GraphQL::ObjectType.define do
name 'Post'
field :comments, !types[!CommentType] do
# Post.includes(:comments)
preload :comments
# Post.includes(:comments, :authors)
preload [:comments, :authors]
# Post.includes(:comments, authors: [:followers, :posts])
preload [:comments, { authors: [:followers, :posts] }]
resolve ->(obj, args, ctx) { obj.comments }
end
end
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/ConsultingMD/graphql-preload.
The gem is available as open source under the terms of the MIT License.