crashtech/torque-postgresql

README

Torque PostgreSQL - Advanced PG features in a seamlessly RoR interface

Description

torque-postgresql is a plugin that enhances Ruby on Rails enabling easy access to existing PostgreSQL advanced resources, such as data types and query statements. Its features are designed to be similar to Rails architecture and work as smoothly as possible.

Fully compatible with schema.rb and 100% plug-and-play, with optional configurations, so that it can be adapted to your project's design pattern.

Installation

To install torque-postgresql you need to add the following to your Gemfile:

gem 'torque-postgresql', '~> 2.0'   # For Rails >= 6.0 < 6.1
gem 'torque-postgresql', '~> 2.0.4' # For Rails >= 6.1
gem 'torque-postgresql', '~> 3.0'   # For Rails >= 7.0 < 7.1
gem 'torque-postgresql', '~> 3.3'   # For Rails >= 7.1 < 7.2
gem 'torque-postgresql', '~> 3.4'   # For Rails >= 7.2 < 8.0
gem 'torque-postgresql', '~> 4.0'   # For Rails >= 8.0 < 8.1
gem 'torque-postgresql', '~> 4.1'   # For Rails >= 8.1

Also, run:

$ bundle

Or, for non-Gemfile related usage, simply:

gem install torque-postgresql

Usage

These are the currently available features:

Configuring

Data types

Querying

Experimental

How to Contribute

To start, simply fork the project, create a .env file following this example:

DATABASE_URL="postgres://USER:PASSWORD@localhost/DATABASE"

Run local tests using:

$ bundle install
$ bundle exec rake spec

Finally, fix and send a pull request.

License