pg 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7902e6c502c537871cd665a257906b7f769e24cdb70f2e173f3268228f6f518b
-  data.tar.gz: '0862f2212949dd8b92d1eeb728e1b23b5933f1113e4ff5c3cc5710ccf2cbcd14'
+  metadata.gz: 79eb5b70c2045456b11a407f31913f728593cb196090f7bc1e94f012e1e37070
+  data.tar.gz: d6b9f0685a71e45482cb9c776fc8e092e7aa810d6a74364eb809f217a8cd09f1
 SHA512:
-  metadata.gz: dab39fd94372194ae3ec1a56956151408c3e1c94e9105c55c6a5ffa1c745cccd2898cb849c5b9fc45052f5d00f86897ab410f71ac070eadfa49bac47321dcaad
-  data.tar.gz: 3bc5a11924d7af5e2dec61f916f31abc0eef9dc851ce918a5372a5017949ff419eaed33decf781f05629da685238d3e28ba0dc9ebea733608ce316bed0e282ad
+  metadata.gz: 8125aac41396b831d5a1986a80ceee2376c79ebc9ce5607c5739f7285ee0e4069dbd636b98ba51722b251f210c6295199bcd8589af7b77a9816a4156d190fa22
+  data.tar.gz: feed68644345ae49bd4d1f2ce62571ea25ef8c8e7d032552096575a832b67595a84b18de09c6bdb9d007d3a845837ee9a6e031b746aa212d342580ab89bd793b

data/lib/pg/connection.rb

@@ -166,6 +166,14 @@ class PG::Connection
 	#     conn.put_copy_data ['more', 'data', 'to', 'copy']
 	#   end
 	#
+	# Also PG::BinaryEncoder::CopyRow can be used to send data in binary format to the server.
+	# In this case copy_data generates the header and trailer data automatically:
+	#   enco = PG::BinaryEncoder::CopyRow.new
+	#   conn.copy_data "COPY my_table FROM STDIN (FORMAT binary)", enco do
+	#     conn.put_copy_data ['some', 'data', 'to', 'copy']
+	#     conn.put_copy_data ['more', 'data', 'to', 'copy']
+	#   end
+	#
 	# Example with CSV output format:
 	#   conn.copy_data "COPY my_table TO STDOUT CSV" do
 	#     while row=conn.get_copy_data
@@ -187,6 +195,18 @@ class PG::Connection
 	# This receives all rows of +my_table+ as ruby array:
 	#   ["some", "data", "to", "copy"]
 	#   ["more", "data", "to", "copy"]
+	#
+	# Also PG::BinaryDecoder::CopyRow can be used to retrieve data in binary format from the server.
+	# In this case the header and trailer data is processed by the decoder and the remaining +nil+ from get_copy_data is processed by copy_data, so that binary data can be processed equally to text data:
+	#   deco = PG::BinaryDecoder::CopyRow.new
+	#   conn.copy_data "COPY my_table TO STDOUT (FORMAT binary)", deco do
+	#     while row=conn.get_copy_data
+	#       p row
+	#     end
+	#   end
+	# This receives all rows of +my_table+ as ruby array:
+	#   ["some", "data", "to", "copy"]
+	#   ["more", "data", "to", "copy"]
 
 	def copy_data( sql, coder=nil )
 		raise PG::NotInBlockingMode.new("copy_data can not be used in nonblocking mode", connection: self) if nonblocking?
@@ -195,7 +215,7 @@ class PG::Connection
 		case res.result_status
 		when PGRES_COPY_IN
 			begin
-				if res.binary_tuples == 1
+				if coder && res.binary_tuples == 1
 					# Binary file header (11 byte signature, 32 bit flags and 32 bit extension length)
 					put_copy_data(BinarySignature + ("\x00" * 8))
 				end
@@ -219,7 +239,7 @@ class PG::Connection
 				begin
 					self.encoder_for_put_copy_data = old_coder if coder
 
-					if res.binary_tuples == 1
+					if coder && res.binary_tuples == 1
 						put_copy_data("\xFF\xFF") # Binary file trailer 16 bit "-1"
 					end
 
@@ -244,8 +264,9 @@ class PG::Connection
 				discard_results
 				raise
 			else
-				if res.binary_tuples == 1
-					# there are two end markers in binary mode: file trailer and the final nil
+				if coder && res.binary_tuples == 1
+					# There are two end markers in binary mode: file trailer and the final nil.
+					# The file trailer is expected to be processed by BinaryDecoder::CopyRow and already returns nil, so that the remaining NULL from PQgetCopyData is retrieved here:
 					if get_copy_data
 						discard_results
 						raise PG::NotAllCopyDataRetrieved.new("Not all binary COPY data retrieved", connection: self)

data/lib/pg/version.rb

@@ -1,4 +1,4 @@
 module PG
 	# Library version
-	VERSION = '1.5.1'
+	VERSION = '1.5.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   Dzx/gFSOrRoCt2mXNgrmcAfr386AfaMvCh7cXqdxZwmVo7ILZCYXck0pajvubsDd
   NUIIFkVXvd1odFyK9LF1RFAtxn/iAmpx
   -----END CERTIFICATE-----
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies: []
 description: Pg is the Ruby interface to the PostgreSQL RDBMS. It works with PostgreSQL
   9.3 and later.