pg 1.1.4 → 1.2.0

data/History.rdoc

@@ -1,3 +1,66 @@
+== 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 regulary 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

data/Manifest.txt

@@ -26,6 +26,7 @@ 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
@@ -37,8 +38,8 @@ 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

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,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
 
 {<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]
@@ -32,7 +31,7 @@ A small example usage:
 == 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://ci.appveyor.com/api/projects/status/gjx5axouf3b1wicp?svg=true" alt="Build Status Appveyor" />}[https://ci.appveyor.com/project/ged/ruby-pg-9j8l3]
 
 
 == Requirements
@@ -78,7 +77,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.
 
 
@@ -118,6 +117,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]
+  * 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.
@@ -129,11 +152,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:
 
@@ -148,7 +183,7 @@ Lars Kanis .
 
 == 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>

data/Rakefile

@@ -55,7 +55,7 @@ $hoespec = Hoe.spec 'pg' do
 	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
 	self.extra_rdoc_files.include( 'POSTGRES', 'LICENSE' )
 	self.extra_rdoc_files.include( 'ext/*.c' )
-	self.license 'BSD-3-Clause'
+	self.license 'BSD-2-Clause'
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 	self.developer 'Lars Kanis', 'lars@greiz-reinsdorf.de'
@@ -69,7 +69,7 @@ $hoespec = Hoe.spec 'pg' do
 
 	self.spec_extras[:extensions] = [ 'ext/extconf.rb' ]
 
-	self.require_ruby_version( '>= 2.0.0' )
+	self.require_ruby_version( '>= 2.2' )
 
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
 	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
@@ -184,7 +184,7 @@ end
 
 desc "Update list of server error codes"
 task :update_error_codes do
-	URL_ERRORCODES_TXT = "http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob_plain;f=src/backend/utils/errcodes.txt;hb=refs/tags/REL_11_1"
+	URL_ERRORCODES_TXT = "http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob_plain;f=src/backend/utils/errcodes.txt;hb=refs/tags/REL_12_0"
 
 	ERRORCODES_TXT = "ext/errorcodes.txt"
 	sh "wget #{URL_ERRORCODES_TXT.inspect} -O #{ERRORCODES_TXT.inspect} || curl #{URL_ERRORCODES_TXT.inspect} -o #{ERRORCODES_TXT.inspect}"

data/Rakefile.cross

@@ -29,8 +29,8 @@ class CrossLibrary < OpenStruct
 		self.host_platform              = toolchain
 
 		# Cross-compilation constants
-		self.openssl_version            = ENV['OPENSSL_VERSION'] || '1.1.1a'
-		self.postgresql_version         = ENV['POSTGRESQL_VERSION'] || '11.1'
+		self.openssl_version            = ENV['OPENSSL_VERSION'] || '1.1.1d'
+		self.postgresql_version         = ENV['POSTGRESQL_VERSION'] || '12.1'
 
 		# Check if symlinks work in the current working directory.
 		# This fails, if rake-compiler-dock is running on a Windows box.
@@ -217,6 +217,9 @@ class CrossLibrary < OpenStruct
 			chdir( static_postgresql_srcdir + "common" ) do
 				sh 'make', "-j#{NUM_CPUS}"
 			end
+			chdir( static_postgresql_srcdir + "port" ) do
+				sh 'make', "-j#{NUM_CPUS}"
+			end
 
 			chdir( postgresql_lib.dirname ) do
 				sh 'make',
@@ -292,7 +295,7 @@ task 'gem:windows' => ['ChangeLog'] do
   RakeCompilerDock.sh <<-EOT
     mkdir ~/.gem &&
     (cp build/gem/gem-*.pem ~/.gem/ || true) &&
-    bundle install --local &&
+    gem install -Ng &&
     rake cross native gem MAKE="make -j`nproc`"
   EOT
 end

data/ext/errorcodes.def

@@ -302,6 +302,66 @@
   VALUE klass = define_error_class( "InvalidXmlProcessingInstruction", "22" );
   register_error_class( "2200T", klass );
 }
+{
+  VALUE klass = define_error_class( "DuplicateJsonObjectKeyValue", "22" );
+  register_error_class( "22030", klass );
+}
+{
+  VALUE klass = define_error_class( "InvalidJsonText", "22" );
+  register_error_class( "22032", klass );
+}
+{
+  VALUE klass = define_error_class( "InvalidSqlJsonSubscript", "22" );
+  register_error_class( "22033", klass );
+}
+{
+  VALUE klass = define_error_class( "MoreThanOneSqlJsonItem", "22" );
+  register_error_class( "22034", klass );
+}
+{
+  VALUE klass = define_error_class( "NoSqlJsonItem", "22" );
+  register_error_class( "22035", klass );
+}
+{
+  VALUE klass = define_error_class( "NonNumericSqlJsonItem", "22" );
+  register_error_class( "22036", klass );
+}
+{
+  VALUE klass = define_error_class( "NonUniqueKeysInAJsonObject", "22" );
+  register_error_class( "22037", klass );
+}
+{
+  VALUE klass = define_error_class( "SingletonSqlJsonItemRequired", "22" );
+  register_error_class( "22038", klass );
+}
+{
+  VALUE klass = define_error_class( "SqlJsonArrayNotFound", "22" );
+  register_error_class( "22039", klass );
+}
+{
+  VALUE klass = define_error_class( "SqlJsonMemberNotFound", "22" );
+  register_error_class( "2203A", klass );
+}
+{
+  VALUE klass = define_error_class( "SqlJsonNumberNotFound", "22" );
+  register_error_class( "2203B", klass );
+}
+{
+  VALUE klass = define_error_class( "SqlJsonObjectNotFound", "22" );
+  register_error_class( "2203C", klass );
+}
+{
+  VALUE klass = define_error_class( "TooManyJsonArrayElements", "22" );
+  register_error_class( "2203D", klass );
+}
+{
+  VALUE klass = define_error_class( "TooManyJsonObjectMembers", "22" );
+  register_error_class( "2203E", klass );
+}
+{
+  VALUE klass = define_error_class( "SqlJsonScalarRequired", "22" );
+  register_error_class( "2203F", klass );
+}
 {
   VALUE klass = define_error_class( "IntegrityConstraintViolation", NULL );
   register_error_class( "23000", klass );
@@ -767,6 +827,10 @@
   VALUE klass = define_error_class( "LockNotAvailable", "55" );
   register_error_class( "55P03", klass );
 }
+{
+  VALUE klass = define_error_class( "UnsafeNewEnumValueUsage", "55" );
+  register_error_class( "55P04", klass );
+}
 {
   VALUE klass = define_error_class( "OperatorIntervention", NULL );
   register_error_class( "57000", klass );

data/ext/errorcodes.txt

@@ -2,7 +2,7 @@
 # errcodes.txt
 #      PostgreSQL error codes
 #
-# Copyright (c) 2003-2018, PostgreSQL Global Development Group
+# Copyright (c) 2003-2019, PostgreSQL Global Development Group
 #
 # This list serves as the basis for generating source files containing error
 # codes. It is kept in a common format to make sure all these source files have
@@ -18,7 +18,7 @@
 #   src/pl/tcl/pltclerrcodes.h
 #      the same, for PL/Tcl
 #
-#   doc/src/sgml/errcodes-list.sgml
+#   doc/src/sgml/errcodes-table.sgml
 #      a SGML table of error codes for inclusion in the documentation
 #
 # The format of this file is one error code per line, with the following
@@ -206,6 +206,21 @@ Section: Class 22 - Data Exception
 2200N    E    ERRCODE_INVALID_XML_CONTENT                                    invalid_xml_content
 2200S    E    ERRCODE_INVALID_XML_COMMENT                                    invalid_xml_comment
 2200T    E    ERRCODE_INVALID_XML_PROCESSING_INSTRUCTION                     invalid_xml_processing_instruction
+22030    E    ERRCODE_DUPLICATE_JSON_OBJECT_KEY_VALUE                        duplicate_json_object_key_value
+22032    E    ERRCODE_INVALID_JSON_TEXT                                      invalid_json_text
+22033    E    ERRCODE_INVALID_SQL_JSON_SUBSCRIPT                             invalid_sql_json_subscript
+22034    E    ERRCODE_MORE_THAN_ONE_SQL_JSON_ITEM                            more_than_one_sql_json_item
+22035    E    ERRCODE_NO_SQL_JSON_ITEM                                       no_sql_json_item
+22036    E    ERRCODE_NON_NUMERIC_SQL_JSON_ITEM                              non_numeric_sql_json_item
+22037    E    ERRCODE_NON_UNIQUE_KEYS_IN_A_JSON_OBJECT                       non_unique_keys_in_a_json_object
+22038    E    ERRCODE_SINGLETON_SQL_JSON_ITEM_REQUIRED                       singleton_sql_json_item_required
+22039    E    ERRCODE_SQL_JSON_ARRAY_NOT_FOUND                               sql_json_array_not_found
+2203A    E    ERRCODE_SQL_JSON_MEMBER_NOT_FOUND                              sql_json_member_not_found
+2203B    E    ERRCODE_SQL_JSON_NUMBER_NOT_FOUND                              sql_json_number_not_found
+2203C    E    ERRCODE_SQL_JSON_OBJECT_NOT_FOUND                              sql_json_object_not_found
+2203D    E    ERRCODE_TOO_MANY_JSON_ARRAY_ELEMENTS                           too_many_json_array_elements
+2203E    E    ERRCODE_TOO_MANY_JSON_OBJECT_MEMBERS                           too_many_json_object_members
+2203F    E    ERRCODE_SQL_JSON_SCALAR_REQUIRED                               sql_json_scalar_required
 
 Section: Class 23 - Integrity Constraint Violation
 
@@ -401,6 +416,7 @@ Section: Class 55 - Object Not In Prerequisite State
 55006    E    ERRCODE_OBJECT_IN_USE                                          object_in_use
 55P02    E    ERRCODE_CANT_CHANGE_RUNTIME_PARAM                              cant_change_runtime_param
 55P03    E    ERRCODE_LOCK_NOT_AVAILABLE                                     lock_not_available
+55P04    E    ERRCODE_UNSAFE_NEW_ENUM_VALUE_USAGE                            unsafe_new_enum_value_usage
 
 Section: Class 57 - Operator Intervention
 

data/ext/extconf.rb

@@ -73,13 +73,13 @@ end
 have_func 'PQsetSingleRowMode' or
 	abort "Your PostgreSQL is too old. Either install an older version " +
 	      "of this gem or upgrade your database to at least PostgreSQL-9.2."
-have_func 'PQconninfo'
-have_func 'PQsslAttribute'
-have_func 'PQencryptPasswordConn'
+have_func 'PQconninfo' # since PostgreSQL-9.3
+have_func 'PQsslAttribute' # since PostgreSQL-9.5
+have_func 'PQresultVerboseErrorMessage' # since PostgreSQL-9.6
+have_func 'PQencryptPasswordConn' # since PostgreSQL-10
+have_func 'PQresultMemorySize' # since PostgreSQL-12
 have_func 'timegm'
-have_func 'rb_gc_adjust_memory_usage'
-
-have_const 'PG_DIAG_TABLE_NAME', 'libpq-fe.h'
+have_func 'rb_gc_adjust_memory_usage' # since ruby-2.4
 
 # unistd.h confilicts with ruby/win32.h when cross compiling for win32 and ruby 1.9.1
 have_header 'unistd.h'

data/ext/pg.c

@@ -1,6 +1,6 @@
 /*
  * pg.c - Toplevel extension
- * $Id: pg.c,v 2d334508484a 2018/08/27 11:33:43 lars $
+ * $Id$
  *
  * Author/s:
  *
@@ -16,7 +16,7 @@
  * See Contributors.rdoc for the many additional fine people that have contributed
  * to this library over the years.
  *
- * Copyright (c) 1997-2016 by the authors.
+ * Copyright (c) 1997-2019 by the authors.
  *
  * You may redistribute this software under the same terms as Ruby itself; see
  * https://www.ruby-lang.org/en/about/license.txt or the BSDL file in the source
@@ -331,8 +331,7 @@ pg_to_bool_int(VALUE value)
  * If your application initializes libssl and/or libcrypto libraries and libpq is
  * built with SSL support, you should call PG.init_openssl() to tell libpq that the
  * libssl and/or libcrypto libraries have been initialized by your application,
- * so that libpq will not also initialize those libraries. See
- * http://h71000.www7.hp.com/doc/83final/BA554_90007/ch04.html for details on the SSL API.
+ * so that libpq will not also initialize those libraries.
  *
  * When do_ssl is +true+, libpq will initialize the OpenSSL library before first
  * opening a database connection. When do_crypto is +true+, the libcrypto library
@@ -422,7 +421,7 @@ Init_pg_ext()
 	rb_define_const(rb_mPGconstants, "CONNECTION_SSL_STARTUP", INT2FIX(CONNECTION_SSL_STARTUP));
 	/* Negotiating environment-driven parameter settings. */
 	rb_define_const(rb_mPGconstants, "CONNECTION_SETENV", INT2FIX(CONNECTION_SETENV));
-	/* Internal state: connect() needed. */
+	/* Internal state - PG.connect() needed. */
 	rb_define_const(rb_mPGconstants, "CONNECTION_NEEDED", INT2FIX(CONNECTION_NEEDED));
 
 	/******     PG::Connection CLASS CONSTANTS: Nonblocking connection polling status     ******/
@@ -438,26 +437,48 @@ Init_pg_ext()
 
 	/******     PG::Connection CLASS CONSTANTS: Transaction Status     ******/
 
-	/* Transaction is currently idle (#transaction_status) */
+	/* Transaction is currently idle ( Connection#transaction_status ) */
 	rb_define_const(rb_mPGconstants, "PQTRANS_IDLE", INT2FIX(PQTRANS_IDLE));
-	/* Transaction is currently active; query has been sent to the server, but not yet completed. (#transaction_status) */
+	/* Transaction is currently active; query has been sent to the server, but not yet completed. ( Connection#transaction_status ) */
 	rb_define_const(rb_mPGconstants, "PQTRANS_ACTIVE", INT2FIX(PQTRANS_ACTIVE));
-	/* Transaction is currently idle, in a valid transaction block (#transaction_status) */
+	/* Transaction is currently idle, in a valid transaction block ( Connection#transaction_status ) */
 	rb_define_const(rb_mPGconstants, "PQTRANS_INTRANS", INT2FIX(PQTRANS_INTRANS));
-	/* Transaction is currently idle, in a failed transaction block (#transaction_status) */
+	/* Transaction is currently idle, in a failed transaction block ( Connection#transaction_status ) */
 	rb_define_const(rb_mPGconstants, "PQTRANS_INERROR", INT2FIX(PQTRANS_INERROR));
-	/* Transaction's connection is bad (#transaction_status) */
+	/* Transaction's connection is bad ( Connection#transaction_status ) */
 	rb_define_const(rb_mPGconstants, "PQTRANS_UNKNOWN", INT2FIX(PQTRANS_UNKNOWN));
 
 	/******     PG::Connection CLASS CONSTANTS: Error Verbosity     ******/
 
-	/* Terse error verbosity level (#set_error_verbosity) */
+	/* Error verbosity level ( Connection#set_error_verbosity ).
+	 * In TERSE mode, returned messages include severity, primary text, and position only; this will normally fit on a single line. */
 	rb_define_const(rb_mPGconstants, "PQERRORS_TERSE", INT2FIX(PQERRORS_TERSE));
-	/* Default error verbosity level (#set_error_verbosity) */
+	/* Error verbosity level ( Connection#set_error_verbosity ).
+	 * The DEFAULT mode produces messages that include the above plus any detail, hint, or context fields (these might span multiple lines). */
 	rb_define_const(rb_mPGconstants, "PQERRORS_DEFAULT", INT2FIX(PQERRORS_DEFAULT));
-	/* Verbose error verbosity level (#set_error_verbosity) */
+	/* Error verbosity level ( Connection#set_error_verbosity ).
+	 * The VERBOSE mode includes all available fields. */
 	rb_define_const(rb_mPGconstants, "PQERRORS_VERBOSE", INT2FIX(PQERRORS_VERBOSE));
 
+/* PQERRORS_SQLSTATE was introduced in PG-12 together with PQresultMemorySize() */
+#ifdef HAVE_PQRESULTMEMORYSIZE
+	/* Error verbosity level ( Connection#set_error_verbosity ).
+	 * The SQLSTATE mode includes only the error severity and the SQLSTATE error code, if one is available (if not, the output is like TERSE mode).
+	 *
+	 * Available since PostgreSQL-12.
+	 */
+	rb_define_const(rb_mPGconstants, "PQERRORS_SQLSTATE", INT2FIX(PQERRORS_SQLSTATE));
+#endif
+
+#ifdef HAVE_PQRESULTVERBOSEERRORMESSAGE
+	/* See Connection#set_error_context_visibility */
+	rb_define_const(rb_mPGconstants, "PQSHOW_CONTEXT_NEVER", INT2FIX(PQSHOW_CONTEXT_NEVER));
+	/* See Connection#set_error_context_visibility */
+	rb_define_const(rb_mPGconstants, "PQSHOW_CONTEXT_ERRORS", INT2FIX(PQSHOW_CONTEXT_ERRORS));
+	/* See Connection#set_error_context_visibility */
+	rb_define_const(rb_mPGconstants, "PQSHOW_CONTEXT_ALWAYS", INT2FIX(PQSHOW_CONTEXT_ALWAYS));
+#endif
+
 	/******     PG::Connection CLASS CONSTANTS: Check Server Status ******/
 
 	/* Server is accepting connections. */
@@ -471,141 +492,156 @@ Init_pg_ext()
 
 	/******     PG::Connection CLASS CONSTANTS: Large Objects     ******/
 
-	/* Flag for #lo_creat, #lo_open -- open for writing */
+	/* Flag for Connection#lo_creat, Connection#lo_open -- open for writing */
 	rb_define_const(rb_mPGconstants, "INV_WRITE", INT2FIX(INV_WRITE));
-	/* Flag for #lo_creat, #lo_open -- open for reading */
+	/* Flag for Connection#lo_creat, Connection#lo_open -- open for reading */
 	rb_define_const(rb_mPGconstants, "INV_READ", INT2FIX(INV_READ));
-	/* Flag for #lo_lseek -- seek from object start */
+	/* Flag for Connection#lo_lseek -- seek from object start */
 	rb_define_const(rb_mPGconstants, "SEEK_SET", INT2FIX(SEEK_SET));
-	/* Flag for #lo_lseek -- seek from current position */
+	/* Flag for Connection#lo_lseek -- seek from current position */
 	rb_define_const(rb_mPGconstants, "SEEK_CUR", INT2FIX(SEEK_CUR));
-	/* Flag for #lo_lseek -- seek from object end */
+	/* Flag for Connection#lo_lseek -- seek from object end */
 	rb_define_const(rb_mPGconstants, "SEEK_END", INT2FIX(SEEK_END));
 
 	/******     PG::Result CONSTANTS: result status      ******/
 
-	/* #result_status constant: The string sent to the server was empty. */
+	/* Result#result_status constant - The string sent to the server was empty. */
 	rb_define_const(rb_mPGconstants, "PGRES_EMPTY_QUERY", INT2FIX(PGRES_EMPTY_QUERY));
-	/* #result_status constant: Successful completion of a command returning no data. */
+	/* Result#result_status constant - Successful completion of a command returning no data. */
 	rb_define_const(rb_mPGconstants, "PGRES_COMMAND_OK", INT2FIX(PGRES_COMMAND_OK));
-		/* #result_status constant: Successful completion of a command returning data
-	   (such as a SELECT or SHOW). */
+	/* Result#result_status constant - Successful completion of a command returning data (such as a SELECT or SHOW). */
 	rb_define_const(rb_mPGconstants, "PGRES_TUPLES_OK", INT2FIX(PGRES_TUPLES_OK));
-	/* #result_status constant: Copy Out (from server) data transfer started. */
+	/* Result#result_status constant - Copy Out (from server) data transfer started. */
 	rb_define_const(rb_mPGconstants, "PGRES_COPY_OUT", INT2FIX(PGRES_COPY_OUT));
-	/* #result_status constant: Copy In (to server) data transfer started. */
+	/* Result#result_status constant - Copy In (to server) data transfer started. */
 	rb_define_const(rb_mPGconstants, "PGRES_COPY_IN", INT2FIX(PGRES_COPY_IN));
-	/* #result_status constant: The server’s response was not understood. */
+	/* Result#result_status constant - The server’s response was not understood. */
 	rb_define_const(rb_mPGconstants, "PGRES_BAD_RESPONSE", INT2FIX(PGRES_BAD_RESPONSE));
-	/* #result_status constant: A nonfatal error (a notice or warning) occurred. */
+	/* Result#result_status constant - A nonfatal error (a notice or warning) occurred. */
 	rb_define_const(rb_mPGconstants, "PGRES_NONFATAL_ERROR",INT2FIX(PGRES_NONFATAL_ERROR));
-	/* #result_status constant: A fatal error occurred. */
+	/* Result#result_status constant - A fatal error occurred. */
 	rb_define_const(rb_mPGconstants, "PGRES_FATAL_ERROR", INT2FIX(PGRES_FATAL_ERROR));
-	/* #result_status constant: Copy In/Out data transfer in progress. */
+	/* Result#result_status constant - Copy In/Out data transfer in progress. */
 	rb_define_const(rb_mPGconstants, "PGRES_COPY_BOTH", INT2FIX(PGRES_COPY_BOTH));
-	/* #result_status constant: Single tuple from larger resultset. */
+	/* Result#result_status constant - Single tuple from larger resultset. */
 	rb_define_const(rb_mPGconstants, "PGRES_SINGLE_TUPLE", INT2FIX(PGRES_SINGLE_TUPLE));
 
 	/******     Result CONSTANTS: result error field codes      ******/
 
-	/* #result_error_field argument constant: The severity; the field contents
-	 * are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE,
-	 * DEBUG, INFO, or LOG (in a notice message), or a localized translation
-	 * of one of these. Always present.
+	/* Result#result_error_field argument constant
+	 *
+	 * The severity; the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message), or a localized translation
+	 * of one of these.
+	 * Always present.
 	 */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_SEVERITY", INT2FIX(PG_DIAG_SEVERITY));
 
-	/* #result_error_field argument constant: The SQLSTATE code for the
-	 * error. The SQLSTATE code identies the type of error that has occurred;
-	 * it can be used by front-end applications to perform specic operations
-	 * (such as er- ror handling) in response to a particular database
-	 * error. For a list of the possible SQLSTATE codes, see Appendix A.
-	 * This eld is not localizable, and is always present.
+#ifdef PG_DIAG_SEVERITY_NONLOCALIZED
+	/* Result#result_error_field argument constant
+	 *
+	 * The severity; the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message).
+	 * This is identical to the PG_DIAG_SEVERITY field except that the contents are never localized.
+	 *
+	 * Available since PostgreSQL-9.6
+	 */
+	rb_define_const(rb_mPGconstants, "PG_DIAG_SEVERITY_NONLOCALIZED", INT2FIX(PG_DIAG_SEVERITY_NONLOCALIZED));
+#endif
+	/* Result#result_error_field argument constant
+	 *
+	 * The SQLSTATE code for the error.
+	 * The SQLSTATE code identies the type of error that has occurred; it can be used by front-end applications to perform specic operations (such as error handling) in response to a particular database error.
+	 * For a list of the possible SQLSTATE codes, see Appendix A.
+	 * This field is not localizable, and is always present.
 	 */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_SQLSTATE", INT2FIX(PG_DIAG_SQLSTATE));
-
-	/* #result_error_field argument constant: The primary human-readable
-	 * error message (typically one line). Always present. */
+	/* Result#result_error_field argument constant
+	 *
+	 * The primary human-readable error message (typically one line).
+	 * Always present. */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_MESSAGE_PRIMARY", INT2FIX(PG_DIAG_MESSAGE_PRIMARY));
-
-	/* #result_error_field argument constant: Detail: an optional secondary
-	 * error message carrying more detail about the problem. Might run to
-	 * multiple lines.
+	/* Result#result_error_field argument constant
+	 *
+	 * Detail: an optional secondary error message carrying more detail about the problem.
+	 * Might run to multiple lines.
 	 */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_MESSAGE_DETAIL", INT2FIX(PG_DIAG_MESSAGE_DETAIL));
-
-	/* #result_error_field argument constant: Hint: an optional suggestion
-	 * what to do about the problem. This is intended to differ from detail
-	 * in that it offers advice (potentially inappropriate) rather than
-	 * hard facts. Might run to multiple lines.
+	/* Result#result_error_field argument constant
+	 *
+	 * Hint: an optional suggestion what to do about the problem.
+	 * This is intended to differ from detail in that it offers advice (potentially inappropriate) rather than hard facts.
+	 * Might run to multiple lines.
 	 */
-
 	rb_define_const(rb_mPGconstants, "PG_DIAG_MESSAGE_HINT", INT2FIX(PG_DIAG_MESSAGE_HINT));
-	/* #result_error_field argument constant: A string containing a decimal
-	 * integer indicating an error cursor position as an index into the
-	 * original statement string. The rst character has index 1, and
-	 * positions are measured in characters not bytes.
+	/* Result#result_error_field argument constant
+	 *
+	 * A string containing a decimal integer indicating an error cursor position as an index into the original statement string.
+	 *
+	 * The first character has index 1, and positions are measured in characters not bytes.
 	 */
-
 	rb_define_const(rb_mPGconstants, "PG_DIAG_STATEMENT_POSITION", INT2FIX(PG_DIAG_STATEMENT_POSITION));
-	/* #result_error_field argument constant: This is dened the same as
-	 * the PG_DIAG_STATEMENT_POSITION eld, but it is used when the cursor
-	 * position refers to an internally generated command rather than the
-	 * one submitted by the client. The PG_DIAG_INTERNAL_QUERY eld will
-	 * always appear when this eld appears.
+	/* Result#result_error_field argument constant
+	 *
+	 * This is defined the same as the PG_DIAG_STATEMENT_POSITION field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client.
+	 * The PG_DIAG_INTERNAL_QUERY field will always appear when this field appears.
 	 */
-
 	rb_define_const(rb_mPGconstants, "PG_DIAG_INTERNAL_POSITION", INT2FIX(PG_DIAG_INTERNAL_POSITION));
-	/* #result_error_field argument constant: The text of a failed
-	 * internally-generated command. This could be, for example, a SQL
-	 * query issued by a PL/pgSQL function.
+	/* Result#result_error_field argument constant
+	 *
+	 * The text of a failed internally-generated command.
+	 * This could be, for example, a SQL query issued by a PL/pgSQL function.
 	 */
-
 	rb_define_const(rb_mPGconstants, "PG_DIAG_INTERNAL_QUERY", INT2FIX(PG_DIAG_INTERNAL_QUERY));
-	/* #result_error_field argument constant: An indication of the context
-	 * in which the error occurred. Presently this includes a call stack
-	 * traceback of active procedural language functions and internally-generated
-	 * queries. The trace is one entry per line, most recent rst.
+	/* Result#result_error_field argument constant
+	 *
+	 * An indication of the context in which the error occurred.
+	 * Presently this includes a call stack traceback of active procedural language functions and internally-generated queries.
+	 * The trace is one entry per line, most recent first.
 	 */
-
 	rb_define_const(rb_mPGconstants, "PG_DIAG_CONTEXT", INT2FIX(PG_DIAG_CONTEXT));
-	/* #result_error_field argument constant: The le name of the source-code
-	 * location where the error was reported. */
+	/* Result#result_error_field argument constant
+	 *
+	 * The file name of the source-code location where the error was reported. */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_SOURCE_FILE", INT2FIX(PG_DIAG_SOURCE_FILE));
 
-	/* #result_error_field argument constant: The line number of the
-	 * source-code location where the error was reported. */
+	/* Result#result_error_field argument constant
+	 *
+	 * The line number of the source-code location where the error was reported. */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_SOURCE_LINE", INT2FIX(PG_DIAG_SOURCE_LINE));
 
-	/* #result_error_field argument constant: The name of the source-code
-	 * function reporting the error. */
+	/* Result#result_error_field argument constant
+	 *
+	 * The name of the source-code function reporting the error. */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_SOURCE_FUNCTION", INT2FIX(PG_DIAG_SOURCE_FUNCTION));
 
-#ifdef HAVE_CONST_PG_DIAG_TABLE_NAME
-	/* #result_error_field argument constant: If the error was associated with a
-	 * specific database object, the name of the schema containing that object, if any. */
+#ifdef PG_DIAG_TABLE_NAME
+	/* Result#result_error_field argument constant
+	 *
+	 * If the error was associated with a specific database object, the name of the schema containing that object, if any. */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_SCHEMA_NAME", INT2FIX(PG_DIAG_SCHEMA_NAME));
 
-	/* #result_error_field argument constant: If the error was associated with a
-	 *specific table, the name of the table. (When this field is present, the schema name
-	 * field provides the name of the table's schema.) */
+	/* Result#result_error_field argument constant
+	 *
+	 * If the error was associated with a specific table, the name of the table.
+	 * (When this field is present, the schema name field provides the name of the table's schema.) */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_TABLE_NAME", INT2FIX(PG_DIAG_TABLE_NAME));
 
-	/* #result_error_field argument constant: If the error was associated with a
-	 * specific table column, the name of the column. (When this field is present, the
-	 * schema and table name fields identify the table.) */
+	/* Result#result_error_field argument constant
+	 *
+	 * If the error was associated with a specific table column, the name of the column.
+	 * (When this field is present, the schema and table name fields identify the table.) */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_COLUMN_NAME", INT2FIX(PG_DIAG_COLUMN_NAME));
 
-	/* #result_error_field argument constant: If the error was associated with a
-	 * specific datatype, the name of the datatype. (When this field is present, the
-	 * schema name field provides the name of the datatype's schema.) */
+	/* Result#result_error_field argument constant
+	 *
+	 * If the error was associated with a specific datatype, the name of the datatype.
+	 * (When this field is present, the schema name field provides the name of the datatype's schema.) */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_DATATYPE_NAME", INT2FIX(PG_DIAG_DATATYPE_NAME));
 
-	/* #result_error_field argument constant: If the error was associated with a
-	 * specific constraint, the name of the constraint. The table or domain that the
-	 * constraint belongs to is reported using the fields listed above. (For this
-	 * purpose, indexes are treated as constraints, even if they weren't created with
-	 * constraint syntax.) */
+	/* Result#result_error_field argument constant
+	 *
+	 * If the error was associated with a specific constraint, the name of the constraint.
+	 * The table or domain that the constraint belongs to is reported using the fields listed above.
+	 * (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.) */
 	rb_define_const(rb_mPGconstants, "PG_DIAG_CONSTRAINT_NAME", INT2FIX(PG_DIAG_CONSTRAINT_NAME));
 #endif
 
@@ -635,6 +671,7 @@ Init_pg_ext()
 	init_pg_binary_encoder();
 	init_pg_binary_decoder();
 	init_pg_copycoder();
+	init_pg_recordcoder();
 	init_pg_tuple();
 }