pg 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40f704970acf17f5fc3514de1e25454441776d1a5ae7b267c791d2bc59bfdb82
-  data.tar.gz: f727c84142cc8d5a576b974c4cbf866e3d69d15004815c088461fef5c1f76190
+  metadata.gz: b98dcd23695bd37aca4e9769e5b55a26ab53b7de01e4b44ff22d1849df08088a
+  data.tar.gz: d9610b8ca74c772db98aff8ff661fa29ea44d8917e0ef48f1e89f9cdfd3158b3
 SHA512:
-  metadata.gz: 2d3df7542a3b3b001709d59b9e75a0ed3bf734db3b3b5cc2fa293278920720a4443fa4e13365926cfca3df08862137bc89f6bc5b13167607c935c1d95f55c848
-  data.tar.gz: fb5d5d62930e3dba1ef983c0201fcd86b2c46eacd920f22372372b34b5e628333d0090d2b10f75f0075eba189df24e964a8cdf27b8bf2ff396d7d9bae7adf5dd
+  metadata.gz: 531c1c61fdb41ea77a8e8e657a536f5734fecc117f7b3a93c04707b7f16a034a841859944e097e75db12ea630ff2679ed90054e0132b96f23ee92c5807d8c07f
+  data.tar.gz: 7d7d8d8c0ff76687d63912d41cf4dea890eb63bf361378b9da075ad1f8ccda9b34353e0de0f462bff5cae2740ee17988c3aef417c92d9b38d3a1b635e6ed19f5

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v1.6.3 [2025-12-29] Lars Kanis <lars@greiz-reinsdorf.de>
+
+Added:
+- Add binary gems for ruby-4.0, now providing ruby-3.0 to 4.0. #682
+- Improve documentation of PG::Result and README. #676
+- Update errorcodes to PostgreSQL-18.
+- Use `rb_hash_new_capa` on Ruby-3.2+ . #674
+- Deny any server communication on a frozen PG::Connection . #677
+- Fix possible race condition in PG::Result in Ractor context. #674
+
+Removed:
+- Drop binary gem support for platform `x86-mingw32`. #682
+- Drop binary gems for ruby-2.7.
+
+
 ## v1.6.2 [2025-09-02] Lars Kanis <lars@greiz-reinsdorf.de>
 
 - Remove several absolute paths from native binaries which pointed to build directories. [#668](https://github.com/ged/ruby-pg/pull/668)

data/Gemfile

@@ -1,7 +1,7 @@
 # -*- ruby -*-
 
-# Specify your gem's runtime dependencies in pg.gemspec
-gemspec
+# No pg gem, since "bundle package" fails on bundler-2.7+, if the extension isn't built
+# gemspec
 
 source "https://rubygems.org/"
 
@@ -11,9 +11,9 @@ group :development do
 end
 
 group :test do
-  gem "bundler", ">= 1.16", "< 3.0"
+  gem "bundler", ">= 1.16", "< 5.0"
   gem "rake-compiler", "~> 1.0"
-  gem "rake-compiler-dock", "~> 1.9.1", git: "https://github.com/rake-compiler/rake-compiler-dock"
+  gem "rake-compiler-dock", "~> 1.11.0" #, git: "https://github.com/rake-compiler/rake-compiler-dock"
   gem "rspec", "~> 3.5"
   # "bigdecimal" is a gem on ruby-3.4+ and it's optional for ruby-pg.
   # Specs should succeed without it, but 4 examples are then excluded.

data/README.md

@@ -1,7 +1,7 @@
 # pg
 
 * home :: https://github.com/ged/ruby-pg
-* docs :: http://deveiate.org/code/pg (English) ,
+* docs :: http://deveiate.org/code/pg/README_md.html (English) ,
           https://deveiate.org/code/pg/README_ja_md.html (Japanese)
 * clog :: link:/CHANGELOG.md
 
@@ -30,6 +30,9 @@ A small example usage:
   end
 ```
 
+See the PG::Connection class for query methods and the PG::Result class for information on working with the results of a query.
+
+
 ## Build Status
 
 [![Build Status Github Actions](https://github.com/ged/ruby-pg/actions/workflows/source-gem.yml/badge.svg?branch=master)](https://github.com/ged/ruby-pg/actions/workflows/source-gem.yml)
@@ -218,8 +221,8 @@ Several type maps can be chained by setting PG::TypeMap::DefaultTypeMappable#def
 
 ## Thread support
 
-PG is thread safe in such a way that different threads can use different PG::Connection objects concurrently.
-However it is not safe to access any Pg objects simultaneously from more than one thread.
+PG is thread safe in such a way that different threads or fibers can use different PG::Connection objects concurrently.
+However it is not safe to access any PG object simultaneously from more than one thread or fiber unless the object is frozen.
 So make sure to open a new database server connection for every new thread or use a wrapper library like ActiveRecord that manages connections in a thread safe way.
 
 If messages like the following are printed to stderr, you're probably using one connection from several threads:

data/Rakefile

@@ -47,7 +47,6 @@ CrossLibrary = Struct.new :platform, :openssl_config, :toolchain
 CrossLibraries = [
 	['aarch64-mingw-ucrt', 'mingwarm64', 'aarch64-w64-mingw32'],
 	['x64-mingw-ucrt', 'mingw64', 'x86_64-w64-mingw32'],
-	['x86-mingw32', 'mingw', 'i686-w64-mingw32'],
 	['x64-mingw32', 'mingw64', 'x86_64-w64-mingw32'],
 	['x86_64-linux', 'linux-x86_64', 'x86_64-linux-gnu'],
 	['x86_64-linux-musl', 'linux-x86_64', 'x86_64-unknown-linux-musl'],
@@ -94,7 +93,7 @@ Rake::ExtensionTask.new do |ext|
 		spec.files << "ports/#{spec.platform.to_s}/lib/libpq-ruby-pg.1.dylib" if spec.platform.to_s =~ /darwin/
 		spec.files << "ports/#{spec.platform.to_s}/lib/libpq.dll" if spec.platform.to_s =~ /mingw|mswin/
 
-		# Binary gems don't postgresql header+lib files
+		# Binary gems don't need postgresql header+lib files
 		spec.metadata.delete("msys2_mingw_dependencies")
 	end
 end
@@ -106,7 +105,8 @@ task 'gem:native:prepare' do
 	# Copy gem signing key and certs to be accessible from the docker container
 	mkdir_p 'build/gem'
 	sh "cp ~/.gem/gem-*.pem build/gem/ || true"
-	sh "bundle package --all"
+	sh "bundle config set cache_all false"
+	sh "bundle package"
 	begin
 		OpenSSL::PKey.read(File.read(File.expand_path("~/.gem/gem-private_key.pem")), ENV["GEM_PRIVATE_KEY_PASSPHRASE"] || "")
 	rescue OpenSSL::PKey::PKeyError
@@ -115,19 +115,6 @@ task 'gem:native:prepare' do
 	end
 end
 
-task 'install_darwin_mig', [:arch] do |t, args|
-	sh <<~EOT
-		rm -rf bootstrap_cmds &&
-		git clone --branch=cross_platform https://github.com/markmentovai/bootstrap_cmds &&
-		cd bootstrap_cmds &&
-		autoreconf --install &&
-		sh configure &&
-		make &&
-		sed -E -i 's/^cppflags=(.*)/cppflags=(\\1 "-D#{args[:arch]}" "-I\\/opt\\/osxcross\\/target\\/SDK\\/MacOSX11.1.sdk\\/usr\\/include")/' migcom.tproj/mig.sh &&
-		sudo make install
-	EOT
-end
-
 CrossLibraries.each do |xlib|
 	platform = xlib.platform
 	desc "Build fat binary gem for platform #{platform}"
@@ -139,9 +126,7 @@ CrossLibraries.each do |xlib|
 			sudo apt-get update && sudo apt-get install -y bison flex &&
 			(cp build/gem/gem-*.pem ~/.gem/ || true) &&
 			bundle install --local &&
-			#{ "rake install_darwin_mig[__arm64__]" if platform =~ /arm64-darwin/ }
-			#{ "rake install_darwin_mig[__x86_64__]" if platform =~ /x86_64-darwin/ }
-			rake native:#{platform} pkg/#{$gem_spec.full_name}-#{platform}.gem MAKEFLAGS="-j`nproc` V=1" RUBY_CC_VERSION=#{RakeCompilerDock.ruby_cc_version("~>2.7", "~>3.0")}
+			rake native:#{platform} pkg/#{$gem_spec.full_name}-#{platform}.gem MAKEFLAGS="-j`nproc` V=1" RUBY_CC_VERSION=#{RakeCompilerDock.ruby_cc_version("~>4.0", "~>3.0")}
 		EOT
 	end
 	desc "Build the native binary gems"
@@ -172,7 +157,8 @@ 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_17_0"
+	# URL_ERRORCODES_TXT = "https://git.postgresql.org/gitweb/?p=postgresql.git;a=blob_plain;f=src/backend/utils/errcodes.txt;hb=refs/tags/REL_18_0"
+	URL_ERRORCODES_TXT = "https://raw.githubusercontent.com/postgres/postgres/refs/tags/REL_18_0/src/backend/utils/errcodes.txt"
 
 	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/ext/errorcodes.def

@@ -87,6 +87,11 @@
   VALUE klass = define_error_class( "StackedDiagnosticsAccessedWithoutActiveHandler", "0Z" );
   register_error_class( "0Z002", klass );
 }
+{
+  VALUE klass = define_error_class( "InvalidArgumentForXquery", NULL );
+  register_error_class( "10608", klass );
+  register_error_class( "10", klass );
+}
 {
   VALUE klass = define_error_class( "CaseNotFound", NULL );
   register_error_class( "20000", klass );
@@ -889,6 +894,10 @@
   VALUE klass = define_error_class( "DuplicateFile", "58" );
   register_error_class( "58P02", klass );
 }
+{
+  VALUE klass = define_error_class( "FileNameTooLong", "58" );
+  register_error_class( "58P03", klass );
+}
 {
   VALUE klass = define_error_class( "ConfigFileError", NULL );
   register_error_class( "F0000", klass );

data/ext/errorcodes.rb

@@ -28,7 +28,7 @@ EOCODE
 			sqlstate, ews, errcode_macro_name = $1, $2, $3
 			next unless ews=='E'
 
-			is_sqlclass = sqlstate[2..-1] == '000'
+			is_sqlclass = sqlstate[2..-1] == '000' || sqlstate == '10608'
 			class_code = sqlstate[0,2]
 			baseclass_code = is_sqlclass ? 'NULL' : class_code.inspect
 			class_name = camelize(errcode_macro_name.sub('ERRCODE_', '').downcase)

data/ext/errorcodes.txt

@@ -2,7 +2,7 @@
 # errcodes.txt
 #      PostgreSQL error codes
 #
-# Copyright (c) 2003-2024, PostgreSQL Global Development Group
+# Copyright (c) 2003-2025, 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
@@ -141,6 +141,12 @@ Section: Class 0Z - Diagnostics Exception
 0Z000    E    ERRCODE_DIAGNOSTICS_EXCEPTION                                  diagnostics_exception
 0Z002    E    ERRCODE_STACKED_DIAGNOSTICS_ACCESSED_WITHOUT_ACTIVE_HANDLER    stacked_diagnostics_accessed_without_active_handler
 
+Section: Class 10 - XQuery Error
+
+# recent SQL versions define quite a few codes in this class, but for now
+# we are only using this generic one
+10608    E    ERRCODE_INVALID_ARGUMENT_FOR_XQUERY                            invalid_argument_for_xquery
+
 Section: Class 20 - Case Not Found
 
 20000    E    ERRCODE_CASE_NOT_FOUND                                         case_not_found
@@ -439,6 +445,7 @@ Section: Class 58 - System Error (errors external to PostgreSQL itself)
 58030    E    ERRCODE_IO_ERROR                                               io_error
 58P01    E    ERRCODE_UNDEFINED_FILE                                         undefined_file
 58P02    E    ERRCODE_DUPLICATE_FILE                                         duplicate_file
+58P03    E    ERRCODE_FILE_NAME_TOO_LONG                                     file_name_too_long
 
 Section: Class F0 - Configuration File Error
 

data/ext/extconf.rb

@@ -27,13 +27,13 @@ if gem_platform=with_config("cross-build")
 	gem 'mini_portile2', '~>2.1'
 	require 'mini_portile2'
 
-	OPENSSL_VERSION = ENV['OPENSSL_VERSION'] || '3.5.2'
+	OPENSSL_VERSION = ENV['OPENSSL_VERSION'] || '3.6.0'
 	OPENSSL_SOURCE_URI = "http://www.openssl.org/source/openssl-#{OPENSSL_VERSION}.tar.gz"
 
 	KRB5_VERSION = ENV['KRB5_VERSION'] || '1.22.1'
 	KRB5_SOURCE_URI = "http://kerberos.org/dist/krb5/#{KRB5_VERSION[/^(\d+\.\d+)/]}/krb5-#{KRB5_VERSION}.tar.gz"
 
-	POSTGRESQL_VERSION = ENV['POSTGRESQL_VERSION'] || '17.6'
+	POSTGRESQL_VERSION = ENV['POSTGRESQL_VERSION'] || '18.1'
 	POSTGRESQL_SOURCE_URI = "http://ftp.postgresql.org/pub/source/v#{POSTGRESQL_VERSION}/postgresql-#{POSTGRESQL_VERSION}.tar.bz2"
 
 	class BuildRecipe < MiniPortile
@@ -319,6 +319,7 @@ have_func 'PQsetChunkedRowsMode', 'libpq-fe.h' # since PostgreSQL-17
 have_func 'timegm'
 have_func 'rb_io_wait' # since ruby-3.0
 have_func 'rb_io_descriptor' # since ruby-3.1
+have_func 'rb_hash_new_capa' # since ruby-3.2
 
 have_header 'inttypes.h'
 have_header('ruby/fiber/scheduler.h') if RUBY_PLATFORM=~/mingw|mswin/

data/ext/pg.h

@@ -76,6 +76,10 @@ typedef long suseconds_t;
 	#define PG_MAX_COLUMNS 4000
 #endif
 
+#ifndef HAVE_RB_HASH_NEW_CAPA
+#define rb_hash_new_capa(x) rb_hash_new()
+#endif
+
 #define pg_gc_location(x) x = rb_gc_location(x)
 
 /* For compatibility with ruby < 3.0 */
@@ -157,10 +161,8 @@ typedef struct {
 	/* Size of PGresult as published to ruby memory management. */
 	ssize_t result_size;
 
-	/* Prefilled tuple Hash with fnames[] as keys. */
-	VALUE tuple_hash;
-
-	/* Hash with fnames[] to field number mapping. */
+	/* Hash with fnames[] to field number mapping.
+	 * Init on-demand to create PG::Tuple objects, otherwise Qnil. */
 	VALUE field_map;
 
 	/* List of field names as frozen String or Symbol objects.

data/ext/pg_connection.c

@@ -66,6 +66,7 @@ pg_get_connection_safe( VALUE self )
 	t_pg_connection *this;
 	TypedData_Get_Struct( self, t_pg_connection, &pg_connection_type, this);
 
+	rb_check_frozen(self);
 	if ( !this->pgconn )
 		pg_raise_conn_error( rb_eConnectionBad, self, "connection is closed");
 
@@ -2382,7 +2383,7 @@ pgconn_notifies(VALUE self)
 		return Qnil;
 	}
 
-	hash = rb_hash_new();
+	hash = rb_hash_new_capa(3);
 	relname = rb_str_new2(notification->relname);
 	be_pid = INT2NUM(notification->be_pid);
 	extra = rb_str_new2(notification->extra);
@@ -4425,9 +4426,11 @@ pgconn_set_default_encoding( VALUE self )
  *    res.type_map_for_queries = typemap
  *
  * Set the default TypeMap that is used for type casts of query bind parameters.
+ * It can be overwritten per +type_map+ parameter of #exec_params and siblings.
  *
  * +typemap+ must be a kind of PG::TypeMap .
  *
+ * See also #type_map_for_queries
  */
 static VALUE
 pgconn_type_map_for_queries_set(VALUE self, VALUE typemap)
@@ -4452,6 +4455,9 @@ pgconn_type_map_for_queries_set(VALUE self, VALUE typemap)
  * Returns the default TypeMap that is currently set for type casts of query
  * bind parameters.
  *
+ * Default is PG::TypeMapAllStrings .
+ *
+ * See also #type_map_for_queries=
  */
 static VALUE
 pgconn_type_map_for_queries_get(VALUE self)
@@ -4466,9 +4472,11 @@ pgconn_type_map_for_queries_get(VALUE self)
  *    res.type_map_for_results = typemap
  *
  * Set the default TypeMap that is used for type casts of result values.
+ * It can be overwritten per PG::Result#type_map= .
  *
  * +typemap+ must be a kind of PG::TypeMap .
  *
+ * See also #type_map_for_results
  */
 static VALUE
 pgconn_type_map_for_results_set(VALUE self, VALUE typemap)
@@ -4490,6 +4498,9 @@ pgconn_type_map_for_results_set(VALUE self, VALUE typemap)
  *
  * Returns the default TypeMap that is currently set for type casts of result values.
  *
+ * Default is PG::TypeMapAllStrings .
+ *
+ * See also #type_map_for_results=
  */
 static VALUE
 pgconn_type_map_for_results_get(VALUE self)
@@ -4506,11 +4517,13 @@ pgconn_type_map_for_results_get(VALUE self)
  *
  * Set the default coder that is used for type casting of parameters
  * to #put_copy_data .
+ * It can be overwritten per +encoder+ parameter of #put_copy_data and +coder+ parameter of #copy_data.
  *
  * +encoder+ can be:
  * * a kind of PG::Coder
  * * +nil+ - disable type encoding, data must be a String.
  *
+ * See also #encoder_for_put_copy_data
  */
 static VALUE
 pgconn_encoder_for_put_copy_data_set(VALUE self, VALUE encoder)
@@ -4540,6 +4553,8 @@ pgconn_encoder_for_put_copy_data_set(VALUE self, VALUE encoder)
  * * a kind of PG::Coder
  * * +nil+ - type encoding is disabled, data must be a String.
  *
+ * Default is +nil+ .
+ * See also #encoder_for_put_copy_data=
  */
 static VALUE
 pgconn_encoder_for_put_copy_data_get(VALUE self)
@@ -4555,11 +4570,13 @@ pgconn_encoder_for_put_copy_data_get(VALUE self)
  *
  * Set the default coder that is used for type casting of received data
  * by #get_copy_data .
+ * It can be overwritten per +decoder+ parameter of #get_copy_data and +coder+ parameter of #copy_data.
  *
  * +decoder+ can be:
  * * a kind of PG::Coder
  * * +nil+ - disable type decoding, returned data will be a String.
  *
+ * See also #decoder_for_get_copy_data
  */
 static VALUE
 pgconn_decoder_for_get_copy_data_set(VALUE self, VALUE decoder)
@@ -4589,6 +4606,9 @@ pgconn_decoder_for_get_copy_data_set(VALUE self, VALUE decoder)
  * * a kind of PG::Coder
  * * +nil+ - type encoding is disabled, returned data will be a String.
  *
+ * Default is +nil+ .
+ *
+ * See also #decoder_for_get_copy_data=
  */
 static VALUE
 pgconn_decoder_for_get_copy_data_get(VALUE self)
@@ -4611,7 +4631,7 @@ pgconn_decoder_for_get_copy_data_get(VALUE self)
  *
  * Settings the type of field names affects only future results.
  *
- * See further description at PG::Result#field_name_type=
+ * See further description at PG::Result#field_name_type= and #field_name_type .
  *
  */
 static VALUE

data/ext/pg_result.c

@@ -12,6 +12,7 @@ static VALUE sym_symbol, sym_string, sym_static_symbol;
 static VALUE pgresult_type_map_set( VALUE, VALUE );
 static t_pg_result *pgresult_get_this( VALUE );
 static t_pg_result *pgresult_get_this_safe( VALUE );
+static void ensure_init_for_tuple(VALUE self);
 
 #if defined(HAVE_PQRESULTMEMORYSIZE)
 
@@ -114,7 +115,6 @@ pgresult_gc_mark( void *_this )
 
 	rb_gc_mark_movable( this->connection );
 	rb_gc_mark_movable( this->typemap );
-	rb_gc_mark_movable( this->tuple_hash );
 	rb_gc_mark_movable( this->field_map );
 
 	for( i=0; i < this->nfields; i++ ){
@@ -130,7 +130,6 @@ pgresult_gc_compact( void *_this )
 
 	pg_gc_location( this->connection );
 	pg_gc_location( this->typemap );
-	pg_gc_location( this->tuple_hash );
 	pg_gc_location( this->field_map );
 
 	for( i=0; i < this->nfields; i++ ){
@@ -212,7 +211,6 @@ pg_new_result2(PGresult *result, VALUE rb_pgconn)
 	this->typemap = pg_typemap_all_strings;
 	this->p_typemap = RTYPEDDATA_DATA( this->typemap );
 	this->nfields = -1;
-	this->tuple_hash = Qnil;
 	this->field_map = Qnil;
 	this->flags = 0;
 	self = TypedData_Wrap_Struct(rb_cPGresult, &pgresult_type, this);
@@ -396,6 +394,7 @@ pg_result_freeze(VALUE self)
 {
 	t_pg_result *this = pgresult_get_this(self);
 
+	ensure_init_for_tuple(self);
 	RB_OBJ_WRITE(self, &this->connection, Qnil);
 	return rb_call_super(0, NULL);
 }
@@ -513,20 +512,46 @@ static void pgresult_init_fnames(VALUE self)
  *
  * The class to represent the query result tuples (rows).
  * An instance of this class is created as the result of every query.
- * All result rows and columns are stored in a memory block attached to the PG::Result object.
- * Whenever a value is accessed it is casted to a Ruby object by the assigned #type_map .
+ * All result rows and columns are stored in an immutable memory block attached to the PG::Result object unless streaming is used.
  *
- * Since pg-1.1 the amount of memory in use by a PG::Result object is estimated and passed to ruby's garbage collector.
- * You can invoke the #clear method to force deallocation of memory of the instance when finished with the result for better memory performance.
- *
- * Example:
+ * A PG::Result has various ways to retrieve the result data:
  *    require 'pg'
- *    conn = PG.connect(:dbname => 'test')
- *    res  = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
- *    res.getvalue(0,0) # '1'
- *    res[0]['b']       # '2'
- *    res[0]['c']       # nil
+ *    conn = PG.connect(dbname: 'test')
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.num_fields       # 3
+ *    res.num_tuples       # 1
+ *    res.fname(2)         # "c"
+ *    res.fields           # ["a", "b", "c"]
+ *    res.getvalue(0,0)    # '1'
+ *    res[0]               # {"a" => "1", "b" => "2", "c" => "3"}
+ *    res.tuple_values(0)  # ["1", "2", nil]
+ *    res.tuple(0)         # #<PG::Tuple a: "1", b: "2", c: nil>
+ *    res.values           # [["1", "2", nil]]
+ *    res.field_values(:a) # ["1"]
+ *    res.column_values(1) # ["2"]
+ *    res.each.first       # {"a" => "1", "b" => "2", "c" => nil}
+ *    res.each_row.first   # ["1", "2", nil]
+ *
+ * Whenever a value is accessed it is casted to a Ruby object by the assigned #type_map which is PG::TypeMapAllStrings by default.
+ * Similarly field names can be retrieved either as strings (default) or as symbols which can be switched per #field_name_type= .
+ *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.type_map = PG::TypeMapByColumn.new([PG::TextDecoder::Integer.new]*3)
+ *    res.field_name_type = :symbol
+ *    res.fname(2)         # :c
+ *    res.fields           # [:a, :b, :c]
+ *    res.getvalue(0,0)    # 1
+ *    res[0]               # {a: 1, b: 2, c: nil}
+ *    res.tuple_values(0)  # [1, 2, nil]
+ *    res.tuple(0)         # #<PG::Tuple a: 1, b: 2, c: nil>
+ *    res.values           # [[1, 2, nil]]
+ *    res.field_values(:a) # [1]
+ *    res.column_values(1) # [2]
+ *    res.each.first       # {a: 1, b: 2, c: nil}
+ *    res.each_row.first   # [1, 2, nil]
  *
+ * Since pg-1.1 the amount of memory in use by a PG::Result object is estimated and passed to ruby's garbage collector.
+ * You can invoke the #clear method to force deallocation of memory of the instance when finished with the result for better memory performance.
  */
 
 /**************************************************************************
@@ -705,6 +730,10 @@ pgresult_error_field(VALUE self, VALUE field)
  *    res.ntuples() -> Integer
  *
  * Returns the number of tuples in the query result.
+ *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.ntuples          # 1
+ *    res.num_tuples       # 1
  */
 static VALUE
 pgresult_ntuples(VALUE self)
@@ -723,6 +752,9 @@ pgresult_ntuples_for_enum(VALUE self, VALUE args, VALUE eobj)
  *    res.nfields() -> Integer
  *
  * Returns the number of columns in the query result.
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.nfields          # 3
+ *    res.num_fields       # 3
  */
 static VALUE
 pgresult_nfields(VALUE self)
@@ -752,6 +784,8 @@ pgresult_binary_tuples(VALUE self)
  * Returns the name of the column corresponding to _index_.
  * Depending on #field_name_type= it's a String or Symbol.
  *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.fname(2)       # "c"
  */
 static VALUE
 pgresult_fname(VALUE self, VALUE index)
@@ -1122,6 +1156,9 @@ pgresult_oid_value(VALUE self)
  *    res[ n ] -> Hash
  *
  * Returns tuple _n_ as a hash.
+ *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res[0]               # {"a" => "1", "b" => "2", "c" => "3"}
  */
 static VALUE
 pgresult_aref(VALUE self, VALUE index)
@@ -1138,16 +1175,11 @@ pgresult_aref(VALUE self, VALUE index)
 	if ( tuple_num < 0 || tuple_num >= num_tuples )
 		rb_raise( rb_eIndexError, "Index %d is out of range", tuple_num );
 
-	/* We reuse the Hash of the previous output for larger row counts.
-	 * This is somewhat faster than populating an empty Hash object. */
-	tuple = NIL_P(this->tuple_hash) ? rb_hash_new() : this->tuple_hash;
+	tuple = rb_hash_new_capa(this->nfields);
 	for ( field_num = 0; field_num < this->nfields; field_num++ ) {
 		VALUE val = this->p_typemap->funcs.typecast_result_value(this->p_typemap, self, tuple_num, field_num);
 		rb_hash_aset( tuple, this->fnames[field_num], val );
 	}
-	/* Store a copy of the filled hash for use at the next row. */
-	if( num_tuples > 10 )
-		RB_OBJ_WRITE(self, &this->tuple_hash, rb_hash_dup(tuple));
 
 	return tuple;
 }
@@ -1156,7 +1188,10 @@ pgresult_aref(VALUE self, VALUE index)
  * call-seq:
  *    res.each_row { |row| ... }
  *
- * Yields each row of the result. The row is a list of column values.
+ * Yields an Array object for each row in the result.
+ *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.each_row.first   # ["1", "2", nil]
  */
 static VALUE
 pgresult_each_row(VALUE self)
@@ -1191,6 +1226,9 @@ pgresult_each_row(VALUE self)
  *    res.values -> Array
  *
  * Returns all tuples as an array of arrays.
+ *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.values           # [["1", "2", nil]]
  */
 static VALUE
 pgresult_values(VALUE self)
@@ -1240,12 +1278,13 @@ make_column_result_array( VALUE self, int col )
 
 
 /*
- *  call-seq:
- *     res.column_values( n )   -> array
+ * call-seq:
+ *    res.column_values( n )   -> array
  *
- *  Returns an Array of the values from the nth column of each
- *  tuple in the result.
+ * Returns an Array of the values from the nth column of each tuple in the result.
  *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.column_values(1) # ["2"]
  */
 static VALUE
 pgresult_column_values(VALUE self, VALUE index)
@@ -1256,11 +1295,13 @@ pgresult_column_values(VALUE self, VALUE index)
 
 
 /*
- *  call-seq:
+ * call-seq:
  *     res.field_values( field )   -> array
  *
- *  Returns an Array of the values from the given _field_ of each tuple in the result.
+ * Returns an Array of the values from the given _field_ of each tuple in the result.
  *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.field_values(:a) # ["1"]
  */
 static VALUE
 pgresult_field_values( VALUE self, VALUE field )
@@ -1281,11 +1322,13 @@ pgresult_field_values( VALUE self, VALUE field )
 
 
 /*
- *  call-seq:
- *     res.tuple_values( n )   -> array
+ * call-seq:
+ *    res.tuple_values( n )   -> array
  *
- *  Returns an Array of the field values from the nth row of the result.
+ * Returns an Array of the field values from the nth row of the result.
  *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.tuple_values(0)  # ["1", "2", nil]
  */
 static VALUE
 pgresult_tuple_values(VALUE self, VALUE index)
@@ -1320,11 +1363,12 @@ static void ensure_init_for_tuple(VALUE self)
 
 	if( this->field_map == Qnil ){
 		int i;
-		VALUE field_map = rb_hash_new();
+		VALUE field_map;
 
 		if( this->nfields == -1 )
 			pgresult_init_fnames( self );
 
+		field_map = rb_hash_new_capa(this->nfields);
 		for( i = 0; i < this->nfields; i++ ){
 			rb_hash_aset(field_map, this->fnames[i], INT2FIX(i));
 		}
@@ -1334,11 +1378,13 @@ static void ensure_init_for_tuple(VALUE self)
 }
 
 /*
- *  call-seq:
- *     res.tuple( n )   -> PG::Tuple
+ * call-seq:
+ *    res.tuple( n )   -> PG::Tuple
  *
- *  Returns a PG::Tuple from the nth row of the result.
+ * Returns a PG::Tuple from the nth row of the result.
  *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.tuple(0)         # #<PG::Tuple a: "1", b: "2", c: nil>
  */
 static VALUE
 pgresult_tuple(VALUE self, VALUE index)
@@ -1363,7 +1409,10 @@ pgresult_tuple(VALUE self, VALUE index)
  * call-seq:
  *    res.each{ |tuple| ... }
  *
- * Invokes block for each tuple in the result set.
+ * Yields a Hash object for each row in the result.
+ *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.each.first       # {"a" => "1", "b" => "2", "c" => nil}
  */
 static VALUE
 pgresult_each(VALUE self)
@@ -1386,6 +1435,9 @@ pgresult_each(VALUE self)
  *    res.fields() -> Array
  *
  * Depending on #field_name_type= returns an array of strings or symbols representing the names of the fields in the result.
+ *
+ *    res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
+ *    res.fields           # ["a", "b", "c"]
  */
 static VALUE
 pgresult_fields(VALUE self)
@@ -1410,6 +1462,7 @@ pgresult_fields(VALUE self)
  *
  * +typemap+ must be a kind of PG::TypeMap .
  *
+ * See also #map_types! and PG::BasicTypeMapForResults
  */
 static VALUE
 pgresult_type_map_set(VALUE self, VALUE typemap)
@@ -1433,6 +1486,7 @@ pgresult_type_map_set(VALUE self, VALUE typemap)
  *    res.type_map -> value
  *
  * Returns the PG::TypeMap that is currently set for type casts of result values to ruby objects.
+ * The default is retrieved from PG::Connection#type_map_for_results , which defaults to PG::TypeMapAllStrings .
  *
  */
 static VALUE

data/ext/pg_tuple.c

@@ -510,7 +510,7 @@ pg_tuple_load(VALUE self, VALUE a)
 	if (RARRAY_LENINT(field_names) != num_fields)
 		rb_raise(rb_eTypeError, "different number of fields and values");
 
-	field_map = rb_hash_new();
+	field_map = rb_hash_new_capa(num_fields);
 	for( i = 0; i < num_fields; i++ ){
 		rb_hash_aset(field_map, RARRAY_AREF(field_names, i), INT2FIX(i));
 	}

data/lib/pg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module PG
 	# Library version
-	VERSION = '1.6.2'
+	VERSION = '1.6.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Michael Granger
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEBDCCAmygAwIBAgIBAzANBgkqhkiG9w0BAQsFADAoMSYwJAYDVQQDDB1sYXJz
-  L0RDPWdyZWl6LXJlaW5zZG9yZi9EQz1kZTAeFw0yNDEyMjkxOTU2NTZaFw0yNTEy
-  MjkxOTU2NTZaMCgxJjAkBgNVBAMMHWxhcnMvREM9Z3JlaXotcmVpbnNkb3JmL0RD
+  MIIEBDCCAmygAwIBAgIBBDANBgkqhkiG9w0BAQsFADAoMSYwJAYDVQQDDB1sYXJz
+  L0RDPWdyZWl6LXJlaW5zZG9yZi9EQz1kZTAeFw0yNTEyMjkyMDMyMzFaFw0yNjEy
+  MjkyMDMyMzFaMCgxJjAkBgNVBAMMHWxhcnMvREM9Z3JlaXotcmVpbnNkb3JmL0RD
   PWRlMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAwum6Y1KznfpzXOT/
   mZgJTBbxZuuZF49Fq3K0WA67YBzNlDv95qzSp7V/7Ek3NCcnT7G+2kSuhNo1FhdN
   eSDO/moYebZNAcu3iqLsuzuULXPLuoU0GsMnVMqV9DZPh7cQHE5EBZ7hlzDBK7k/
@@ -23,15 +23,15 @@ cert_chain:
   chQPnWX+N3Gj+jjYxqTFdwT7Mj3pv1VHa+aNUbqSPpvJeDyxRIuo9hvzDaBHb/Cg
   9qRVcm8a96n4t7y2lrX1oookY6bkBaxWOMtWlqIprq8JZXM9AgMBAAGjOTA3MAkG
   A1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQ4h1tIyvdUWtMI739xMzTR
-  7EfMFzANBgkqhkiG9w0BAQsFAAOCAYEAoZZWzNV2XXaoSmvyamSSN+Wt/Ia+DNrU
-  2pc3kMEqykH6l1WiVPszr6HavQ//2I2UcSRSS5AGDdiSXcfyFmHtMBdtJHhTPcn7
-  4DLliB0szpvwG+ltGD8PI8eWkLaTQeFzs+0QCTavgKV+Zw56Q0J5zZvHHUMrLkUD
-  qhwKjdTdkrRTn9Sqi0BrIRRZGTUDdrt8qoWm35aES5arKZzytgrRD/kXfFW2LCg0
-  FzgTKibR4/3g8ph94kQLg/D2SMlVPkQ3ECi036mZxDC2n8V6u3rDkG5923wmrRZB
-  J6cqz475Q8HYORQCB68OPzkWMfC7mBo3vpSsIqRoNs1FE4FJu4FGwZG8fBSrDC4H
-  bZe+GtyS3e2SMjgT65zp35gLO9I7MquzYN9P6V2u1iBpTycchk5z9R1ghxzZSBT8
-  DrkJ9tVlPQtJB0LqT0tvBap4upnwT1xYq721b5dwH6AF4Pi6iz/dc5vnq1/MH8bV
-  8VbbBzzeE7MsvgkP3sHlLmY8PtuyViJ8
+  7EfMFzANBgkqhkiG9w0BAQsFAAOCAYEAUVIier9xybHmXNsj801xD+Q7Jz7wpRsf
+  fMHpV2sAzvYcAa7pn+mbu9nf7RUhe5hiaUv88Usk9nRUYYrjBOO5RuD+wYNowpcE
+  kxUiTAP/fgUBdW6hYUJy57CH3xUD6tj1Cg9hxdKy7jItZXbfhX+qPq2BwGaXz7gn
+  nhrALITRmpuPnlsccM94dgSArCInSo2SEc12h2oB6FAnFG1Lre3dmQamI5q1EKp0
+  Yafb2+cPbFcVYUdE50wf+cdeGDOsCGlAmo2OGqXWxTP2hIfyhsFoamD6UGufLoPG
+  Dh6tAEZIuEvLjq93qoNceUQn+xxiiIszjY5mkTu9rVY+/gh5PJzu9IHvyIqBpb2o
+  fdWDISWK+KSLCrqkFtKoliLDTZau73GcYCVOkjca+3cxqABKZ+M8r42Sq8JPxPiv
+  KyLQBzqPeLN9qRDD1bEFHIcgwdY/zQTs4mWRBSmBWa7w+k8nP8aSV1dN/fvhYwY3
+  HCQwtPaMYOznIOcc8shL4zLJpcl8uCqE
   -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
@@ -197,8 +197,8 @@ files:
 - ports/patches/krb5/1.22.1/0001-Allow-static-linking-krb5-library.patch
 - ports/patches/krb5/1.22.1/0002-unknown-command-line-option-on-clang.patch
 - ports/patches/openssl/3.5.2/0001-aarch64-mingw.patch
-- ports/patches/postgresql/17.6/0001-Use-workaround-of-__builtin_setjmp-only-on-MINGW-on-.patch
-- ports/patches/postgresql/17.6/0001-libpq-Process-buffered-SSL-read-bytes-to-support-rec.patch
+- ports/patches/postgresql/18.1/0001-Use-workaround-of-__builtin_setjmp-only-on-MINGW-on-.patch
+- ports/patches/postgresql/18.1/0001-libpq-Process-buffered-SSL-read-bytes-to-support-rec.patch
 - rakelib/pg_gem_helper.rb
 - rakelib/task_extension.rb
 - sample/array_insert.rb