A PostgreSQL interface to the Ruby gem 'adapter' using HSTORE data tye to store data like a Ruby hash.
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
lib
spec
.document
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.rdoc
Rakefile
VERSION
adapter-postgres.gemspec

README.rdoc

adapter-postgres

DESCRIPTION:

Postgres adapter for adapter gem. Uses the HSTORE data type. See adapter for more info on why you would want to do this – github.com/newtoy/adapter

FEATURES/PROBLEMS:

This relies on the HSTORE data type in PostgreSQL. It will not work in MySQL, and HSTORE is as of this writing delegated to the 'contribs' package of PostgreSQL, not the core package. See your platform directions for installing 'contribs'.

Also note that implementation of HSTORE in v8.4 and v9+ are very different and probably exhibit very different performance profiles.

SYNOPSIS:

require 'adapter/postgres'

client = PGconn.connect("host=localhost port=5432 dbname=test user=#{user} password=#{pword}")

or

client = ActiveRecord::Base.connection.instance_variable_get("@connection")

adapter = Adapter[:postgres].new(client)
adapter['foo'] = 'bar'

etc…

See examples/ or specs/ for more examples.

REQUIREMENTS:

PostgreSQL 8.4+ and PostgreSQL-contribs pg or some other Ruby gem that provides a PGconn style connection to the database.

INSTALL:

gem install adapter-postgres

You need to add the HSTORE data type to your database from contribs. If your contribs is installed into /usl/share/pgsql/contrib, then as the user 'postgres' you might run:

psql database_name < /usr/share/pgsql/contrib/hstore.sql

This will give the database 'database_name' access to the HSTORE data type that the gem relies on. There is a copy of 'hstore.sql' from PostgreSQL8.4 included in the 'examples' directory of this gem for convenience.

Next, you need to create the table and one row for the data to be saved to. You will want to create some kind of migration depending what kind of app you are working in that runs the following SQL only once inside the database:

CREATE TABLE generic_hstore_table (data hstore);
INSERT INTO generic_hstore_table VALUES (''::hstore);

Now you can begin using the adapter. See the SYNOPSIS above.

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so we don't break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine, but bump version in a commit by itself so we can ignore when we pull)

  • Send us a pull request. Bonus points for topic branches.