Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/delonnewman/activerecord-pull
A simple query interface for pulling deeply nested data from records.
https://github.com/delonnewman/activerecord-pull
activerecord activerecord-queries database declarative-programming eav-model graph nested-objects nested-structures object-oriented-programming ontology query querying relational relational-database relational-databases ruby ruby-on-rails sql-databases tree trees
Last synced: 3 days ago
JSON representation
A simple query interface for pulling deeply nested data from records.
- Host: GitHub
- URL: https://github.com/delonnewman/activerecord-pull
- Owner: delonnewman
- License: mit
- Created: 2020-02-21T22:20:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T18:56:54.000Z (2 months ago)
- Last Synced: 2024-10-11T23:19:42.720Z (25 days ago)
- Topics: activerecord, activerecord-queries, database, declarative-programming, eav-model, graph, nested-objects, nested-structures, object-oriented-programming, ontology, query, querying, relational, relational-database, relational-databases, ruby, ruby-on-rails, sql-databases, tree, trees
- Language: Ruby
- Homepage:
- Size: 32.2 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://github.com/delonnewman/activerecord-pull/actions/workflows/ruby.yml)
# ActiveRecord::Pull::Alpha
A simple query interface for pulling deeply nested data from records.
## Synopsis
```ruby
class Survey < ActiveRecord::Base
has_many :questions
has_many :responses
end
class Question < ActiveRecord::Base
has_many :answers
end
class Answer < ActiveRecord::Base
belongs_to :reply
belongs_to :question
end
class Response < ActiveRecord::Base
belongs_to :survey
has_many :answers
end
Survey.find(34).pull(:name, questions: [:text, answers: [:created_at]])
Response.where('created_at < ?', Date.new(2018, 7, 5)).pull({ survey: :name }, { answers: :value })
```
## Why?
When using an SQL database modeling [trees][tree] and [ontologies][ontology] is an exercise in relational database design.
Unfortunately, when dealing with deeply nested and *overlapping* data (e.g. medical records and social graphs)
trees and ontologies won't do. We need to model graphs, a much more sparsely structured data model, but
this leads to very complex (or sparse) table structures and very complex SQL queries.
Alternatives to SQL databases like [Datomic][datomic], [RDF][rdf] and graph databases resolve this problem in the general case,
but sometimes those solutions are not a viable option for one reason or another. This gem attempts to provide some of the
convenience of these solutions as an extension to ActiveRecord. As a bonus it makes querying trees and ontologies simple too!
## Pull Syntax
The pull syntax is inspired by the pull syntax that is used in [Datomic][datomic-pull].
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'activerecord-pull-alpha'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install activerecord-pull-alpha
## See Also
- [Ancestry](https://github.com/stefankroes/ancestry)
- [Graphiti](https://www.graphiti.dev/)
- [Datomic][datomic]
- [GraphQL](https://graphql.org/)
- [Entity Attribute Value Model][eav-model]
- [RDF][rdf]
- [A City is Not a Tree](https://www.patternlanguage.com/archive/cityisnotatree.html)
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
[datomic]: https://www.datomic.com/
[datomic-pull]: https://docs.datomic.com/on-prem/pull.html#pull-grammar
[eav-model]: https://en.wikipedia.org/wiki/Entity%E2%80%93attribute%E2%80%93value_model
[rdf]: https://en.wikipedia.org/wiki/Resource_Description_Framework
[tree]: https://en.wikipedia.org/wiki/Tree_(data_structure)
[graph]: https://en.wikipedia.org/wiki/Graph_(abstract_data_type)
[ontology]: https://en.wikipedia.org/wiki/Ontology_(information_science)