pg 1.0.0 → 1.5.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/Gemfile +20 -0
  4. data/History.md +932 -0
  5. data/Manifest.txt +8 -3
  6. data/README-Windows.rdoc +4 -4
  7. data/README.ja.md +300 -0
  8. data/README.md +286 -0
  9. data/Rakefile +41 -138
  10. data/Rakefile.cross +71 -66
  11. data/certs/ged.pem +24 -0
  12. data/certs/kanis@comcard.de.pem +20 -0
  13. data/certs/larskanis-2022.pem +26 -0
  14. data/certs/larskanis-2023.pem +24 -0
  15. data/certs/larskanis-2024.pem +24 -0
  16. data/ext/errorcodes.def +84 -5
  17. data/ext/errorcodes.rb +1 -1
  18. data/ext/errorcodes.txt +23 -6
  19. data/ext/extconf.rb +109 -25
  20. data/ext/gvl_wrappers.c +4 -0
  21. data/ext/gvl_wrappers.h +23 -0
  22. data/ext/pg.c +213 -155
  23. data/ext/pg.h +89 -23
  24. data/ext/pg_binary_decoder.c +164 -16
  25. data/ext/pg_binary_encoder.c +238 -13
  26. data/ext/pg_coder.c +159 -35
  27. data/ext/pg_connection.c +1584 -967
  28. data/ext/pg_copy_coder.c +373 -43
  29. data/ext/pg_errors.c +1 -1
  30. data/ext/pg_record_coder.c +522 -0
  31. data/ext/pg_result.c +710 -217
  32. data/ext/pg_text_decoder.c +630 -43
  33. data/ext/pg_text_encoder.c +222 -72
  34. data/ext/pg_tuple.c +572 -0
  35. data/ext/pg_type_map.c +45 -11
  36. data/ext/pg_type_map_all_strings.c +21 -7
  37. data/ext/pg_type_map_by_class.c +59 -27
  38. data/ext/pg_type_map_by_column.c +80 -37
  39. data/ext/pg_type_map_by_mri_type.c +49 -20
  40. data/ext/pg_type_map_by_oid.c +62 -29
  41. data/ext/pg_type_map_in_ruby.c +56 -22
  42. data/ext/{util.c → pg_util.c} +12 -12
  43. data/ext/{util.h → pg_util.h} +2 -2
  44. data/lib/pg/basic_type_map_based_on_result.rb +67 -0
  45. data/lib/pg/basic_type_map_for_queries.rb +202 -0
  46. data/lib/pg/basic_type_map_for_results.rb +104 -0
  47. data/lib/pg/basic_type_registry.rb +311 -0
  48. data/lib/pg/binary_decoder/date.rb +9 -0
  49. data/lib/pg/binary_decoder/timestamp.rb +26 -0
  50. data/lib/pg/binary_encoder/timestamp.rb +20 -0
  51. data/lib/pg/coder.rb +36 -13
  52. data/lib/pg/connection.rb +769 -70
  53. data/lib/pg/exceptions.rb +22 -2
  54. data/lib/pg/result.rb +14 -2
  55. data/lib/pg/text_decoder/date.rb +21 -0
  56. data/lib/pg/text_decoder/inet.rb +9 -0
  57. data/lib/pg/text_decoder/json.rb +17 -0
  58. data/lib/pg/text_decoder/numeric.rb +9 -0
  59. data/lib/pg/text_decoder/timestamp.rb +30 -0
  60. data/lib/pg/text_encoder/date.rb +13 -0
  61. data/lib/pg/text_encoder/inet.rb +31 -0
  62. data/lib/pg/text_encoder/json.rb +17 -0
  63. data/lib/pg/text_encoder/numeric.rb +9 -0
  64. data/lib/pg/text_encoder/timestamp.rb +24 -0
  65. data/lib/pg/tuple.rb +30 -0
  66. data/lib/pg/type_map_by_column.rb +3 -2
  67. data/lib/pg/version.rb +4 -0
  68. data/lib/pg.rb +106 -39
  69. data/misc/openssl-pg-segfault.rb +31 -0
  70. data/misc/postgres/History.txt +9 -0
  71. data/misc/postgres/Manifest.txt +5 -0
  72. data/misc/postgres/README.txt +21 -0
  73. data/misc/postgres/Rakefile +21 -0
  74. data/misc/postgres/lib/postgres.rb +16 -0
  75. data/misc/ruby-pg/History.txt +9 -0
  76. data/misc/ruby-pg/Manifest.txt +5 -0
  77. data/misc/ruby-pg/README.txt +21 -0
  78. data/misc/ruby-pg/Rakefile +21 -0
  79. data/misc/ruby-pg/lib/ruby/pg.rb +16 -0
  80. data/pg.gemspec +36 -0
  81. data/rakelib/task_extension.rb +46 -0
  82. data/sample/array_insert.rb +20 -0
  83. data/sample/async_api.rb +102 -0
  84. data/sample/async_copyto.rb +39 -0
  85. data/sample/async_mixed.rb +56 -0
  86. data/sample/check_conn.rb +21 -0
  87. data/sample/copydata.rb +71 -0
  88. data/sample/copyfrom.rb +81 -0
  89. data/sample/copyto.rb +19 -0
  90. data/sample/cursor.rb +21 -0
  91. data/sample/disk_usage_report.rb +177 -0
  92. data/sample/issue-119.rb +94 -0
  93. data/sample/losample.rb +69 -0
  94. data/sample/minimal-testcase.rb +17 -0
  95. data/sample/notify_wait.rb +72 -0
  96. data/sample/pg_statistics.rb +285 -0
  97. data/sample/replication_monitor.rb +222 -0
  98. data/sample/test_binary_values.rb +33 -0
  99. data/sample/wal_shipper.rb +434 -0
  100. data/sample/warehouse_partitions.rb +311 -0
  101. data.tar.gz.sig +0 -0
  102. metadata +138 -223
  103. metadata.gz.sig +0 -0
  104. data/.gemtest +0 -0
  105. data/ChangeLog +0 -6595
  106. data/History.rdoc +0 -422
  107. data/README.ja.rdoc +0 -14
  108. data/README.rdoc +0 -167
  109. data/lib/pg/basic_type_mapping.rb +0 -426
  110. data/lib/pg/constants.rb +0 -11
  111. data/lib/pg/text_decoder.rb +0 -51
  112. data/lib/pg/text_encoder.rb +0 -35
  113. data/spec/data/expected_trace.out +0 -26
  114. data/spec/data/random_binary_data +0 -0
  115. data/spec/helpers.rb +0 -348
  116. data/spec/pg/basic_type_mapping_spec.rb +0 -305
  117. data/spec/pg/connection_spec.rb +0 -1719
  118. data/spec/pg/result_spec.rb +0 -456
  119. data/spec/pg/type_map_by_class_spec.rb +0 -138
  120. data/spec/pg/type_map_by_column_spec.rb +0 -222
  121. data/spec/pg/type_map_by_mri_type_spec.rb +0 -136
  122. data/spec/pg/type_map_by_oid_spec.rb +0 -149
  123. data/spec/pg/type_map_in_ruby_spec.rb +0 -164
  124. data/spec/pg/type_map_spec.rb +0 -22
  125. data/spec/pg/type_spec.rb +0 -777
  126. data/spec/pg_spec.rb +0 -50
data/ext/pg_copy_coder.c CHANGED
@@ -4,6 +4,7 @@
4
4
  */
5
5
 
6
6
  #include "pg.h"
7
+ #include "pg_util.h"
7
8
 
8
9
  #define ISOCTAL(c) (((c) >= '0') && ((c) <= '7'))
9
10
  #define OCTVALUE(c) ((c) - '0')
@@ -21,21 +22,51 @@ typedef struct {
21
22
 
22
23
 
23
24
  static void
24
- pg_copycoder_mark( t_pg_copycoder *this )
25
+ pg_copycoder_mark( void *_this )
25
26
  {
26
- rb_gc_mark(this->typemap);
27
- rb_gc_mark(this->null_string);
27
+ t_pg_copycoder *this = (t_pg_copycoder *)_this;
28
+ rb_gc_mark_movable(this->typemap);
29
+ rb_gc_mark_movable(this->null_string);
28
30
  }
29
31
 
32
+ static size_t
33
+ pg_copycoder_memsize( const void *_this )
34
+ {
35
+ const t_pg_copycoder *this = (const t_pg_copycoder *)_this;
36
+ return sizeof(*this);
37
+ }
38
+
39
+ static void
40
+ pg_copycoder_compact( void *_this )
41
+ {
42
+ t_pg_copycoder *this = (t_pg_copycoder *)_this;
43
+ pg_coder_compact(&this->comp);
44
+ pg_gc_location(this->typemap);
45
+ pg_gc_location(this->null_string);
46
+ }
47
+
48
+ static const rb_data_type_t pg_copycoder_type = {
49
+ "PG::CopyCoder",
50
+ {
51
+ pg_copycoder_mark,
52
+ RUBY_TYPED_DEFAULT_FREE,
53
+ pg_copycoder_memsize,
54
+ pg_compact_callback(pg_copycoder_compact),
55
+ },
56
+ &pg_coder_type,
57
+ 0,
58
+ RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | PG_RUBY_TYPED_FROZEN_SHAREABLE,
59
+ };
60
+
30
61
  static VALUE
31
62
  pg_copycoder_encoder_allocate( VALUE klass )
32
63
  {
33
64
  t_pg_copycoder *this;
34
- VALUE self = Data_Make_Struct( klass, t_pg_copycoder, pg_copycoder_mark, -1, this );
65
+ VALUE self = TypedData_Make_Struct( klass, t_pg_copycoder, &pg_copycoder_type, this );
35
66
  pg_coder_init_encoder( self );
36
- this->typemap = pg_typemap_all_strings;
67
+ RB_OBJ_WRITE(self, &this->typemap, pg_typemap_all_strings);
37
68
  this->delimiter = '\t';
38
- this->null_string = rb_str_new_cstr("\\N");
69
+ RB_OBJ_WRITE(self, &this->null_string, rb_str_new_cstr("\\N"));
39
70
  return self;
40
71
  }
41
72
 
@@ -43,11 +74,11 @@ static VALUE
43
74
  pg_copycoder_decoder_allocate( VALUE klass )
44
75
  {
45
76
  t_pg_copycoder *this;
46
- VALUE self = Data_Make_Struct( klass, t_pg_copycoder, pg_copycoder_mark, -1, this );
77
+ VALUE self = TypedData_Make_Struct( klass, t_pg_copycoder, &pg_copycoder_type, this );
47
78
  pg_coder_init_decoder( self );
48
- this->typemap = pg_typemap_all_strings;
79
+ RB_OBJ_WRITE(self, &this->typemap, pg_typemap_all_strings);
49
80
  this->delimiter = '\t';
50
- this->null_string = rb_str_new_cstr("\\N");
81
+ RB_OBJ_WRITE(self, &this->null_string, rb_str_new_cstr("\\N"));
51
82
  return self;
52
83
  }
53
84
 
@@ -56,13 +87,16 @@ pg_copycoder_decoder_allocate( VALUE klass )
56
87
  * coder.delimiter = String
57
88
  *
58
89
  * Specifies the character that separates columns within each row (line) of the file.
59
- * The default is a tab character in text format, a comma in CSV format.
60
- * This must be a single one-byte character. This option is ignored when using binary format.
90
+ * The default is a tab character in text format.
91
+ * This must be a single one-byte character.
92
+ *
93
+ * This option is ignored when using binary format.
61
94
  */
62
95
  static VALUE
63
96
  pg_copycoder_delimiter_set(VALUE self, VALUE delimiter)
64
97
  {
65
- t_pg_copycoder *this = DATA_PTR(self);
98
+ t_pg_copycoder *this = RTYPEDDATA_DATA(self);
99
+ rb_check_frozen(self);
66
100
  StringValue(delimiter);
67
101
  if(RSTRING_LEN(delimiter) != 1)
68
102
  rb_raise( rb_eArgError, "delimiter size must be one byte");
@@ -79,22 +113,24 @@ pg_copycoder_delimiter_set(VALUE self, VALUE delimiter)
79
113
  static VALUE
80
114
  pg_copycoder_delimiter_get(VALUE self)
81
115
  {
82
- t_pg_copycoder *this = DATA_PTR(self);
116
+ t_pg_copycoder *this = RTYPEDDATA_DATA(self);
83
117
  return rb_str_new(&this->delimiter, 1);
84
118
  }
85
119
 
86
120
  /*
87
- * Specifies the string that represents a null value. The default is \\N (backslash-N)
88
- * in text format, and an unquoted empty string in CSV format. You might prefer an
89
- * empty string even in text format for cases where you don't want to distinguish nulls
90
- * from empty strings. This option is ignored when using binary format.
121
+ * Specifies the string that represents a null value.
122
+ * The default is \\N (backslash-N) in text format.
123
+ * You might prefer an empty string even in text format for cases where you don't want to distinguish nulls from empty strings.
124
+ *
125
+ * This option is ignored when using binary format.
91
126
  */
92
127
  static VALUE
93
128
  pg_copycoder_null_string_set(VALUE self, VALUE null_string)
94
129
  {
95
- t_pg_copycoder *this = DATA_PTR(self);
130
+ t_pg_copycoder *this = RTYPEDDATA_DATA(self);
131
+ rb_check_frozen(self);
96
132
  StringValue(null_string);
97
- this->null_string = null_string;
133
+ RB_OBJ_WRITE(self, &this->null_string, null_string);
98
134
  return null_string;
99
135
  }
100
136
 
@@ -104,7 +140,7 @@ pg_copycoder_null_string_set(VALUE self, VALUE null_string)
104
140
  static VALUE
105
141
  pg_copycoder_null_string_get(VALUE self)
106
142
  {
107
- t_pg_copycoder *this = DATA_PTR(self);
143
+ t_pg_copycoder *this = RTYPEDDATA_DATA(self);
108
144
  return this->null_string;
109
145
  }
110
146
 
@@ -112,22 +148,24 @@ pg_copycoder_null_string_get(VALUE self)
112
148
  * call-seq:
113
149
  * coder.type_map = map
114
150
  *
151
+ * Defines how single columns are encoded or decoded.
115
152
  * +map+ must be a kind of PG::TypeMap .
116
153
  *
117
154
  * Defaults to a PG::TypeMapAllStrings , so that PG::TextEncoder::String respectively
118
- * PG::TextDecoder::String is used for encoding/decoding of all columns.
155
+ * PG::TextDecoder::String is used for encoding/decoding of each column.
119
156
  *
120
157
  */
121
158
  static VALUE
122
159
  pg_copycoder_type_map_set(VALUE self, VALUE type_map)
123
160
  {
124
- t_pg_copycoder *this = DATA_PTR( self );
161
+ t_pg_copycoder *this = RTYPEDDATA_DATA( self );
125
162
 
163
+ rb_check_frozen(self);
126
164
  if ( !rb_obj_is_kind_of(type_map, rb_cTypeMap) ){
127
165
  rb_raise( rb_eTypeError, "wrong elements type %s (expected some kind of PG::TypeMap)",
128
166
  rb_obj_classname( type_map ) );
129
167
  }
130
- this->typemap = type_map;
168
+ RB_OBJ_WRITE(self, &this->typemap, type_map);
131
169
 
132
170
  return type_map;
133
171
  }
@@ -136,11 +174,12 @@ pg_copycoder_type_map_set(VALUE self, VALUE type_map)
136
174
  * call-seq:
137
175
  * coder.type_map -> PG::TypeMap
138
176
  *
177
+ * The PG::TypeMap that will be used for encoding and decoding of columns.
139
178
  */
140
179
  static VALUE
141
180
  pg_copycoder_type_map_get(VALUE self)
142
181
  {
143
- t_pg_copycoder *this = DATA_PTR( self );
182
+ t_pg_copycoder *this = RTYPEDDATA_DATA( self );
144
183
 
145
184
  return this->typemap;
146
185
  }
@@ -173,6 +212,7 @@ pg_copycoder_type_map_get(VALUE self)
173
212
  *
174
213
  * See also PG::TextDecoder::CopyRow for the decoding direction with
175
214
  * PG::Connection#get_copy_data .
215
+ * And see PG::BinaryEncoder::CopyRow for an encoder of the COPY binary format.
176
216
  */
177
217
  static int
178
218
  pg_text_enc_copy_row(t_pg_coder *conv, VALUE value, char *out, VALUE *intermediate, int enc_idx)
@@ -185,7 +225,7 @@ pg_text_enc_copy_row(t_pg_coder *conv, VALUE value, char *out, VALUE *intermedia
185
225
  char *current_out;
186
226
  char *end_capa_ptr;
187
227
 
188
- p_typemap = DATA_PTR( this->typemap );
228
+ p_typemap = RTYPEDDATA_DATA( this->typemap );
189
229
  p_typemap->funcs.fit_to_query( this->typemap, value );
190
230
 
191
231
  /* Allocate a new string with embedded capacity and realloc exponential when needed. */
@@ -196,7 +236,7 @@ pg_text_enc_copy_row(t_pg_coder *conv, VALUE value, char *out, VALUE *intermedia
196
236
  char *ptr1;
197
237
  char *ptr2;
198
238
  int strlen;
199
- int backslashs;
239
+ int backslashes;
200
240
  VALUE subint;
201
241
  VALUE entry;
202
242
 
@@ -222,7 +262,7 @@ pg_text_enc_copy_row(t_pg_coder *conv, VALUE value, char *out, VALUE *intermedia
222
262
 
223
263
  if( strlen == -1 ){
224
264
  /* we can directly use String value in subint */
225
- strlen = RSTRING_LEN(subint);
265
+ strlen = RSTRING_LENINT(subint);
226
266
 
227
267
  /* size of string assuming the worst case, that every character must be escaped. */
228
268
  PG_RB_STR_ENSURE_CAPA( *intermediate, strlen * 2, current_out, end_capa_ptr );
@@ -247,19 +287,19 @@ pg_text_enc_copy_row(t_pg_coder *conv, VALUE value, char *out, VALUE *intermedia
247
287
  ptr2 = current_out + strlen;
248
288
 
249
289
  /* count required backlashs */
250
- for(backslashs = 0; ptr1 != ptr2; ptr1++) {
290
+ for(backslashes = 0; ptr1 != ptr2; ptr1++) {
251
291
  /* Escape backslash itself, newline, carriage return, and the current delimiter character. */
252
292
  if(*ptr1 == '\\' || *ptr1 == '\n' || *ptr1 == '\r' || *ptr1 == this->delimiter){
253
- backslashs++;
293
+ backslashes++;
254
294
  }
255
295
  }
256
296
 
257
297
  ptr1 = current_out + strlen;
258
- ptr2 = current_out + strlen + backslashs;
298
+ ptr2 = current_out + strlen + backslashes;
259
299
  current_out = ptr2;
260
300
 
261
301
  /* Then store the escaped string on the final position, walking
262
- * right to left, until all backslashs are placed. */
302
+ * right to left, until all backslashes are placed. */
263
303
  while( ptr1 != ptr2 ) {
264
304
  *--ptr2 = *--ptr1;
265
305
  if(*ptr1 == '\\' || *ptr1 == '\n' || *ptr1 == '\r' || *ptr1 == this->delimiter){
@@ -278,6 +318,124 @@ pg_text_enc_copy_row(t_pg_coder *conv, VALUE value, char *out, VALUE *intermedia
278
318
  }
279
319
 
280
320
 
321
+ /*
322
+ * Document-class: PG::BinaryEncoder::CopyRow < PG::CopyEncoder
323
+ *
324
+ * This class encodes one row of arbitrary columns for transmission as COPY data in binary format.
325
+ * See the {COPY command}[http://www.postgresql.org/docs/current/static/sql-copy.html]
326
+ * for description of the format.
327
+ *
328
+ * It is intended to be used in conjunction with PG::Connection#put_copy_data .
329
+ *
330
+ * The columns are expected as Array of values. The single values are encoded as defined
331
+ * in the assigned #type_map. If no type_map was assigned, all values are converted to
332
+ * strings by PG::BinaryEncoder::String.
333
+ *
334
+ * Example with default type map ( TypeMapAllStrings ):
335
+ * conn.exec "create table my_table (a text,b int,c bool)"
336
+ * enco = PG::BinaryEncoder::CopyRow.new
337
+ * conn.copy_data "COPY my_table FROM STDIN WITH (FORMAT binary)", enco do
338
+ * conn.put_copy_data ["astring", "\x00\x00\x00\a", "\x00"]
339
+ * conn.put_copy_data ["string2", "\x00\x00\x00*", "\x01"]
340
+ * end
341
+ * This creates +my_table+ and inserts two rows with binary fields.
342
+ *
343
+ * The binary format is less portable and less readable than the text format.
344
+ * It is therefore recommended to either manually assign a type encoder for each column per PG::TypeMapByColumn,
345
+ * or to make use of PG::BasicTypeMapBasedOnResult to assign them based on the table OIDs.
346
+ *
347
+ * Manually assigning a type encoder works per type map like so:
348
+ *
349
+ * conn.exec "create table my_table (a text,b int,c bool)"
350
+ * tm = PG::TypeMapByColumn.new( [
351
+ * PG::BinaryEncoder::String.new,
352
+ * PG::BinaryEncoder::Int4.new,
353
+ * PG::BinaryEncoder::Boolean.new] )
354
+ * enco = PG::BinaryEncoder::CopyRow.new( type_map: tm )
355
+ * conn.copy_data "COPY my_table FROM STDIN WITH (FORMAT binary)", enco do
356
+ * conn.put_copy_data ["astring", 7, false]
357
+ * conn.put_copy_data ["string2", 42, true]
358
+ * end
359
+ *
360
+ * See also PG::BinaryDecoder::CopyRow for the decoding direction with
361
+ * PG::Connection#get_copy_data .
362
+ * And see PG::TextEncoder::CopyRow for an encoder of the COPY text format.
363
+ */
364
+ static int
365
+ pg_bin_enc_copy_row(t_pg_coder *conv, VALUE value, char *out, VALUE *intermediate, int enc_idx)
366
+ {
367
+ t_pg_copycoder *this = (t_pg_copycoder *)conv;
368
+ int i;
369
+ t_typemap *p_typemap;
370
+ char *current_out;
371
+ char *end_capa_ptr;
372
+
373
+ p_typemap = RTYPEDDATA_DATA( this->typemap );
374
+ p_typemap->funcs.fit_to_query( this->typemap, value );
375
+
376
+ /* Allocate a new string with embedded capacity and realloc exponential when needed. */
377
+ PG_RB_STR_NEW( *intermediate, current_out, end_capa_ptr );
378
+ PG_ENCODING_SET_NOCHECK(*intermediate, enc_idx);
379
+
380
+ /* 2 bytes for number of fields */
381
+ PG_RB_STR_ENSURE_CAPA( *intermediate, 2, current_out, end_capa_ptr );
382
+ write_nbo16(RARRAY_LEN(value), current_out);
383
+ current_out += 2;
384
+
385
+ for( i=0; i<RARRAY_LEN(value); i++){
386
+ int strlen;
387
+ VALUE subint;
388
+ VALUE entry;
389
+ t_pg_coder_enc_func enc_func;
390
+ static t_pg_coder *p_elem_coder;
391
+
392
+ entry = rb_ary_entry(value, i);
393
+
394
+ switch(TYPE(entry)){
395
+ case T_NIL:
396
+ /* 4 bytes for -1 indicating a NULL value */
397
+ PG_RB_STR_ENSURE_CAPA( *intermediate, 4, current_out, end_capa_ptr );
398
+ write_nbo32(-1, current_out);
399
+ current_out += 4;
400
+ break;
401
+ default:
402
+ p_elem_coder = p_typemap->funcs.typecast_query_param(p_typemap, entry, i);
403
+ enc_func = pg_coder_enc_func(p_elem_coder);
404
+
405
+ /* 1st pass for retiving the required memory space */
406
+ strlen = enc_func(p_elem_coder, entry, NULL, &subint, enc_idx);
407
+
408
+ if( strlen == -1 ){
409
+ /* we can directly use String value in subint */
410
+ strlen = RSTRING_LENINT(subint);
411
+
412
+ PG_RB_STR_ENSURE_CAPA( *intermediate, 4 + strlen, current_out, end_capa_ptr );
413
+ /* 4 bytes length */
414
+ write_nbo32(strlen, current_out);
415
+ current_out += 4;
416
+
417
+ memcpy( current_out, RSTRING_PTR(subint), strlen );
418
+ current_out += strlen;
419
+ } else {
420
+ /* 2nd pass for writing the data to prepared buffer */
421
+ PG_RB_STR_ENSURE_CAPA( *intermediate, 4 + strlen, current_out, end_capa_ptr );
422
+ /* 4 bytes length */
423
+ write_nbo32(strlen, current_out);
424
+ current_out += 4;
425
+
426
+ /* Place the string at current output position. */
427
+ strlen = enc_func(p_elem_coder, entry, current_out, &subint, enc_idx);
428
+ current_out += strlen;
429
+ }
430
+ }
431
+ }
432
+
433
+ rb_str_set_len( *intermediate, current_out - RSTRING_PTR(*intermediate) );
434
+
435
+ return -1;
436
+ }
437
+
438
+
281
439
  /*
282
440
  * Return decimal value for a hexadecimal digit
283
441
  */
@@ -340,6 +498,7 @@ GetDecimalFromHex(char hex)
340
498
  *
341
499
  * See also PG::TextEncoder::CopyRow for the encoding direction with
342
500
  * PG::Connection#put_copy_data .
501
+ * And see PG::BinaryDecoder::CopyRow for a decoder of the COPY binary format.
343
502
  */
344
503
  /*
345
504
  * Parse the current line into separate attributes (fields),
@@ -354,7 +513,7 @@ GetDecimalFromHex(char hex)
354
513
  * src/backend/commands/copy.c
355
514
  */
356
515
  static VALUE
357
- pg_text_dec_copy_row(t_pg_coder *conv, char *input_line, int len, int _tuple, int _field, int enc_idx)
516
+ pg_text_dec_copy_row(t_pg_coder *conv, const char *input_line, int len, int _tuple, int _field, int enc_idx)
358
517
  {
359
518
  t_pg_copycoder *this = (t_pg_copycoder *)conv;
360
519
 
@@ -368,12 +527,12 @@ pg_text_dec_copy_row(t_pg_coder *conv, char *input_line, int len, int _tuple, in
368
527
  int fieldno;
369
528
  int expected_fields;
370
529
  char *output_ptr;
371
- char *cur_ptr;
372
- char *line_end_ptr;
530
+ const char *cur_ptr;
531
+ const char *line_end_ptr;
373
532
  char *end_capa_ptr;
374
533
  t_typemap *p_typemap;
375
534
 
376
- p_typemap = DATA_PTR( this->typemap );
535
+ p_typemap = RTYPEDDATA_DATA( this->typemap );
377
536
  expected_fields = p_typemap->funcs.fit_to_copy_get( this->typemap );
378
537
 
379
538
  /* The received input string will probably have this->nfields fields. */
@@ -381,7 +540,7 @@ pg_text_dec_copy_row(t_pg_coder *conv, char *input_line, int len, int _tuple, in
381
540
 
382
541
  /* Allocate a new string with embedded capacity and realloc later with
383
542
  * exponential growing size when needed. */
384
- PG_RB_TAINTED_STR_NEW( field_str, output_ptr, end_capa_ptr );
543
+ PG_RB_STR_NEW( field_str, output_ptr, end_capa_ptr );
385
544
 
386
545
  /* set pointer variables for loop */
387
546
  cur_ptr = input_line;
@@ -392,9 +551,9 @@ pg_text_dec_copy_row(t_pg_coder *conv, char *input_line, int len, int _tuple, in
392
551
  for (;;)
393
552
  {
394
553
  int found_delim = 0;
395
- char *start_ptr;
396
- char *end_ptr;
397
- int input_len;
554
+ const char *start_ptr;
555
+ const char *end_ptr;
556
+ long input_len;
398
557
 
399
558
  /* Remember start of field on input side */
400
559
  start_ptr = cur_ptr;
@@ -543,7 +702,7 @@ pg_text_dec_copy_row(t_pg_coder *conv, char *input_line, int len, int _tuple, in
543
702
  if( field_value == field_str ){
544
703
  /* Our output string will be send to the user, so we can not reuse
545
704
  * it for the next field. */
546
- PG_RB_TAINTED_STR_NEW( field_str, output_ptr, end_capa_ptr );
705
+ PG_RB_STR_NEW( field_str, output_ptr, end_capa_ptr );
547
706
  }
548
707
  }
549
708
  /* Reset the pointer to the start of the output/buffer string. */
@@ -559,9 +718,169 @@ pg_text_dec_copy_row(t_pg_coder *conv, char *input_line, int len, int _tuple, in
559
718
  }
560
719
 
561
720
 
721
+ static const char BinarySignature[11] = "PGCOPY\n\377\r\n\0";
722
+
723
+ /*
724
+ * Document-class: PG::BinaryDecoder::CopyRow < PG::CopyDecoder
725
+ *
726
+ * This class decodes one row of arbitrary columns received as COPY data in binary format.
727
+ * See the {COPY command}[http://www.postgresql.org/docs/current/static/sql-copy.html]
728
+ * for description of the format.
729
+ *
730
+ * It is intended to be used in conjunction with PG::Connection#get_copy_data .
731
+ *
732
+ * The columns are retrieved as Array of values. The single values are decoded as defined
733
+ * in the assigned #type_map. If no type_map was assigned, all values are converted to
734
+ * strings by PG::BinaryDecoder::String.
735
+ *
736
+ * Example with default type map ( TypeMapAllStrings ):
737
+ * conn.exec("CREATE TABLE my_table AS VALUES('astring', 7, FALSE), ('string2', 42, TRUE) ")
738
+ *
739
+ * deco = PG::BinaryDecoder::CopyRow.new
740
+ * conn.copy_data "COPY my_table TO STDOUT WITH (FORMAT binary)", deco do
741
+ * while row=conn.get_copy_data
742
+ * p row
743
+ * end
744
+ * end
745
+ * This prints all rows of +my_table+ in binary format:
746
+ * ["astring", "\x00\x00\x00\a", "\x00"]
747
+ * ["string2", "\x00\x00\x00*", "\x01"]
748
+ *
749
+ * Example with column based type map:
750
+ * tm = PG::TypeMapByColumn.new( [
751
+ * PG::BinaryDecoder::String.new,
752
+ * PG::BinaryDecoder::Integer.new,
753
+ * PG::BinaryDecoder::Boolean.new] )
754
+ * deco = PG::BinaryDecoder::CopyRow.new( type_map: tm )
755
+ * conn.copy_data "COPY my_table TO STDOUT WITH (FORMAT binary)", deco do
756
+ * while row=conn.get_copy_data
757
+ * p row
758
+ * end
759
+ * end
760
+ * This prints the rows with type casted columns:
761
+ * ["astring", 7, false]
762
+ * ["string2", 42, true]
763
+ *
764
+ * Instead of manually assigning a type decoder for each column, PG::BasicTypeMapForResults
765
+ * can be used to assign them based on the table OIDs.
766
+ *
767
+ * See also PG::BinaryEncoder::CopyRow for the encoding direction with
768
+ * PG::Connection#put_copy_data .
769
+ * And see PG::TextDecoder::CopyRow for a decoder of the COPY text format.
770
+ */
771
+ static VALUE
772
+ pg_bin_dec_copy_row(t_pg_coder *conv, const char *input_line, int len, int _tuple, int _field, int enc_idx)
773
+ {
774
+ t_pg_copycoder *this = (t_pg_copycoder *)conv;
775
+
776
+ /* Return value: array */
777
+ VALUE array;
778
+
779
+ /* Current field */
780
+ VALUE field_str;
781
+
782
+ int nfields;
783
+ int expected_fields;
784
+ int fieldno;
785
+ char *output_ptr;
786
+ const char *cur_ptr;
787
+ const char *line_end_ptr;
788
+ char *end_capa_ptr;
789
+ t_typemap *p_typemap;
790
+
791
+ p_typemap = RTYPEDDATA_DATA( this->typemap );
792
+ expected_fields = p_typemap->funcs.fit_to_copy_get( this->typemap );
793
+
794
+ /* Allocate a new string with embedded capacity and realloc later with
795
+ * exponential growing size when needed. */
796
+ PG_RB_STR_NEW( field_str, output_ptr, end_capa_ptr );
797
+
798
+ /* set pointer variables for loop */
799
+ cur_ptr = input_line;
800
+ line_end_ptr = input_line + len;
801
+
802
+ if (line_end_ptr - cur_ptr >= 11 && memcmp(cur_ptr, BinarySignature, 11) == 0){
803
+ /* binary COPY header signature detected -> just drop it */
804
+ int ext_bytes;
805
+ cur_ptr += 11;
806
+
807
+ /* read flags */
808
+ if (line_end_ptr - cur_ptr < 4 ) goto length_error;
809
+ cur_ptr += 4;
810
+
811
+ /* read header extensions */
812
+ if (line_end_ptr - cur_ptr < 4 ) goto length_error;
813
+ ext_bytes = read_nbo32(cur_ptr);
814
+ if (ext_bytes < 0) goto length_error;
815
+ cur_ptr += 4;
816
+ if (line_end_ptr - cur_ptr < ext_bytes ) goto length_error;
817
+ cur_ptr += ext_bytes;
818
+ }
819
+
820
+ /* read row header */
821
+ if (line_end_ptr - cur_ptr < 2 ) goto length_error;
822
+ nfields = read_nbo16(cur_ptr);
823
+ cur_ptr += 2;
824
+
825
+ /* COPY data trailer? */
826
+ if (nfields < 0) {
827
+ if (nfields != -1) goto length_error;
828
+ array = Qnil;
829
+ } else {
830
+ array = rb_ary_new2(expected_fields);
831
+
832
+ for( fieldno = 0; fieldno < nfields; fieldno++){
833
+ long input_len;
834
+ VALUE field_value;
835
+
836
+ /* read field size */
837
+ if (line_end_ptr - cur_ptr < 4 ) goto length_error;
838
+ input_len = read_nbo32(cur_ptr);
839
+ cur_ptr += 4;
840
+
841
+ if (input_len < 0) {
842
+ if (input_len != -1) goto length_error;
843
+ /* NULL indicator */
844
+ rb_ary_push(array, Qnil);
845
+ } else {
846
+ if (line_end_ptr - cur_ptr < input_len ) goto length_error;
847
+
848
+ /* copy input data to field_str */
849
+ PG_RB_STR_ENSURE_CAPA( field_str, input_len, output_ptr, end_capa_ptr );
850
+ memcpy(output_ptr, cur_ptr, input_len);
851
+ cur_ptr += input_len;
852
+ output_ptr += input_len;
853
+ /* convert field_str through the type map */
854
+ rb_str_set_len( field_str, output_ptr - RSTRING_PTR(field_str) );
855
+ field_value = p_typemap->funcs.typecast_copy_get( p_typemap, field_str, fieldno, 1, enc_idx );
856
+
857
+ rb_ary_push(array, field_value);
858
+
859
+ if( field_value == field_str ){
860
+ /* Our output string will be send to the user, so we can not reuse
861
+ * it for the next field. */
862
+ PG_RB_STR_NEW( field_str, output_ptr, end_capa_ptr );
863
+ }
864
+ }
865
+
866
+ /* Reset the pointer to the start of the output/buffer string. */
867
+ output_ptr = RSTRING_PTR(field_str);
868
+ }
869
+ }
870
+
871
+ if (cur_ptr < line_end_ptr)
872
+ rb_raise( rb_eArgError, "trailing data after row data at position: %ld", (long)(cur_ptr - input_line) + 1 );
873
+
874
+ return array;
875
+
876
+ length_error:
877
+ rb_raise( rb_eArgError, "premature end of COPY data at position: %ld", (long)(cur_ptr - input_line) + 1 );
878
+ }
879
+
562
880
  void
563
- init_pg_copycoder()
881
+ init_pg_copycoder(void)
564
882
  {
883
+ VALUE coder;
565
884
  /* Document-class: PG::CopyCoder < PG::Coder
566
885
  *
567
886
  * This is the base class for all type cast classes for COPY data,
@@ -584,8 +903,19 @@ init_pg_copycoder()
584
903
  /* Make RDoc aware of the encoder classes... */
585
904
  /* rb_mPG_TextEncoder = rb_define_module_under( rb_mPG, "TextEncoder" ); */
586
905
  /* dummy = rb_define_class_under( rb_mPG_TextEncoder, "CopyRow", rb_cPG_CopyEncoder ); */
587
- pg_define_coder( "CopyRow", pg_text_enc_copy_row, rb_cPG_CopyEncoder, rb_mPG_TextEncoder );
906
+ coder = pg_define_coder( "CopyRow", pg_text_enc_copy_row, rb_cPG_CopyEncoder, rb_mPG_TextEncoder );
907
+ rb_include_module( coder, rb_mPG_BinaryFormatting );
908
+ /* rb_mPG_BinaryEncoder = rb_define_module_under( rb_mPG, "BinaryEncoder" ); */
909
+ /* dummy = rb_define_class_under( rb_mPG_BinaryEncoder, "CopyRow", rb_cPG_CopyEncoder ); */
910
+ pg_define_coder( "CopyRow", pg_bin_enc_copy_row, rb_cPG_CopyEncoder, rb_mPG_BinaryEncoder );
911
+
588
912
  /* rb_mPG_TextDecoder = rb_define_module_under( rb_mPG, "TextDecoder" ); */
589
913
  /* dummy = rb_define_class_under( rb_mPG_TextDecoder, "CopyRow", rb_cPG_CopyDecoder ); */
590
- pg_define_coder( "CopyRow", pg_text_dec_copy_row, rb_cPG_CopyDecoder, rb_mPG_TextDecoder );
914
+ coder = pg_define_coder( "CopyRow", pg_text_dec_copy_row, rb_cPG_CopyDecoder, rb_mPG_TextDecoder );
915
+ /* Although CopyRow is a text decoder, data can contain zero bytes and are not zero terminated.
916
+ * They are handled like binaries. So format is set to 1 (binary). */
917
+ rb_include_module( coder, rb_mPG_BinaryFormatting );
918
+ /* rb_mPG_BinaryDecoder = rb_define_module_under( rb_mPG, "BinaryDecoder" ); */
919
+ /* dummy = rb_define_class_under( rb_mPG_BinaryDecoder, "CopyRow", rb_cPG_CopyDecoder ); */
920
+ pg_define_coder( "CopyRow", pg_bin_dec_copy_row, rb_cPG_CopyDecoder, rb_mPG_BinaryDecoder );
591
921
  }
data/ext/pg_errors.c CHANGED
@@ -70,7 +70,7 @@ lookup_error_class(const char *sqlstate)
70
70
  }
71
71
 
72
72
  void
73
- init_pg_errors()
73
+ init_pg_errors(void)
74
74
  {
75
75
  rb_hErrors = rb_hash_new();
76
76
  rb_define_const( rb_mPG, "ERROR_CLASSES", rb_hErrors );