Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supabase-community/postgrest-rb
Isomorphic Ruby client for PostgREST.
https://github.com/supabase-community/postgrest-rb
postgrest ruby supabase
Last synced: 3 months ago
JSON representation
Isomorphic Ruby client for PostgREST.
- Host: GitHub
- URL: https://github.com/supabase-community/postgrest-rb
- Owner: supabase-community
- License: mit
- Created: 2021-05-01T15:01:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T23:47:41.000Z (6 months ago)
- Last Synced: 2024-11-05T04:28:29.489Z (3 months ago)
- Topics: postgrest, ruby, supabase
- Language: Ruby
- Homepage:
- Size: 56.6 KB
- Stars: 37
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PostgREST
## Status
[](https://travis-ci.com/marcelobarreto/postgrest-rb)
[](https://badge.fury.io/rb/postgrest)
[](https://codeclimate.com/github/marcelobarreto/postgrest-rb)
[](https://codeclimate.com/github/marcelobarreto/postgrest-rb)
[](https://github.com/rubocop/rubocop)
[](https://rubygems.org/gems/postgrest)
Ruby client for [PostgREST](https://postgrest.org/)
This gem is under development, any help are welcome :muscle:
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'postgrest'
```
And then execute:
`$ bundle install`
Or install it yourself as:
`$ gem install postgrest`
## Usage
### Configuration
```ruby
db = Postgrest::Client.new(url: url, headers: headers, schema: schema)
```
### Selecting
```ruby
# Basic select
db.from('todos').select('*').execute
# or just db.from('todos').select
#1, "title"=>"foo", "completed"=>false}, {"id"=>2, "title"=>"foo", "completed"=>false}]>
# Selecting just one or more fields
db.from('todos').select(:title).execute
#"foo"}, {"title"=>"foo"}]>
```
#### Renaming a column name
You have the ability to alias the name of the column you want doing as follows:
```ruby
db.from('todos').select('name:title').eq(id: 112).execute
#"Go to the gym"}]>
```
### Querying
```ruby
db.from('todos').select('*').eq(id: 100).execute
# 100, "title"=>"foo", "completed" => true}}]>
db.from('todos').select('*').neq(id: 100).execute
# 101, "title"=>"foo", "completed" => true}}]>
```
### Ordering
TODO
### Relationships
TODO
### Full query example
```ruby
db.from('todos').select(:id, :title).owners(:name, as: :owner).workers(:name, as: :worker).in(id: [112, 113]).order(id: :asc).execute
#112, "title"=>"Eat something", "owner"=>{"name"=>"Marcelo"}, "worker"=>{"name"=>"Marcelo"}}, {"id"=>113, "title"=>"Go to the gym", "owner"=>{"name"=>"Marcelo"}, "worker"=>nil}]>
```
### Inserting
```ruby
db.from('todos').insert(title: 'Go to the gym', completed: false).execute
#1, "title"=>"Go to the gym", "completed"=>false}]>
db.from('todos').upsert(id: 1, title: 'Ok, I wont go to the gym', completed: true).execute
#1, "title"=>"Ok, I wont go to the gym", "completed"=>true}]>
# Inserting multiple rows at once
db.from('todos').insert([
{ title: 'Go to the gym', completed: false },
{ title: 'Walk in the park', completed: true },
]).execute
#110, "title"=>"Go to the gym", "completed"=>false}, {"id"=>111, "title"=>"Walk in the park", "completed"=>true}]>
```
### Updating
```ruby
# Query before update
db.from('todos').update(title: 'foobar').eq(id: 109).execute
#106, "title"=>"foo", "completed"=>false}]>
# Update all rows
db.from('todos').update(title: 'foobar').execute
#107, "title"=>"foobar", "completed"=>false}, {"id"=>1, "title"=>"foobar", "completed"=>true}, {"id"=>110, "title"=>"foobar", "completed"=>false}, {"id"=>111, "title"=>"foobar", "completed"=>true}, {"id"=>106, "title"=>"foobar", "completed"=>false}]>
```
### Deleting
```ruby
# Querying before delete
db.from('todos').delete.eq(id: 109).execute
#109, "title"=>"Go to the gym", "completed"=>false}]>
# OR deleting everything
db.from('todos').delete.execute
#110, "title"=>"Go to the gym", "completed"=>false}, {"id"=>111, "title"=>"Go to the gym", "completed"=>false}]>
```
## 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/marcelobarreto/postgrest.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).