pg 0.21.0 → 1.3.2

data/History.rdoc

@@ -1,3 +1,287 @@
+== v1.3.2 [2022-02-14] Lars Kanis <lars@greiz-reinsdorf.de>
+
+Bugfixes:
+
+- Cancel only active query after failing transaction. #430
+  This avoids an incompatibility with pgbouncer since pg-1.3.0.
+- Fix String objects with non-applied encoding when using COPY or record decoders. #427
+- Update Windows fat binary gem to PostgreSQL-14.2.
+
+Enhancements:
+
+- Improve extconf.rb checks to reduces the number of compiler calls.
+- Add a check for PGRES_PIPELINE_SYNC, to make sure the library version and the header files are PostgreSQL-14+. #429
+
+
+== v1.3.1 [2022-02-01] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Fix wrong handling of socket writability on Windows introduced in #417.
+  This caused starvation in conn.put_copy_data.
+- Fix error in PG.version_string(true). #419
+- Fix a regression in pg 1.3.0 where Ruby 2.x busy-looping any fractional seconds for every wait. #420
+
+Enhancements:
+
+- Raise an error when conn.copy_data is used in nonblocking mode.
+
+
+== v1.3.0 [2022-01-20] Michael Granger <ged@FaerieMUD.org>
+
+Install Enhancements:
+- Print some install help if libpq wasn't found. #396
+  This should help to pick the necessary package without googling.
+- Update Windows fat binary gem to OpenSSL-1.1.1m and PostgreSQL-14.1.
+- Add binary Windows gems for Ruby 3.0 and 3.1.
+- Make the library path of libpq available in ruby as PG::POSTGRESQL_LIB_PATH and add it to the search paths on Windows similar to +rpath+ on Unix systems. #373
+- Fall back to pkg-config if pg_config is not found. #380
+- Add option to extconf.rb to disable nogvl-wrapping of libpq functions.
+  All methods (except PG::Connection.ping) are nonblocking now, so that GVL unlock is in theory no longer necessary.
+  However it can have some advantage in concurrency, so that GVL unlock is still enabled by default.
+  Use:
+  - gem inst pg -- --disable-gvl-unlock
+
+API Enhancements:
+- Add full compatibility to Fiber.scheduler introduced in Ruby-3.0. #397
+  - Add async_connect and async_send methods and add specific specs for Fiber.scheduler #342
+  - Add async_get_result and async_get_last_result
+  - Add async_get_copy_data
+  - Implement async_put_copy_data/async_put_copy_end
+  - Implement async_reset method using the nonblocking libpq API
+  - Add async_set_client_encoding which is compatible to scheduler
+  - Add async_cancel as a nonblocking version of conn#cancel
+  - Add async_encrypt_password
+  - Run Connection.ping in a second thread.
+  - Make discard_results scheduler friendly
+  - Do all socket waiting through the conn.socket_io object.
+  - Avoid PG.connect blocking while address resolution by automatically providing the +hostaddr+ parameter.
+  - On Windows Fiber.scheduler support requires Ruby-3.1+.
+    It is also only partly usable since may ruby IO methods are not yet scheduler aware on Windows.
+- Add support for pipeline mode of PostgreSQL-14. #401
+- Allow specification of multiple hosts in PostgreSQL URI. #387
+- Add new method conn.backend_key - used to implement our own cancel method.
+
+Type cast enhancements:
+- Add PG::BasicTypeMapForQueries::BinaryData for encoding of bytea columns. #348
+- Reduce time to build coder maps and permit to reuse them for several type maps per PG::BasicTypeRegistry::CoderMapsBundle.new(conn) . #376
+- Make BasicTypeRegistry a class and use a global default instance of it.
+  Now a local type registry can be instanciated and given to the type map, to avoid changing shared global states.
+- Allow PG::BasicTypeMapForQueries to take a Proc as callback for undefined types.
+
+Other Enhancements:
+- Convert all PG classes implemented in C to TypedData objects. #349
+- Support ObjectSpace.memsize_of(obj) on all classes implemented in C. #393
+- Make all PG objects implemented in C memory moveable and therefore GC.compact friendly. #349
+- Update errorcodes and error classes to PostgreSQL-14.0.
+- Add PG::CONNECTION_* constants for conn.status of newer PostgreSQL versions.
+- Add better support for logical replication. #339
+- Change conn.socket_io to read+write mode and to a BasicSocket object instead of IO.
+- Use rb_io_wait() and the conn.socket_io object if available for better compatibility to Fiber.scheduler .
+  Fall back to rb_wait_for_single_fd() on ruby < 3.0.
+- On Windows use a specialized wait function as a workaround for very poor performance of rb_io_wait(). #416
+
+Bugfixes:
+- Release GVL while calling PQping which is a blocking method, but it didn't release GVL so far.
+- Fix Connection#transaction to no longer block on interrupts, for instance when pressing Ctrl-C and cancel a running query. #390
+- Avoid casting of OIDs to fix compat with Redshift database. #369
+- Call conn.block before each conn.get_result call to avoid possible blocking in case of a slow network and multiple query results.
+- Sporadic Errno::ENOTSOCK when using conn.socket_io on Windows #398
+
+Deprecated:
+- Add deprecation warning to PG::BasicTypeRegistry.register_type and siblings.
+
+Removed:
+- Remove support of ruby-2.2, 2.3 and 2.4. Minimum is ruby-2.5 now.
+- Remove support for PostgreSQL-9.2. Minimum is PostgreSQL-9.3 now.
+- Remove constant PG::REVISION, which was broken since pg-1.1.4.
+
+Repository:
+- Replace Hoe by Bundler for gem packaging
+- Add Github Actions CI and testing of source and binary gems.
+
+
+== v1.2.3 [2020-03-18] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Fix possible segfault at `PG::Coder#encode`, `decode` or their implicit calls through
+  a typemap after GC.compact. #327
+- Fix possible segfault in `PG::TypeMapByClass` after GC.compact. #328
+
+
+== v1.2.2 [2020-01-06] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add a binary gem for Ruby 2.7.
+
+
+== v1.2.1 [2020-01-02] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Added internal API for sequel_pg compatibility.
+
+
+== v1.2.0 [2019-12-20] Michael Granger <ged@FaerieMUD.org>
+
+Repository:
+- Our primary repository has been moved to Github https://github.com/ged/ruby-pg .
+  Most of the issues from https://bitbucket.org/ged/ruby-pg have been migrated. #43
+
+API enhancements:
+- Add PG::Result#field_name_type= and siblings to allow symbols to be used as field names. #306
+- Add new methods for error reporting:
+  - PG::Connection#set_error_context_visibility
+  - PG::Result#verbose_error_message
+  - PG::Result#result_verbose_error_message (alias)
+- Update errorcodes and error classes to PostgreSQL-12.0.
+- New constants: PG_DIAG_SEVERITY_NONLOCALIZED, PQERRORS_SQLSTATE, PQSHOW_CONTEXT_NEVER, PQSHOW_CONTEXT_ERRORS, PQSHOW_CONTEXT_ALWAYS
+
+Type cast enhancements:
+- Add PG::TextEncoder::Record and PG::TextDecoder::Record for en/decoding of Composite Types. #258, #36
+- Add PG::BasicTypeRegistry.register_coder to register instances instead of classes.
+  This is useful to register parametrized en/decoders like PG::TextDecoder::Record .
+- Add PG::BasicTypeMapForQueries#encode_array_as= to switch between various interpretations of ruby arrays.
+- Add Time, Array<Time>, Array<BigDecimal> and Array<IPAddr> encoders to PG::BasicTypeMapForQueries
+- Exchange sprintf based float encoder by very fast own implementation with more natural format. #301
+- Define encode and decode methods only in en/decoders that implement it, so that they can be queried by respond_to? .
+- Improve PG::TypeMapByColumn#inspect
+- Accept Integer and Float as input to TextEncoder::Numeric . #310
+
+Other enhancements:
+- Allocate the data part and the ruby object of PG::Result in one step, so that we don't need to check for valid data.
+  This removes PG::Result.allocate and PG::Result.new, which were callable but without any practical use. #42
+- Make use of PQresultMemorySize() of PostgreSQL-12 and fall back to our internal estimator.
+- Improve performance of PG::Result#stream_each_tuple .
+- Store client encoding in data part of PG::Connection and PG::Result objects, so that we no longer use ruby's internal encoding bits. #280
+- Update Windows fat binary gem to OpenSSL-1.1.1d and PostgreSQL-12.1.
+- Add support for TruffleRuby. It is regularly tested as part of our CI.
+- Enable +frozen_string_literal+ in all pg's ruby files
+
+Bugfixes:
+- Update the license in gemspec to "BSD-2-Clause".
+  It was incorrectly labeled "BSD-3-Clause". #40
+- Respect PG::Coder#flags in PG::Coder#to_h.
+- Fix PG::Result memsize reporting after #clear.
+- Release field names to GC on PG::Result#clear.
+- Fix double free in PG::Result#stream_each_tuple when an exception is raised in the block.
+- Fix PG::Result#stream_each_tuple to deliver typemapped values.
+- Fix encoding of Array<unknown> with PG::BasicTypeMapForQueries
+
+Deprecated:
+- Add a deprecation warning to PG::Connection#socket .
+
+Removed:
+- Remove PG::Connection#guess_result_memsize= which was temporary added in pg-1.1.
+- Remove PG::Result.allocate and PG::Result.new (see enhancements).
+- Remove support of tainted objects. #307
+- Remove support of ruby-2.0 and 2.1. Minimum is ruby-2.2 now.
+
+Documentation:
+- Update description of connection params. See PG::Connection.new
+- Link many method descriptions to corresponding libpq's documentation.
+- Update sync_* and async_* query method descriptions and document the aliases.
+  The primary documentation is now at the async_* methods which are the default since pg-1.1.
+- Fix documentation of many constants
+
+
+== v1.1.4 [2019-01-08] Michael Granger <ged@FaerieMUD.org>
+
+- Fix PG::BinaryDecoder::Timestamp on 32 bit systems. # 284
+- Add new error-codes of PostgreSQL-11.
+- Add ruby-2.6 support for Windows fat binary gems and remove ruby-2.0 and 2.1.
+
+
+== v1.1.3 [2018-09-06] Michael Granger <ged@FaerieMUD.org>
+
+- Revert opimization that was sometimes causing EBADF in rb_wait_for_single_fd().
+
+
+== v1.1.2 [2018-08-28] Michael Granger <ged@FaerieMUD.org>
+
+- Don't generate aliases for JOHAB encoding.
+  This avoids linking to deprecated/private function rb_enc(db)_alias().
+
+
+== v1.1.1 [2018-08-27] Michael Granger <ged@FaerieMUD.org>
+
+- Reduce deprecation warnings to only one message per deprecation.
+
+
+== v1.1.0 [2018-08-24] Michael Granger <ged@FaerieMUD.org>
+
+Deprecated (disable warnings per PG_SKIP_DEPRECATION_WARNING=1):
+- Forwarding conn.exec to conn.exec_params is deprecated.
+- Forwarding conn.exec_params to conn.exec is deprecated.
+- Forwarding conn.async_exec to conn.async_exec_params.
+- Forwarding conn.send_query to conn.send_query_params is deprecated.
+- Forwarding conn.async_exec_params to conn.async_exec is deprecated.
+
+PG::Connection enhancements:
+- Provide PG::Connection#sync_* and PG::Connection#async_* query methods for explicit calling synchronous or asynchronous libpq API.
+- Make PG::Connection#exec and siblings switchable between sync and async API per PG::Connection.async_api= and change the default to async flavors.
+- Add async flavors of exec_params, prepare, exec_prepared, describe_prepared and describe_portal.
+  They are identical to their synchronous counterpart, but make use of PostgreSQL's async API.
+- Replace `rb_thread_fd_select()` by faster `rb_wait_for_single_fd()` in `conn.block` and `conn.async_exec` .
+- Add PG::Connection#discard_results .
+- Raise an ArgumentError for strings containing zero bytes by #escape, #escape_literal, #escape_identifier, #quote_ident and PG::TextEncoder::Identifier. These methods previously truncated strings.
+
+Result retrieval enhancements:
+- Add PG::Result#tuple_values to retrieve all field values of a row as array.
+- Add PG::Tuple, PG::Result#tuple and PG::Result#stream_each_tuple .
+  PG::Tuple offers a way to lazy cast result values.
+- Estimate PG::Result size allocated by libpq and notify the garbage collector about it when running on Ruby-2.4 or newer.
+- Make the estimated PG::Result size available to ObjectSpace.memsize_of(result) .
+
+Type cast enhancements:
+- Replace Ruby code by a faster C implementation of the SimpleDecoder's timestamp decode functions. github #20
+- Interpret years with up to 7 digists and BC dates by timestamp decoder.
+- Add text timestamp decoders for UTC vs. local timezone variations.
+- Add text timestamp encoders for UTC timezone.
+- Add decoders for binary timestamps: PG::BinaryDecoder::Timestamp and variations.
+- Add PG::Coder#flags accessor to allow modifications of de- respectively encoder behaviour.
+- Add a flag to raise TypeError for invalid input values to PG::TextDecoder::Array .
+- Add a text decoder for inet/cidr written in C.
+- Add a numeric decoder written in C.
+- Ensure input text is zero terminated for text format in PG::Coder#decode .
+
+Source code enhancements:
+- Fix headers and permission bits of various repository files.
+
+Bugfixes:
+- Properly decode array with prepended dimensions. #272
+  For now dimension decorations are ignored, but a correct Array is returned.
+- Array-Decoder: Avoid leaking memory when an Exception is raised while parsing. Fixes #279
+
+
+== v1.0.0 [2018-01-10] Michael Granger <ged@FaerieMUD.org>
+
+Deprecated:
+- Deprecate Ruby older than 2.2.
+- Deprecate Connection#socket in favor of #socket_io.
+
+Removed:
+- Remove compatibility code for Ruby < 2.0 and PostgreSQL < 9.2.
+- Remove partial compatibility with Rubinius.
+- Remove top-level constants PGconn, PGresult, and PGError.
+
+Enhancements:
+- Update error codes to PostgreSQL-10
+- Update Windows binary gems to Ruby-2.5, PostgreSQL 10.1 and
+  OpenSSL 1.1.0g.
+
+Bugfixes:
+- Fix URI detection for connection strings. #265 (thanks to jjoos)
+- MINGW: Workaround segfault due to GCC linker error in conjunction with MSVC.
+  This happens when linking to PostgreSQL-10.0-x64 from EnterpriseDB.
+
+Documentation fixes:
+- Add PostgreSQL version since when the given function is supported. #263
+- Better documentation to `encoder` and `decoder` arguments of COPY related methods.
+
+
 == v0.21.0 [2017-06-12] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:
@@ -10,6 +294,9 @@ Enhancements:
 Documentation fixes:
 - Update the docs for PG::Result#cmd_tuples
 
+New Samples:
+- Add an example of the nicer #copy_data way of doing `COPY`.
+
 
 == v0.20.0 [2017-03-10] Michael Granger <ged@FaerieMUD.org>
 
@@ -91,7 +378,7 @@ Bugfixes:
 - Revert addition of PG::Connection#hostaddr [#202].
 - Fix decoding of fractional timezones and timestamps [#203]
 - Fixes for non-C99 compilers
-- Avoid possible symbol name clash when linking againt static libpq.
+- Avoid possible symbol name clash when linking against static libpq.
 
 
 == v0.18.1 [2015-01-05] Michael Granger <ged@FaerieMUD.org>
@@ -127,7 +414,7 @@ Enhancements:
 Bugfixes:
 
 - Fix compatibility with signal handlers defined in Ruby. This reverts
-  cancelation of queries running on top of the blocking libpq API (like
+  cancellation 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
@@ -205,7 +492,7 @@ 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
+- Set fallback_application_name to program 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.
@@ -213,7 +500,7 @@ Enhancements:
 - 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 continuous 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

data/Manifest.txt

@@ -1,6 +1,5 @@
 .gemtest
 BSDL
-ChangeLog
 Contributors.rdoc
 History.rdoc
 LICENSE
@@ -26,9 +25,11 @@ ext/pg_coder.c
 ext/pg_connection.c
 ext/pg_copy_coder.c
 ext/pg_errors.c
+ext/pg_record_coder.c
 ext/pg_result.c
 ext/pg_text_decoder.c
 ext/pg_text_encoder.c
+ext/pg_tuple.c
 ext/pg_type_map.c
 ext/pg_type_map_all_strings.c
 ext/pg_type_map_by_class.c
@@ -36,28 +37,31 @@ ext/pg_type_map_by_column.c
 ext/pg_type_map_by_mri_type.c
 ext/pg_type_map_by_oid.c
 ext/pg_type_map_in_ruby.c
-ext/util.c
-ext/util.h
+ext/pg_util.c
+ext/pg_util.h
 ext/vc/pg.sln
 ext/vc/pg_18/pg.vcproj
 ext/vc/pg_19/pg_19.vcproj
 lib/pg.rb
 lib/pg/basic_type_mapping.rb
+lib/pg/binary_decoder.rb
 lib/pg/coder.rb
 lib/pg/connection.rb
 lib/pg/constants.rb
-lib/pg/deprecated_constants.rb
 lib/pg/exceptions.rb
 lib/pg/result.rb
 lib/pg/text_decoder.rb
 lib/pg/text_encoder.rb
+lib/pg/tuple.rb
 lib/pg/type_map_by_column.rb
 spec/data/expected_trace.out
 spec/data/random_binary_data
 spec/helpers.rb
 spec/pg/basic_type_mapping_spec.rb
 spec/pg/connection_spec.rb
+spec/pg/connection_sync_spec.rb
 spec/pg/result_spec.rb
+spec/pg/tuple_spec.rb
 spec/pg/type_map_by_class_spec.rb
 spec/pg/type_map_by_column_spec.rb
 spec/pg/type_map_by_mri_type_spec.rb

data/README-Windows.rdoc

@@ -35,8 +35,8 @@ Binary gems for windows can be built on Linux, OS-X and even on Windows
 with the help of docker. This is how regular windows gems are built for
 rubygems.org .
 
-To do this, install boot2docker [on Windows](https://github.com/boot2docker/windows-installer/releases)
-or [on OS X](https://github.com/boot2docker/osx-installer/releases) and make
+To do this, install boot2docker {on Windows}[https://github.com/boot2docker/windows-installer/releases]
+or {on OS X}[https://github.com/boot2docker/osx-installer/releases] and make
 sure it is started. A native Docker installation is best on Linux.
 
 Then run:
@@ -50,7 +50,7 @@ containing binaries for all supported ruby versions.
 
 == Reporting Problems
 
-If you have any problems you can submit them via
-[the project's issue-tracker][bitbucket]. And submit questions, problems, or
+If you have any problems you can submit them via {the project's
+issue-tracker}[https://github.com/ged/ruby-pg/issues]. And submit questions, problems, or
 solutions, so that it can be improved.
 

data/README.ja.rdoc

@@ -1,7 +1,6 @@
 = pg
 
-home :: https://bitbucket.org/ged/ruby-pg
-mirror :: https://github.com/ged/ruby-pg
+home :: https://github.com/ged/ruby-pg
 docs :: http://deveiate.org/code/pg
 
 

data/README.rdoc

@@ -1,8 +1,8 @@
 = pg
 
-home :: https://bitbucket.org/ged/ruby-pg
-mirror :: https://github.com/ged/ruby-pg
+home :: https://github.com/ged/ruby-pg
 docs :: http://deveiate.org/code/pg
+clog :: link:/History.rdoc
 
 {<img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/ged/ruby-pg">}[https://gitter.im/ged/ruby-pg?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]
 
@@ -11,7 +11,7 @@ docs :: http://deveiate.org/code/pg
 
 Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/].
 
-It works with {PostgreSQL 9.1 and later}[http://www.postgresql.org/support/versioning/].
+It works with {PostgreSQL 9.3 and later}[http://www.postgresql.org/support/versioning/].
 
 A small example usage:
 
@@ -25,25 +25,36 @@ A small example usage:
     puts "     PID | User             | Query"
     result.each do |row|
       puts " %7d | %-16s | %s " %
-        row.values_at('procpid', 'usename', 'current_query')
+        row.values_at('pid', 'usename', 'query')
     end
   end
 
 == Build Status
 
-{<img src="https://travis-ci.org/ged/ruby-pg.svg?branch=master" alt="Build Status Travis-CI" />}[https://travis-ci.org/ged/ruby-pg]
-{<img src="https://ci.appveyor.com/api/projects/status/at4g4swb2cd4xji7/branch/master?svg=true" alt="Build Status Appveyor" />}[https://ci.appveyor.com/project/ged/ruby-pg]
-
+{<img src="https://github.com/ged/ruby-pg/actions/workflows/source-gem.yml/badge.svg?branch=master" alt="Build Status Github Actions" />}[https://github.com/ged/ruby-pg/actions/workflows/source-gem.yml]
+{<img src="https://ci.appveyor.com/api/projects/status/gjx5axouf3b1wicp?svg=true" alt="Build Status Appveyor" />}[https://ci.appveyor.com/project/ged/ruby-pg-9j8l3]
+{<img src="https://app.travis-ci.com/larskanis/ruby-pg.svg?branch=master" alt="Build Status" />}[https://app.travis-ci.com/larskanis/ruby-pg]
 
 == Requirements
 
-* Ruby 2.2
-* PostgreSQL 9.1.x or later (with headers, -dev packages, etc).
+* Ruby 2.4 or newer
+* PostgreSQL 9.3.x or later (with headers, -dev packages, etc).
 
-It usually work with earlier versions of Ruby/PostgreSQL as well, but those are
+It usually works with earlier versions of Ruby/PostgreSQL as well, but those are
 not regularly tested.
 
 
+== Versioning
+
+We tag and release gems according to the {Semantic Versioning}[http://semver.org/] principle.
+
+As a result of this policy, you can (and should) specify a dependency on this gem using the {Pessimistic Version Constraint}[http://guides.rubygems.org/patterns/#pessimistic-version-constraint] with two digits of precision.
+
+For example:
+
+  spec.add_dependency 'pg', '~> 1.0'
+
+
 == How To Install
 
 Install via RubyGems:
@@ -67,7 +78,7 @@ There's also {a Google+ group}[http://goo.gl/TFy1U] and a
 want to chat about something.
 
 If you want to install as a signed gem, the public certs of the gem signers
-can be found in {the `certs` directory}[https://bitbucket.org/ged/ruby-pg/src/tip/certs/]
+can be found in {the `certs` directory}[https://github.com/ged/ruby-pg/tree/master/certs]
 of the repository.
 
 
@@ -107,6 +118,30 @@ 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.
 
+The following PostgreSQL column types are supported by ruby-pg (TE = Text Encoder, TD = Text Decoder, BE = Binary Encoder, BD = Binary Decoder):
+* Integer: {TE}[rdoc-ref:PG::TextEncoder::Integer], {TD}[rdoc-ref:PG::TextDecoder::Integer], {BD}[rdoc-ref:PG::BinaryDecoder::Integer] 💡 No links? Switch to {here}[https://deveiate.org/code/pg/README_rdoc.html#label-Type+Casts] 💡
+  * BE: {Int2}[rdoc-ref:PG::BinaryEncoder::Int2], {Int4}[rdoc-ref:PG::BinaryEncoder::Int4], {Int8}[rdoc-ref:PG::BinaryEncoder::Int8]
+* Float: {TE}[rdoc-ref:PG::TextEncoder::Float], {TD}[rdoc-ref:PG::TextDecoder::Float], {BD}[rdoc-ref:PG::BinaryDecoder::Float]
+* Numeric: {TE}[rdoc-ref:PG::TextEncoder::Numeric], {TD}[rdoc-ref:PG::TextDecoder::Numeric]
+* Boolean: {TE}[rdoc-ref:PG::TextEncoder::Boolean], {TD}[rdoc-ref:PG::TextDecoder::Boolean], {BE}[rdoc-ref:PG::BinaryEncoder::Boolean], {BD}[rdoc-ref:PG::BinaryDecoder::Boolean]
+* String: {TE}[rdoc-ref:PG::TextEncoder::String], {TD}[rdoc-ref:PG::TextDecoder::String], {BE}[rdoc-ref:PG::BinaryEncoder::String], {BD}[rdoc-ref:PG::BinaryDecoder::String]
+* Bytea: {TE}[rdoc-ref:PG::TextEncoder::Bytea], {TD}[rdoc-ref:PG::TextDecoder::Bytea], {BE}[rdoc-ref:PG::BinaryEncoder::Bytea], {BD}[rdoc-ref:PG::BinaryDecoder::Bytea]
+* Base64: {TE}[rdoc-ref:PG::TextEncoder::ToBase64], {TD}[rdoc-ref:PG::TextDecoder::FromBase64], {BE}[rdoc-ref:PG::BinaryEncoder::FromBase64], {BD}[rdoc-ref:PG::BinaryDecoder::ToBase64]
+* Timestamp:
+  * TE: {local}[rdoc-ref:PG::TextEncoder::TimestampWithoutTimeZone], {UTC}[rdoc-ref:PG::TextEncoder::TimestampUtc], {with-TZ}[rdoc-ref:PG::TextEncoder::TimestampWithTimeZone]
+  * TD: {local}[rdoc-ref:PG::TextDecoder::TimestampLocal], {UTC}[rdoc-ref:PG::TextDecoder::TimestampUtc], {UTC-to-local}[rdoc-ref:PG::TextDecoder::TimestampUtcToLocal]
+  * BD: {local}[rdoc-ref:PG::BinaryDecoder::TimestampLocal], {UTC}[rdoc-ref:PG::BinaryDecoder::TimestampUtc], {UTC-to-local}[rdoc-ref:PG::BinaryDecoder::TimestampUtcToLocal]
+* Date: {TE}[rdoc-ref:PG::TextEncoder::Date], {TD}[rdoc-ref:PG::TextDecoder::Date]
+* JSON and JSONB: {TE}[rdoc-ref:PG::TextEncoder::JSON], {TD}[rdoc-ref:PG::TextDecoder::JSON]
+* Inet: {TE}[rdoc-ref:PG::TextEncoder::Inet], {TD}[rdoc-ref:PG::TextDecoder::Inet]
+* Array: {TE}[rdoc-ref:PG::TextEncoder::Array], {TD}[rdoc-ref:PG::TextDecoder::Array]
+* Composite Type (also called "Row" or "Record"): {TE}[rdoc-ref:PG::TextEncoder::Record], {TD}[rdoc-ref:PG::TextDecoder::Record]
+
+The following text formats can also be encoded although they are not used as column type:
+* COPY input and output data: {TE}[rdoc-ref:PG::TextEncoder::CopyRow], {TD}[rdoc-ref:PG::TextDecoder::CopyRow]
+* Literal for insertion into SQL string: {TE}[rdoc-ref:PG::TextEncoder::QuotedLiteral]
+* SQL-Identifier: {TE}[rdoc-ref:PG::TextEncoder::Identifier], {TD}[rdoc-ref:PG::TextDecoder::Identifier]
+
 === 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.
@@ -118,11 +153,23 @@ 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.
 See PG::Connection#copy_data .
 
+The following base type maps are available:
+* PG::TypeMapAllStrings - encodes and decodes all values to and from strings (default)
+* PG::TypeMapByClass - selects encoder based on the class of the value to be sent
+* PG::TypeMapByColumn - selects encoder and decoder by column order
+* PG::TypeMapByOid - selects decoder by PostgreSQL type OID
+* PG::TypeMapInRuby - define a custom type map in ruby
+
+The following type maps are prefilled with type mappings from the PG::BasicTypeRegistry :
+* PG::BasicTypeMapForResults - a PG::TypeMapByOid prefilled with decoders for common PostgreSQL column types
+* PG::BasicTypeMapBasedOnResult - a PG::TypeMapByOid prefilled with encoders for common PostgreSQL column types
+* PG::BasicTypeMapForQueries - a PG::TypeMapByClass prefilled with encoders for common Ruby value classes
+
+
 == 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].
+To report bugs, suggest features, or check out the source with Git,
+{check out the project page}[https://github.com/ged/ruby-pg].
 
 After checking out the source, run:
 
@@ -137,7 +184,7 @@ Lars Kanis <lars@greiz-reinsdorf.de>.
 
 == Copying
 
-Copyright (c) 1997-2016 by the authors.
+Copyright (c) 1997-2019 by the authors.
 
 * Jeff Davis <ruby-pg@j-davis.com>
 * Guy Decoux (ts) <decoux@moulon.inra.fr>
@@ -165,4 +212,3 @@ 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.
-