Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/planetscale/planetscale-ruby
Ruby client for PlanetScale databases
https://github.com/planetscale/planetscale-ruby
Last synced: 3 months ago
JSON representation
Ruby client for PlanetScale databases
- Host: GitHub
- URL: https://github.com/planetscale/planetscale-ruby
- Owner: planetscale
- License: apache-2.0
- Archived: true
- Created: 2021-02-03T00:28:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-16T19:19:36.000Z (almost 2 years ago)
- Last Synced: 2024-07-04T21:30:37.539Z (4 months ago)
- Language: Ruby
- Homepage:
- Size: 81.7 MB
- Stars: 30
- Watchers: 11
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PlanetScale Ruby Client
[](https://rubygems.org/gems/planetscale)
⚠️ This Gem is not currently maintained. If you're looking to connect to PlanetScale with a Rails application, follow our [Rails guide](https://docs.planetscale.com/tutorials/connect-rails-app) which uses [Connection strings](https://docs.planetscale.com/concepts/connection-strings). ⚠️
This Gem provides an easy to use client for connecting your Ruby application to PlanetScale. It handles setting up a local proxy that allows you to connect to any PlanetScale database and branch without reconfiguration, so that you can easily swap and choose using only environment variables.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'planetscale'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install planetscale
## Usage
This Gem exposes one class, and a singleton of that for configuring a 'global' instance of the proxy. This is recommended for most users who do not need to connect to multiple databases simultaneously. There are many ways to configure the connection, for local development we recommend:
The Gem will pick up configuration created by the CLI, to point it to your database run this in the root of your Rails project:
```
~> pscale branch switch main --database
Finding branch main on database
Successfully switched to branch main on database
```
Now, run the built-in generator to setup the basic configuration: `rails generate planetscale:install`
Finally, point your `database.yml` at the proxy the Gem will start, which will listen on `127.0.0.1:3305`. This will look something like:
```yaml
development:
<<: *default
username: root
host: 127.0.0.1
port: 3305
database:
```
Now, your Rails app will boot the proxy as the app is starting, and connect to the `main` branch on your DB.
### Service Token Authentication
To use this Gem in 'production', we'll start by creating a PlanetScale Service Token that can connect to your database. To do this, grab the `pscale` CLI and do:
```
~> pscale org switch
~> pscale service-token create
NAME TOKEN
-------------- ------------------------------------------
0sph6kvz5bxi
~> pscale service-token add-access 0sph6kvz5bxi connect_production_branch --database
DATABASE ACCESSES
---------- ---------------------------
testdb connect_production_branch
```
To configure your application in production, you'll need to feed it all of the right information via environment variables:
```
PLANETSCALE_ORG=
PLANETSCALE_DB=
PLANETSCALE_DB_BRANCH=main
PLANETSCALE_TOKEN_NAME=0sph6kvz5bxi
PLANETSCALE_TOKEN=
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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.
## License
This gem is licensed under the [Apache License Version 2.0](LICENSE).