https://github.com/knu/postgresql-plruby

PL/Ruby procedural language for the PostgreSQL database system by Guy Decoux
https://github.com/knu/postgresql-plruby

Last synced: 8 months ago
JSON representation

PL/Ruby procedural language for the PostgreSQL database system by Guy Decoux

• Host: GitHub
• URL: https://github.com/knu/postgresql-plruby
• Owner: knu
• Created: 2009-05-13T06:35:52.000Z (about 17 years ago)
• Default Branch: master
• Last Pushed: 2017-07-04T15:00:53.000Z (almost 9 years ago)
• Last Synced: 2025-05-20T13:08:35.838Z (about 1 year ago)
• Language: C
• Homepage: http://rubyforge.org/projects/plruby/
• Size: 627 KB
• Stars: 114
• Watchers: 8
• Forks: 38
• Open Issues: 10
• Metadata Files:
  • Readme: README.markdown
  • Changelog: Changes

Awesome Lists containing this project

README

          
PL/ruby

=======

  PL/Ruby is a loadable procedural language for the PostgreSQL database

  system that enables the Ruby language to create functions and trigger

  procedures.

Prerequisite

------------

> * ruby 1.8.7 or later (maybe 1.8.6 too)

> * postgresql >= 7.3

  All PostgreSQL headers need to be installed. Command (see `INSTALL` in the

  directory postgresql-7.x.y)

        make install-all-headers

Installation

------------

        ruby extconf.rb

        make

        make install

  You may need to specify some of the following extconf.rb options:

        --with-pg-config=

  Specifies the location of pg_config.

  e.g. --with-pg-config=/usr/local/bin/pg_config

        --with-greenplum

  Builds plruby for Greenplum instead of PostgreSQL.

        --disable-conversion

  By default plruby tries to convert a postgres type to a ruby class.

  This option gives the possibility to disable all conversions.

       --with-suffix=

  Specifies a suffix to add to the extension module file.

  e.g. `ruby extconf.rb --with-suffix=_geo` will create

  `plruby_geo.so`.

        --with-safe-level

  Lowers the safe level which the plruby functions are run under.

  (default: 12; meaning the maximum)

        --with-timeout=

  Sets the timeout for each function call. (default: none)

        --with-main-safe-level

  Lowers the safe level which the main thread waiting for timeouts is

  run under. (default: 3) This option is read only when --with-timeout

  is given.

Test (and examples)

-------------------

  WARNING: if plruby was compiled without --disable-conversion you

  must **FIRST** run `make install` before `make test`.

        make test

  This will run the following two commands:

        ( cd test/plt; ./runtest )

        ( cd test/plp; ./runtest )

  The database `plruby_test` is created and then destroyed.  Don't use

  it if you have such a database.

  Now you are ready to create the PL/Ruby language in PostgreSQL.

  Since the `pg_language` system catalog is private to each database,

  the new language can be created only for individual databases, or in

  the template1 database.  In the latter case, it is automatically

  available in all newly created databases.

  The commands to create the new language are:

        create function plruby_call_handler () returns language_handler

        as 'path-to-plruby-shared-lib'

        language 'C';

        create trusted language 'plruby'

        handler plruby_call_handler

        lancompiler 'PL/Ruby';

  The `trusted` keyword on `create language` tells PostgreSQL,

  that all users (not only those with superuser privilege) are

  permitted to create functions with `LANGUAGE 'plruby'`. This is

  absolutely safe, because there is nothing a normal user can do

  with PL/Ruby, to get around access restrictions he/she has.

Documentation

-------------

  see `plruby.rd` and `plruby.html`

Development

-----------

  New releases and sources can be obtained from 

Copying

-------

  This extension module is copyrighted free software by Guy Decoux.

  You can redistribute it and/or modify it under the same term as Ruby.

* * *

Guy Decoux  (original author, deceased in July 2008)

Akinori MUSHA  (current maintainer)