Skip to content

Commit 63289d9

Browse files
author
Carlos Silva
committed
Update README
1 parent 306eeaf commit 63289d9

File tree

2 files changed

+32
-11
lines changed

2 files changed

+32
-11
lines changed

README.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# Torque PostgreSQL
33

4-
[![CircleCI](https://circleci.com/gh/crashtech/torque-postgresql/tree/master.svg?style=svg)](https://circleci.com/gh/crashtech/torque-postgresql/tree/master)
4+
[![CircleCI](https://circleci.com/gh/crashtech/torque-postgresql/tree/master_v2.svg?style=svg)](https://circleci.com/gh/crashtech/torque-postgresql/tree/master_v2)
55
[![Code Climate](https://codeclimate.com/github/crashtech/torque-postgresql/badges/gpa.svg)](https://codeclimate.com/github/crashtech/torque-postgresql)
66
[![Gem Version](https://badge.fury.io/rb/torque-postgresql.svg)](https://badge.fury.io/rb/torque-postgresql)
77
<!--([![Test Coverage](https://codeclimate.com/github/crashtech/torque-postgresql/badges/coverage.svg)](https://codeclimate.com/github/crashtech/torque-postgresql/coverage))-->
@@ -12,15 +12,14 @@
1212
* [TODO](https://github.com/crashtech/torque-postgresql/wiki/TODO)
1313

1414
# Description
15-
`torque-postgresql` is a plugin that enhances Ruby on Rails enabling easy access to existing PostgreSQL advanced resources, such as data types and queries statements. Its features are designed to be as similar to Rails architecture and they work as smoothly as possible.
15+
`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.
1616

17-
100% plug-and-play, with optional configurations, so that can be adapted to your project's design pattern.
17+
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.
1818

1919
# Installation
2020

2121
To install torque-postgresql you need to add the following to your Gemfile:
2222
```ruby
23-
gem 'torque-postgresql', '~> 1.1' # For Rails < 6.0
2423
gem 'torque-postgresql', '~> 2.0' # For Rails >= 6.0 < 6.1
2524
gem 'torque-postgresql', '~> 2.0.4' # For Rails >= 6.1
2625
gem 'torque-postgresql', '~> 3.0' # For Rails >= 7.0
@@ -43,27 +42,32 @@ These are the currently available features:
4342

4443
* [Configuring](https://github.com/crashtech/torque-postgresql/wiki/Configuring)
4544

45+
## Core Extensions
46+
47+
* [~~Range~~](https://github.com/crashtech/torque-postgresql/wiki/Range) (DEPRECATED)
48+
4649
## Data types
4750

51+
* [Box](https://github.com/crashtech/torque-postgresql/wiki/Box)
52+
* [Circle](https://github.com/crashtech/torque-postgresql/wiki/Circle)
53+
* [Date/Time Range](https://github.com/crashtech/torque-postgresql/wiki/Date-Time-Range)
4854
* [Enum](https://github.com/crashtech/torque-postgresql/wiki/Enum)
4955
* [EnumSet](https://github.com/crashtech/torque-postgresql/wiki/Enum-Set)
5056
* [Interval](https://github.com/crashtech/torque-postgresql/wiki/Interval)
51-
* [Date/Time Range](https://github.com/crashtech/torque-postgresql/wiki/Date-Time-Range)
52-
* [Box](https://github.com/crashtech/torque-postgresql/wiki/Box)
53-
* [Circle](https://github.com/crashtech/torque-postgresql/wiki/Circle)
5457
* [Line](https://github.com/crashtech/torque-postgresql/wiki/Line)
5558
* [Segment](https://github.com/crashtech/torque-postgresql/wiki/Segment)
5659

5760
## Querying
5861

5962
* [Arel](https://github.com/crashtech/torque-postgresql/wiki/Arel)
60-
* [Has Many](https://github.com/crashtech/torque-postgresql/wiki/Has-Many)
63+
* [Auxiliary Statements](https://github.com/crashtech/torque-postgresql/wiki/Auxiliary-Statements)
6164
* [Belongs to Many](https://github.com/crashtech/torque-postgresql/wiki/Belongs-to-Many)
62-
* [Dynamic Attributes](https://github.com/crashtech/torque-postgresql/wiki/Dynamic-Attributes)
6365
* [Distinct On](https://github.com/crashtech/torque-postgresql/wiki/Distinct-On)
64-
* [Insert All](https://github.com/crashtech/torque-postgresql/wiki/Insert-All)
65-
* [Auxiliary Statements](https://github.com/crashtech/torque-postgresql/wiki/Auxiliary-Statements)
66+
* [Dynamic Attributes](https://github.com/crashtech/torque-postgresql/wiki/Dynamic-Attributes)
67+
* [Has Many](https://github.com/crashtech/torque-postgresql/wiki/Has-Many)
6668
* [Inherited Tables](https://github.com/crashtech/torque-postgresql/wiki/Inherited-Tables)
69+
* [Insert All](https://github.com/crashtech/torque-postgresql/wiki/Insert-All)
70+
* [Multiple Schemas](https://github.com/crashtech/torque-postgresql/wiki/Multiple-Schemas)
6771

6872
# How to Contribute
6973

README.rdoc

+17
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,23 @@ reconfigured on the model, and then can be used during querying process.
128128

129129
{Learn more}[link:classes/Torque/PostgreSQL/AuxiliaryStatement.html]
130130

131+
* Multiple Schemas
132+
133+
Allows models and modules to have a schema associated with them, so that
134+
developers can better organize their tables into schemas and build features in
135+
a way that the database can better represent how they are separated.
136+
137+
create_schema "internal", force: :cascade
138+
139+
module Internal
140+
class User < ActiveRecord::Base
141+
self.schema = 'internal'
142+
end
143+
end
144+
145+
Internal::User.all
146+
147+
{Learn more}[link:classes/Torque/PostgreSQL/Adapter/DatabaseStatements.html]
131148

132149
== Download and installation
133150

0 commit comments

Comments
 (0)