pg 0.18.1 → 1.5.6

data/History.rdoc

@@ -1,297 +0,0 @@
-== v0.18.1 [2015-01-05] Michael Granger <ged@FaerieMUD.org>
-
-Correct the minimum compatible Ruby version to 1.9.3. #199
-
-
-== v0.18.0 [2015-01-01] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-- Fix OID to Integer mapping (it is unsigned now). #187
-- Fix possible segfault in conjunction with notice receiver. #185
-
-Enhancements:
-
-- Add an extensible type cast system.
-- A lot of performance improvements.
-- Return frozen String objects for result field names.
-- Add PG::Result#stream_each and #stream_each_row as fast helpers for
-  the single row mode.
-- Add Enumerator variant to PG::Result#each and #each_row.
-- Add PG::Connection#conninfo and #hostaddr.
-- Add PG.init_openssl and PG.init_ssl methods.
-- Force zero termination for all text strings that are given to libpq.
-  It raises an ArgumentError if the string contains a null byte.
-- Update Windows cross build to PostgreSQL 9.3.
-
-
-
-== v0.17.1 [2013-12-18] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-
-- Fix compatibility with signal handlers defined in Ruby. This reverts
-  cancelation of queries running on top of the blocking libpq API (like
-  Connection#exec) in case of signals. As an alternative the #async_exec
-  can be used, which is reverted to use the non-blocking API, again.
-- Wrap PQcancel to be called without GVL. It internally waits for
-  the canceling connection.
-
-Documentation fixes:
-
-- Fix documentation for PG::Connection::conndefaults.
-
-
-== v0.17.0 [2013-09-15] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-
-- Fix crash by calling PQsend* and PQisBusy without GVL (#171).
-
-Enhancements:
-
-- Add method PG::Connection#copy_data.
-- Add a Gemfile to allow installation of dependencies with bundler.
-- Add compatibility with rake-compiler-dev-box.
-- Return self from PG::Result#check instead of nil. This allows
-  to stack method calls.
-
-
-== v0.16.0 [2013-07-22] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-
-- Avoid warnings about uninitialized instance variables.
-- Use a more standard method of adding library and include directories.
-  This fixes build on AIX (Github #7) and Solaris (#164).
-- Cancel the running query, if a thread is about to be killed (e.g. by CTRL-C).
-- Fix GVL issue with wait_for_notify/notifies and notice callbacks.
-- Set proper encoding on the string returned by quote_ident, escape_literal
-  and escape_identifier (#163).
-- Use nil as PG::Error#result in case of a NULL-result from libpq (#166).
-- Recalculate the timeout of conn#wait_for_notify and conn#block in case
-  of socket events that require re-runs of select().
-
-Documentation fixes:
-
-- Fix non working example for PGresult#error_field.
-
-Enhancements:
-
-- Add unique exception classes for each PostgreSQL error type (#5).
-- Return result of the block in conn#transaction instead of nil (#158).
-- Allow 'rake compile' and 'rake gem' on non mercurial repos.
-- Add support for PG_DIAG_*_NAME error fields of PostgreSQL-9.3 (#161).
-
-
-== v0.15.1 [2013-04-08] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-
-- Shorten application_name to avoid warnings about truncated identifier.
-
-
-== v0.15.0 [2013-03-03] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-
-- Fix segfault in PG::Result#field_values when called with non String value.
-- Fix encoding of messages delivered by notice callbacks.
-- Fix text encoding for Connection#wait_for_notify and Connection#notifies.
-- Fix 'Bad file descriptor' problems under Windows: wrong behaviour of
-  #wait_for_notify() and timeout handling of #block on Ruby 1.9.
-
-Documentation fixes:
-
-- conn#socket() can not be used with IO.for_fd() on Windows.
-
-Enhancements:
-
-- Tested under Ruby 2.0.0p0.
-- Add single row mode of PostgreSQL 9.2.
-- Set fallback_application_name to programm name $0. Thanks to Will Leinweber
-  for the patch.
-- Release Ruby's GVL while calls to blocking libpq functions to allow better
-  concurrency in threaded applications.
-- Refactor different variants of waiting for the connection socket.
-- Make use of rb_thread_fd_select() on Ruby 1.9 and avoid deprecated
-  rb_thread_select().
-- Add an example of how to insert array data using a prepared statement (#145).
-- Add continous integration tests on travis-ci.org.
-- Add PG::Result#each_row for iterative over result sets by row. Thanks to
-  Aaron Patterson for the patch.
-- Add a PG::Connection#socket_io method for fetching a (non-autoclosing) IO
-  object for the connection's socket.
-
-Specs:
-
-- Fix various specs to run on older PostgreSQL and Ruby versions.
-- Avoid fork() in specs to allow usage on Windows and JRuby.
-
-
-== v0.14.1 [2012-09-02] Michael Granger <ged@FaerieMUD.org>
-
-Important bugfix:
-
-- Fix stack overflow bug in PG::Result#values and #column_values (#135). Thanks
-  to everyone who reported the bug, and Lars Kanis especially for figuring out
-  the problem.
-
-PostgreSQL 9.2 beta fixes:
-
-- Recognize PGRES_SINGLE_TUPLE as OK when checking PGresult (Jeremy Evans)
-
-Documentation fixes:
-
-- Add note about the usage scope of the result object received by the
-  #set_notice_receiver block. (Lars Kanis)
-- Add PGRES_COPY_BOTH to documentation of PG::Result#result_status. (Lars Kanis)
-- Add some documentation to PG::Result#fnumber (fix for #139)
-
-
-== v0.14.0 [2012-06-17] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-  #47, #104
-
-
-New Methods for PostgreSQL 9 and async API support:
-PG
-- ::library_version
-
-PG::Connection
-- ::ping
-- #escape_literal
-- #escape_identifier
-- #set_default_encoding
-
-PG::Result
-- #check
-
-
-New Samples:
-
-This release also comes with a collection of contributed sample scripts for
-doing resource-utilization reports, graphing database statistics,
-monitoring for replication lag, shipping WAL files for replication,
-automated tablespace partitioning, etc. See the samples/ directory.
-
-
-== v0.13.2 [2012-02-22] Michael Granger <ged@FaerieMUD.org>
-
-- Make builds against PostgreSQL earlier than 8.3 fail with a descriptive
-  message instead of a compile failure.
-
-
-== v0.13.1 [2012-02-12] Michael Granger <ged@FaerieMUD.org>
-
-- Made use of a finished PG::Connection raise a PG::Error instead of
-  a fatal error (#110).
-- Added missing BSDL license file (#108)
-
-
-== v0.13.0 [2012-02-09] Michael Granger <ged@FaerieMUD.org>
-
-Reorganization of modules/classes to be better Ruby citizens (with backward-compatible aliases):
-- Created toplevel namespace 'PG' to correspond with the gem name.
-- Renamed PGconn to PG::Connection (with ::PGconn alias)
-- Renamed PGresult to PG::Result (with ::PGresult alias)
-- Renamed PGError to PG::Error (with ::PGError alias)
-- Declare all constants inside PG::Constants, then include them in
-  PG::Connection and PG::Result for backward-compatibility, and
-  in PG for convenience.
-- Split the extension source up by class/module.
-- Removed old compatibility code for PostgreSQL versions < 8.3
-
-Documentation:
-- Clarified licensing, updated to Ruby 1.9's license.
-- Merged authors list, added some missing people to the Contributor's
-  list.
-- Cleaned up the sample/ directory
-- Making contact info a bit clearer, link to the Google+ page and
-  the mailing list
-
-Enhancements:
-- Added a convenience method: PG.connect -> PG::Connection.new
-
-Bugfixes:
-- Fixed LATIN5-LATIN10 Postgres<->Ruby encoding conversions
-
-
-
-== v0.12.2 [2012-01-03] Michael Granger <ged@FaerieMUD.org>
-
-- Fix for the 1.8.7 breakage introduced by the st.h fix for alternative Ruby
-  implementations (#97 and #98). Thanks to Lars Kanis for the patch.
-- Encode error messages with the connection's encoding under 1.9 (#96)
-
-
-== v0.12.1 [2011-12-14] Michael Granger <ged@FaerieMUD.org>
-
-- Made rake-compiler a dev dependency, as Rubygems doesn't use the Rakefile
-  for compiling the extension. Thanks to eolamey@bitbucket and Jeremy Evans
-  for pointing this out.
-- Added an explicit include for ruby/st.h for implementations that need it
-  (fixes #95).
-
-
-== v0.12.0 [2011-12-07] Michael Granger <ged@FaerieMUD.org>
-
-- PGconn#wait_for_notify
-  * send nil as the payload argument if the NOTIFY didn't have one.
-  * accept a nil argument for no timeout (Sequel support)
-  * Fixed API docs
-  * Taint and encode event name and payload
-- Handle errors while rb_thread_select()ing in PGconn#block.
-  (Brian Weaver).
-- Fixes for Win32 async queries (Rafał Bigaj)
-- Memory leak fixed: Closing opened WSA event. (rafal)
-- Fixes for #66 Win32 asynchronous queries hang on connection
-  error. (rafal)
-- Fixed a typo in PGconn#error_message's documentation
-- fixing unused variable warnings for ruby 1.9.3 (Aaron Patterson)
-- Build system bugfixes
-- Converted to Hoe
-- Updates for the Win32 binary gem builds (Lars Kanis)
-
-
-== v0.11.0 [2011-02-09] Michael Granger <ged@FaerieMUD.org>
-
-Enhancements:
-
-* Added a PGresult#values method to fetch all result rows as an Array of
-  Arrays. Thanks to Jason Yanowitz (JYanowitz at enovafinancial dot com) for
-  the patch.
-
-
-== v0.10.1 [2011-01-19] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes:
-
-* Add an include guard for pg.h
-* Simplify the common case require of the ext
-* Include the extconf header
-* Fix compatibility with versions of PostgreSQL without PQgetCancel. (fixes #36)
-* Fix require for natively-compiled extension under Windows. (fixes #55)
-* Change rb_yield_splat() to rb_yield_values() for compatibility with Rubinius. (fixes #54)
-
-
-== v0.10.0 [2010-12-01] Michael Granger <ged@FaerieMUD.org>
-
-Enhancements:
-
-* Added support for the payload of NOTIFY events (w/Mahlon E. Smith)
-* Updated the build system with Rubygems suggestions from RubyConf 2010
-
-Bugfixes:
-
-* Fixed issue with PGconn#wait_for_notify that caused it to miss notifications that happened after
-  the LISTEN but before the wait_for_notify.
-
-== v0.9.0 [2010-02-28] Michael Granger <ged@FaerieMUD.org>
-
-Bugfixes.
-
-== v0.8.0 [2009-03-28] Jeff Davis <davis.jeffrey@gmail.com>
-
-Bugfixes, better Windows support.
-

data/README.ja.rdoc

@@ -1,14 +0,0 @@
-= pg
-
-home :: https://bitbucket.org/ged/ruby-pg
-mirror :: https://github.com/ged/ruby-pg
-docs :: http://deveiate.org/code/pg
-
-
-== Description
-
-This file needs a translation of the English README. Pull requests, patches, or
-volunteers gladly accepted.
-
-Until such time, please accept my sincere apologies for not knowing Japanese.
-

data/README.rdoc

@@ -1,161 +0,0 @@
-= pg
-
-home :: https://bitbucket.org/ged/ruby-pg
-mirror :: https://github.com/ged/ruby-pg
-docs :: http://deveiate.org/code/pg
-
-
-== Description
-
-Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/].
-
-It works with {PostgreSQL 8.4 and later}[http://www.postgresql.org/support/versioning/].
-
-A small example usage:
-
-  #!/usr/bin/env ruby
-
-  require 'pg'
-
-  # Output a table of current connections to the DB
-  conn = PG.connect( dbname: 'sales' )
-  conn.exec( "SELECT * FROM pg_stat_activity" ) do |result|
-    puts "     PID | User             | Query"
-  result.each do |row|
-      puts " %7d | %-16s | %s " %
-        row.values_at('procpid', 'usename', 'current_query')
-    end
-  end
-
-== Build Status
-
-{<img src="https://travis-ci.org/ged/ruby-pg.png?branch=master" alt="Build Status" />}[https://travis-ci.org/ged/ruby-pg]
-
-
-== Requirements
-
-* Ruby 1.9.3-p392, or 2.0.0-p0.
-* PostgreSQL 8.4.x or later (with headers, -dev packages, etc).
-
-It may work with earlier versions of Ruby/PostgreSQL as well, but those are
-not regularly tested.
-
-
-== How To Install
-
-Install via RubyGems:
-
-    gem install pg
-
-You may need to specify the path to the 'pg_config' program installed with
-Postgres:
-
-    gem install pg -- --with-pg-config=<path to pg_config>
-
-If you're installing via Bundler, you can provide compile hints like so:
-
-    bundle config build.pg --with-pg-config=<path to pg_config>
-
-See README-OS_X.rdoc for more information about installing under MacOS X, and
-README-Windows.rdoc for Windows build/installation instructions.
-
-There's also {a Google+ group}[http://goo.gl/TFy1U] and a
-{mailing list}[http://groups.google.com/group/ruby-pg] if you get stuck, or just
-want to chat about something.
-
-
-== Type Casts
-
-Pg can optionally type cast result values and query parameters in Ruby or
-native C code. This can speed up data transfers to and from the database,
-because String allocations are reduced and conversions in (slower) Ruby code
-can be omitted.
-
-Very basic type casting can be enabled by:
-
-    conn.type_map_for_results = PG::BasicTypeMapForResults.new conn
-    # ... this works for result value mapping:
-    conn.exec("select 1, now(), '{2,3}'::int[]").values
-        # => [[1, 2014-09-21 20:51:56 +0200, [2, 3]]]
-
-    conn.type_map_for_queries = PG::BasicTypeMapForQueries.new conn
-    # ... and this for param value mapping:
-    conn.exec_params("SELECT $1::text, $2::text, $3::text", [1, 1.23, [2,3]]).values
-        # => [["1", "1.2300000000000000E+00", "{2,3}"]]
-
-But Pg's type casting is highly customizable. That's why it's divided into
-2 layers:
-
-=== Encoders / Decoders (ext/pg_*coder.c, lib/pg/*coder.rb)
-
-This is the lower layer, containing encoding classes that convert Ruby
-objects for transmission to the DBMS and decoding classes to convert
-received data back to Ruby objects. The classes are namespaced according
-to their format and direction in PG::TextEncoder, PG::TextDecoder,
-PG::BinaryEncoder and PG::BinaryDecoder.
-
-It is possible to assign a type OID, format code (text or binary) and
-optionally a name to an encoder or decoder object. It's also possible
-to build composite types by assigning an element encoder/decoder.
-PG::Coder objects can be used to set up a PG::TypeMap or alternatively
-to convert single values to/from their string representation.
-
-=== PG::TypeMap and derivations (ext/pg_type_map*.c, lib/pg/type_map*.rb)
-
-A TypeMap defines which value will be converted by which encoder/decoder.
-There are different type map strategies, implemented by several derivations
-of this class. They can be chosen and configured according to the particular
-needs for type casting. The default type map is PG::TypeMapAllStrings.
-
-A type map can be assigned per connection or per query respectively per
-result set. Type maps can also be used for COPY in and out data streaming.
-
-
-== Contributing
-
-To report bugs, suggest features, or check out the source with Mercurial,
-{check out the project page}[http://bitbucket.org/ged/ruby-pg]. If you prefer
-Git, there's also a {Github mirror}[https://github.com/ged/ruby-pg].
-
-After checking out the source, run:
-
-    $ rake newb
-
-This task will install any missing dependencies, run the tests/specs, and
-generate the API documentation.
-
-The current maintainers are Michael Granger <ged@FaerieMUD.org> and
-Lars Kanis <lars@greiz-reinsdorf.de>.
-
-
-== Copying
-
-Copyright (c) 1997-2013 by the authors.
-
-* Jeff Davis <ruby-pg@j-davis.com>
-* Guy Decoux (ts) <decoux@moulon.inra.fr>
-* Michael Granger <ged@FaerieMUD.org>
-* Lars Kanis <lars@greiz-reinsdorf.de>
-* Dave Lee
-* Eiji Matsumoto <usagi@ruby.club.or.jp>
-* Yukihiro Matsumoto <matz@ruby-lang.org>
-* Noboru Saitou <noborus@netlab.jp>
-
-You may redistribute this software under the same terms as Ruby itself; see
-http://www.ruby-lang.org/en/LICENSE.txt or the LICENSE file in the source
-for details.
-
-Portions of the code are from the PostgreSQL project, and are distributed
-under the terms of the PostgreSQL license, included in the file POSTGRES.
-
-Portions copyright LAIKA, Inc.
-
-
-== Acknowledgments
-
-See Contributors.rdoc for the many additional fine people that have contributed
-to this library over the years.
-
-We are thankful to the people at the ruby-list and ruby-dev mailing lists.
-And to the people who developed PostgreSQL.
-