Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evilmartians/graphql-connections
Additional implementations of cursor-based paginations for GraphQL Ruby gem.
https://github.com/evilmartians/graphql-connections
activerecord chewy gem graphql ruby
Last synced: 4 months ago
JSON representation
Additional implementations of cursor-based paginations for GraphQL Ruby gem.
- Host: GitHub
- URL: https://github.com/evilmartians/graphql-connections
- Owner: evilmartians
- License: mit
- Created: 2020-07-04T19:42:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-07T19:51:36.000Z (about 1 year ago)
- Last Synced: 2024-09-29T12:03:49.366Z (4 months ago)
- Topics: activerecord, chewy, gem, graphql, ruby
- Language: Ruby
- Homepage:
- Size: 47.9 KB
- Stars: 45
- Watchers: 21
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/graphql-connections)
[](https://travis-ci.org/bibendi/graphql-connections)
# GraphQL::Connections
Additional implementations of cursor-based paginations for [GraphQL Ruby](https://graphql-ruby.org/).
## Installation
Add this line to your application's Gemfile:
```ruby
gem "graphql-connections"
```
## Usage
### ActiveRecord
Implements [Relay specification](https://relay.dev/graphql/connections.htm) for serving stable connections based on column values.
If objects are created or destroyed during pagination, the list of items won’t be disrupted.
You can use a stable connection wrapper on a specific field:
```ruby
field :messages, Types::Message.connection_type, null: false
def messages
GraphQL::Connections::Stable.new(Message.all)
end
```
Records are sorted by model's primary key by default. You can change this behaviour by providing `primary_key` param:
```ruby
GraphQL::Connections::Stable.new(Message.all, primary_key: :created_at)
```
In case when you want records to be sorted by more than one field (i.e., _keyset pagination_), you can use `keys` param:
```ruby
GraphQL::Connections::Stable.new(Message.all, keys: %w[name id])
```
When you pass only one key, a primary key will be added as a second one:
```ruby
GraphQL::Connections::Stable.new(Message.all, keys: [:name])
```
**NOTE:** Currently we support maximum two keys in the keyset.
Also, you can pass the `:desc` option to reverse the relation:
```ruby
GraphQL::Connections::Stable.new(Message.all, keys: %w[name id], desc: true)
```
```ruby
GraphQL::Connections::Stable.new(Message.all, primary_key: :created_at, desc: true)
```
Also, you can disable opaque cursors by setting `opaque_cursor` param:
```ruby
GraphQL::Connections::Stable.new(Message.all, opaque_cursor: false)
```
Or you can apply a stable connection to all Active Record relations returning by any field:
```ruby
class ApplicationSchema < GraphQL::Schema
connections.add(ActiveRecord::Relation, GraphQL::Connections::Stable)
end
```
**NOTE:** Don't use stable connections for relations whose ordering is too complicated for cursor generation.
### Elasticsearch via Chewy
Register connection for all Chewy requests:
```ruby
class ApplicationSchema < GraphQL::Schema
connections.add(Chewy::Search::Request, GraphQL::Connections::ChewyConnection)
end
```
And define field like below:
```ruby
field :messages, Types::Message.connection_type, null: false
def messages
CitiesIndex.query(match: {name: "Moscow"})
end
```
**NOTE:** Using `first` and `last`arguments simultaneously is not supported yet.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bibendi/graphql-connections.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).