pg 0.21.0 → 1.5.3

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 (139) hide show
  1. checksums.yaml +5 -5
  2. checksums.yaml.gz.sig +0 -0
  3. data/.appveyor.yml +42 -0
  4. data/.gems +6 -0
  5. data/.github/workflows/binary-gems.yml +117 -0
  6. data/.github/workflows/source-gem.yml +137 -0
  7. data/.gitignore +22 -0
  8. data/.hgsigs +34 -0
  9. data/.hgtags +41 -0
  10. data/.irbrc +23 -0
  11. data/.pryrc +23 -0
  12. data/.tm_properties +21 -0
  13. data/.travis.yml +49 -0
  14. data/Gemfile +14 -0
  15. data/History.md +876 -0
  16. data/Manifest.txt +8 -4
  17. data/README-Windows.rdoc +4 -4
  18. data/README.ja.md +276 -0
  19. data/README.md +286 -0
  20. data/Rakefile +38 -139
  21. data/Rakefile.cross +70 -74
  22. data/certs/ged.pem +24 -0
  23. data/certs/larskanis-2022.pem +26 -0
  24. data/certs/larskanis-2023.pem +24 -0
  25. data/ext/errorcodes.def +88 -0
  26. data/ext/errorcodes.rb +1 -1
  27. data/ext/errorcodes.txt +24 -2
  28. data/ext/extconf.rb +111 -54
  29. data/ext/gvl_wrappers.c +8 -0
  30. data/ext/gvl_wrappers.h +40 -33
  31. data/ext/pg.c +224 -199
  32. data/ext/pg.h +93 -96
  33. data/ext/pg_binary_decoder.c +162 -16
  34. data/ext/pg_binary_encoder.c +238 -13
  35. data/ext/pg_coder.c +159 -35
  36. data/ext/pg_connection.c +1585 -1046
  37. data/ext/pg_copy_coder.c +364 -38
  38. data/ext/pg_errors.c +1 -1
  39. data/ext/pg_record_coder.c +522 -0
  40. data/ext/pg_result.c +708 -219
  41. data/ext/pg_text_decoder.c +627 -43
  42. data/ext/pg_text_encoder.c +206 -62
  43. data/ext/pg_tuple.c +572 -0
  44. data/ext/pg_type_map.c +45 -11
  45. data/ext/pg_type_map_all_strings.c +21 -7
  46. data/ext/pg_type_map_by_class.c +59 -27
  47. data/ext/pg_type_map_by_column.c +80 -37
  48. data/ext/pg_type_map_by_mri_type.c +49 -20
  49. data/ext/pg_type_map_by_oid.c +62 -29
  50. data/ext/pg_type_map_in_ruby.c +56 -22
  51. data/ext/{util.c → pg_util.c} +12 -12
  52. data/ext/{util.h → pg_util.h} +2 -2
  53. data/lib/pg/basic_type_map_based_on_result.rb +67 -0
  54. data/lib/pg/basic_type_map_for_queries.rb +198 -0
  55. data/lib/pg/basic_type_map_for_results.rb +104 -0
  56. data/lib/pg/basic_type_registry.rb +299 -0
  57. data/lib/pg/binary_decoder/date.rb +9 -0
  58. data/lib/pg/binary_decoder/timestamp.rb +26 -0
  59. data/lib/pg/binary_encoder/timestamp.rb +20 -0
  60. data/lib/pg/coder.rb +36 -13
  61. data/lib/pg/connection.rb +755 -71
  62. data/lib/pg/exceptions.rb +16 -2
  63. data/lib/pg/result.rb +14 -2
  64. data/lib/pg/text_decoder/date.rb +18 -0
  65. data/lib/pg/text_decoder/inet.rb +9 -0
  66. data/lib/pg/text_decoder/json.rb +14 -0
  67. data/lib/pg/text_decoder/numeric.rb +9 -0
  68. data/lib/pg/text_decoder/timestamp.rb +30 -0
  69. data/lib/pg/text_encoder/date.rb +12 -0
  70. data/lib/pg/text_encoder/inet.rb +28 -0
  71. data/lib/pg/text_encoder/json.rb +14 -0
  72. data/lib/pg/text_encoder/numeric.rb +9 -0
  73. data/lib/pg/text_encoder/timestamp.rb +24 -0
  74. data/lib/pg/tuple.rb +30 -0
  75. data/lib/pg/type_map_by_column.rb +3 -2
  76. data/lib/pg/version.rb +4 -0
  77. data/lib/pg.rb +96 -43
  78. data/misc/openssl-pg-segfault.rb +31 -0
  79. data/misc/postgres/History.txt +9 -0
  80. data/misc/postgres/Manifest.txt +5 -0
  81. data/misc/postgres/README.txt +21 -0
  82. data/misc/postgres/Rakefile +21 -0
  83. data/misc/postgres/lib/postgres.rb +16 -0
  84. data/misc/ruby-pg/History.txt +9 -0
  85. data/misc/ruby-pg/Manifest.txt +5 -0
  86. data/misc/ruby-pg/README.txt +21 -0
  87. data/misc/ruby-pg/Rakefile +21 -0
  88. data/misc/ruby-pg/lib/ruby/pg.rb +16 -0
  89. data/pg.gemspec +34 -0
  90. data/rakelib/task_extension.rb +46 -0
  91. data/sample/array_insert.rb +20 -0
  92. data/sample/async_api.rb +102 -0
  93. data/sample/async_copyto.rb +39 -0
  94. data/sample/async_mixed.rb +56 -0
  95. data/sample/check_conn.rb +21 -0
  96. data/sample/copydata.rb +71 -0
  97. data/sample/copyfrom.rb +81 -0
  98. data/sample/copyto.rb +19 -0
  99. data/sample/cursor.rb +21 -0
  100. data/sample/disk_usage_report.rb +177 -0
  101. data/sample/issue-119.rb +94 -0
  102. data/sample/losample.rb +69 -0
  103. data/sample/minimal-testcase.rb +17 -0
  104. data/sample/notify_wait.rb +72 -0
  105. data/sample/pg_statistics.rb +285 -0
  106. data/sample/replication_monitor.rb +222 -0
  107. data/sample/test_binary_values.rb +33 -0
  108. data/sample/wal_shipper.rb +434 -0
  109. data/sample/warehouse_partitions.rb +311 -0
  110. data/translation/.po4a-version +7 -0
  111. data/translation/po/all.pot +910 -0
  112. data/translation/po/ja.po +1047 -0
  113. data/translation/po4a.cfg +12 -0
  114. data.tar.gz.sig +0 -0
  115. metadata +154 -217
  116. metadata.gz.sig +0 -0
  117. data/ChangeLog +0 -6595
  118. data/History.rdoc +0 -394
  119. data/README.ja.rdoc +0 -14
  120. data/README.rdoc +0 -168
  121. data/lib/pg/basic_type_mapping.rb +0 -426
  122. data/lib/pg/constants.rb +0 -11
  123. data/lib/pg/deprecated_constants.rb +0 -21
  124. data/lib/pg/text_decoder.rb +0 -51
  125. data/lib/pg/text_encoder.rb +0 -35
  126. data/spec/data/expected_trace.out +0 -26
  127. data/spec/data/random_binary_data +0 -0
  128. data/spec/helpers.rb +0 -352
  129. data/spec/pg/basic_type_mapping_spec.rb +0 -305
  130. data/spec/pg/connection_spec.rb +0 -1676
  131. data/spec/pg/result_spec.rb +0 -456
  132. data/spec/pg/type_map_by_class_spec.rb +0 -138
  133. data/spec/pg/type_map_by_column_spec.rb +0 -222
  134. data/spec/pg/type_map_by_mri_type_spec.rb +0 -136
  135. data/spec/pg/type_map_by_oid_spec.rb +0 -149
  136. data/spec/pg/type_map_in_ruby_spec.rb +0 -164
  137. data/spec/pg/type_map_spec.rb +0 -22
  138. data/spec/pg/type_spec.rb +0 -777
  139. data/spec/pg_spec.rb +0 -50
data/ext/pg.c CHANGED
@@ -1,6 +1,6 @@
1
1
  /*
2
2
  * pg.c - Toplevel extension
3
- * $Id: pg.c,v c77d0997b4e4 2016/08/20 17:30:03 ged $
3
+ * $Id$
4
4
  *
5
5
  * Author/s:
6
6
  *
@@ -16,7 +16,7 @@
16
16
  * See Contributors.rdoc for the many additional fine people that have contributed
17
17
  * to this library over the years.
18
18
  *
19
- * Copyright (c) 1997-2016 by the authors.
19
+ * Copyright (c) 1997-2019 by the authors.
20
20
  *
21
21
  * You may redistribute this software under the same terms as Ruby itself; see
22
22
  * https://www.ruby-lang.org/en/about/license.txt or the BSDL file in the source
@@ -33,7 +33,6 @@
33
33
  *
34
34
  * - PQfreemem -- unnecessary: copied to ruby object, then freed. Ruby object's
35
35
  * memory is freed when it is garbage collected.
36
- * - PQbinaryTuples -- better to use PQfformat
37
36
  * - PQprint -- not very useful
38
37
  * - PQsetdb -- not very useful
39
38
  * - PQoidStatus -- deprecated, use PQoidValue
@@ -48,6 +47,7 @@
48
47
 
49
48
  #include "pg.h"
50
49
 
50
+ int pg_skip_deprecation_warning;
51
51
  VALUE rb_mPG;
52
52
  VALUE rb_mPGconstants;
53
53
 
@@ -69,11 +69,11 @@ VALUE rb_mPGconstants;
69
69
  * M17n functions
70
70
  */
71
71
 
72
- #ifdef M17N_SUPPORTED
73
72
  /**
74
73
  * The mapping from canonical encoding names in PostgreSQL to ones in Ruby.
75
74
  */
76
75
  const char * const (pg_enc_pg2ruby_mapping[][2]) = {
76
+ {"UTF8", "UTF-8" },
77
77
  {"BIG5", "Big5" },
78
78
  {"EUC_CN", "GB2312" },
79
79
  {"EUC_JP", "EUC-JP" },
@@ -105,7 +105,6 @@ const char * const (pg_enc_pg2ruby_mapping[][2]) = {
105
105
  {"SHIFT_JIS_2004","Windows-31J" },
106
106
  /* {"SQL_ASCII", NULL }, special case*/
107
107
  {"UHC", "CP949" },
108
- {"UTF8", "UTF-8" },
109
108
  {"WIN866", "IBM866" },
110
109
  {"WIN874", "Windows-874" },
111
110
  {"WIN1250", "Windows-1250"},
@@ -120,35 +119,6 @@ const char * const (pg_enc_pg2ruby_mapping[][2]) = {
120
119
  };
121
120
 
122
121
 
123
- /*
124
- * A cache of mapping from PostgreSQL's encoding indices to Ruby's rb_encoding*s.
125
- */
126
- static struct st_table *enc_pg2ruby;
127
-
128
-
129
- /*
130
- * Look up the JOHAB encoding, creating it as a dummy encoding if it's not
131
- * already defined.
132
- */
133
- static rb_encoding *
134
- pg_find_or_create_johab(void)
135
- {
136
- static const char * const aliases[] = { "JOHAB", "Windows-1361", "CP1361" };
137
- int enc_index;
138
- size_t i;
139
-
140
- for (i = 0; i < sizeof(aliases)/sizeof(aliases[0]); ++i) {
141
- enc_index = rb_enc_find_index(aliases[i]);
142
- if (enc_index > 0) return rb_enc_from_index(enc_index);
143
- }
144
-
145
- enc_index = rb_define_dummy_encoding(aliases[0]);
146
- for (i = 1; i < sizeof(aliases)/sizeof(aliases[0]); ++i) {
147
- ENC_ALIAS(aliases[i], aliases[0]);
148
- }
149
- return rb_enc_from_index(enc_index);
150
- }
151
-
152
122
  /*
153
123
  * Return the given PostgreSQL encoding ID as an rb_encoding.
154
124
  *
@@ -158,21 +128,8 @@ pg_find_or_create_johab(void)
158
128
  rb_encoding *
159
129
  pg_get_pg_encoding_as_rb_encoding( int enc_id )
160
130
  {
161
- rb_encoding *enc;
162
-
163
- /* Use the cached value if it exists */
164
- if ( st_lookup(enc_pg2ruby, (st_data_t)enc_id, (st_data_t*)&enc) ) {
165
- return enc;
166
- }
167
- else {
168
- const char *name = pg_encoding_to_char( enc_id );
169
-
170
- enc = pg_get_pg_encname_as_rb_encoding( name );
171
- st_insert( enc_pg2ruby, (st_data_t)enc_id, (st_data_t)enc );
172
-
173
- return enc;
174
- }
175
-
131
+ const char *name = pg_encoding_to_char( enc_id );
132
+ return pg_get_pg_encname_as_rb_encoding( name );
176
133
  }
177
134
 
178
135
  /*
@@ -189,10 +146,6 @@ pg_get_pg_encname_as_rb_encoding( const char *pg_encname )
189
146
  return rb_enc_find( pg_enc_pg2ruby_mapping[i][1] );
190
147
  }
191
148
 
192
- /* JOHAB isn't a builtin encoding, so make up a dummy encoding if it's seen */
193
- if ( strncmp(pg_encname, "JOHAB", 5) == 0 )
194
- return pg_find_or_create_johab();
195
-
196
149
  /* Fallthrough to ASCII-8BIT */
197
150
  return rb_ascii8bit_encoding();
198
151
  }
@@ -229,8 +182,6 @@ pg_get_rb_encoding_as_pg_encoding( rb_encoding *enc )
229
182
  return encname;
230
183
  }
231
184
 
232
- #endif /* M17N_SUPPORTED */
233
-
234
185
 
235
186
  /*
236
187
  * Ensures that the given string has enough capacity to take expand_len
@@ -260,45 +211,26 @@ pg_get_rb_encoding_as_pg_encoding( rb_encoding *enc )
260
211
  * rb_str_set_len( string, current_out - RSTRING_PTR(string) );
261
212
  *
262
213
  */
263
- #ifdef HAVE_RB_STR_MODIFY_EXPAND
264
- /* Use somewhat faster version with access to string capacity on MRI */
265
- char *
266
- pg_rb_str_ensure_capa( VALUE str, long expand_len, char *curr_ptr, char **end_ptr )
267
- {
268
- long curr_len = curr_ptr - RSTRING_PTR(str);
269
- long curr_capa = rb_str_capacity( str );
270
- if( curr_capa < curr_len + expand_len ){
271
- rb_str_set_len( str, curr_len );
272
- rb_str_modify_expand( str, (curr_len + expand_len) * 2 - curr_capa );
273
- curr_ptr = RSTRING_PTR(str) + curr_len;
274
- }
275
- if( end_ptr )
276
- *end_ptr = RSTRING_PTR(str) + rb_str_capacity( str );
277
- return curr_ptr;
278
- }
279
- #else
280
- /* Use the more portable version */
281
- char *
282
- pg_rb_str_ensure_capa( VALUE str, long expand_len, char *curr_ptr, char **end_ptr )
283
- {
284
- long curr_len = curr_ptr - RSTRING_PTR(str);
285
- long curr_capa = RSTRING_LEN( str );
286
- if( curr_capa < curr_len + expand_len ){
287
- rb_str_resize( str, (curr_len + expand_len) * 2 - curr_capa );
288
- curr_ptr = RSTRING_PTR(str) + curr_len;
289
- }
290
- if( end_ptr )
291
- *end_ptr = RSTRING_PTR(str) + RSTRING_LEN(str);
292
- return curr_ptr;
214
+ char *
215
+ pg_rb_str_ensure_capa( VALUE str, long expand_len, char *curr_ptr, char **end_ptr )
216
+ {
217
+ long curr_len = curr_ptr - RSTRING_PTR(str);
218
+ long curr_capa = rb_str_capacity( str );
219
+ if( curr_capa < curr_len + expand_len ){
220
+ rb_str_set_len( str, curr_len );
221
+ rb_str_modify_expand( str, (curr_len + expand_len) * 2 - curr_capa );
222
+ curr_ptr = RSTRING_PTR(str) + curr_len;
293
223
  }
294
- #endif
224
+ if( end_ptr )
225
+ *end_ptr = RSTRING_PTR(str) + rb_str_capacity( str );
226
+ return curr_ptr;
227
+ }
295
228
 
296
229
 
297
230
  /**************************************************************************
298
231
  * Module Methods
299
232
  **************************************************************************/
300
233
 
301
- #ifdef HAVE_PQLIBVERSION
302
234
  /*
303
235
  * call-seq:
304
236
  * PG.library_version -> Integer
@@ -316,7 +248,6 @@ pg_s_library_version(VALUE self)
316
248
  UNUSED( self );
317
249
  return INT2NUM(PQlibVersion());
318
250
  }
319
- #endif
320
251
 
321
252
 
322
253
  /*
@@ -356,8 +287,7 @@ pg_to_bool_int(VALUE value)
356
287
  * If your application initializes libssl and/or libcrypto libraries and libpq is
357
288
  * built with SSL support, you should call PG.init_openssl() to tell libpq that the
358
289
  * libssl and/or libcrypto libraries have been initialized by your application,
359
- * so that libpq will not also initialize those libraries. See
360
- * http://h71000.www7.hp.com/doc/83final/BA554_90007/ch04.html for details on the SSL API.
290
+ * so that libpq will not also initialize those libraries.
361
291
  *
362
292
  * When do_ssl is +true+, libpq will initialize the OpenSSL library before first
363
293
  * opening a database connection. When do_crypto is +true+, the libcrypto library
@@ -402,23 +332,33 @@ pg_s_init_ssl(VALUE self, VALUE do_ssl)
402
332
  **************************************************************************/
403
333
 
404
334
  void
405
- Init_pg_ext()
335
+ Init_pg_ext(void)
406
336
  {
337
+
338
+ #ifdef HAVE_RB_EXT_RACTOR_SAFE
339
+ rb_ext_ractor_safe(PQisthreadsafe());
340
+ #endif
341
+
342
+ if( RTEST(rb_eval_string("ENV['PG_SKIP_DEPRECATION_WARNING']")) ){
343
+ /* Set all bits to disable all deprecation warnings. */
344
+ pg_skip_deprecation_warning = 0xFFFF;
345
+ } else {
346
+ pg_skip_deprecation_warning = 0;
347
+ }
348
+
407
349
  rb_mPG = rb_define_module( "PG" );
408
350
  rb_mPGconstants = rb_define_module_under( rb_mPG, "Constants" );
409
351
 
410
352
  /*************************
411
353
  * PG module methods
412
354
  *************************/
413
- #ifdef HAVE_PQLIBVERSION
414
355
  rb_define_singleton_method( rb_mPG, "library_version", pg_s_library_version, 0 );
415
- #endif
416
356
  rb_define_singleton_method( rb_mPG, "isthreadsafe", pg_s_threadsafe_p, 0 );
417
357
  SINGLETON_ALIAS( rb_mPG, "is_threadsafe?", "isthreadsafe" );
418
358
  SINGLETON_ALIAS( rb_mPG, "threadsafe?", "isthreadsafe" );
419
359
 
420
- rb_define_singleton_method( rb_mPG, "init_openssl", pg_s_init_openssl, 2 );
421
- rb_define_singleton_method( rb_mPG, "init_ssl", pg_s_init_ssl, 1 );
360
+ rb_define_singleton_method( rb_mPG, "init_openssl", pg_s_init_openssl, 2 );
361
+ rb_define_singleton_method( rb_mPG, "init_ssl", pg_s_init_ssl, 1 );
422
362
 
423
363
 
424
364
  /****** PG::Connection CLASS CONSTANTS: Connection Status ******/
@@ -436,14 +376,34 @@ Init_pg_ext()
436
376
  rb_define_const(rb_mPGconstants, "CONNECTION_MADE", INT2FIX(CONNECTION_MADE));
437
377
  /* Waiting for a response from the server. */
438
378
  rb_define_const(rb_mPGconstants, "CONNECTION_AWAITING_RESPONSE", INT2FIX(CONNECTION_AWAITING_RESPONSE));
439
- /* Received authentication; waiting for backend start-up to finish. */
379
+ /* Received authentication; waiting for backend startup. */
440
380
  rb_define_const(rb_mPGconstants, "CONNECTION_AUTH_OK", INT2FIX(CONNECTION_AUTH_OK));
381
+ /* This state is no longer used. */
382
+ rb_define_const(rb_mPGconstants, "CONNECTION_SETENV", INT2FIX(CONNECTION_SETENV));
441
383
  /* Negotiating SSL encryption. */
442
384
  rb_define_const(rb_mPGconstants, "CONNECTION_SSL_STARTUP", INT2FIX(CONNECTION_SSL_STARTUP));
443
- /* Negotiating environment-driven parameter settings. */
444
- rb_define_const(rb_mPGconstants, "CONNECTION_SETENV", INT2FIX(CONNECTION_SETENV));
445
- /* Internal state: connect() needed. */
385
+ /* Internal state - PG.connect() needed. */
446
386
  rb_define_const(rb_mPGconstants, "CONNECTION_NEEDED", INT2FIX(CONNECTION_NEEDED));
387
+ #if PG_MAJORVERSION_NUM >= 10
388
+ /* Checking if session is read-write. Available since PostgreSQL-10. */
389
+ rb_define_const(rb_mPGconstants, "CONNECTION_CHECK_WRITABLE", INT2FIX(CONNECTION_CHECK_WRITABLE));
390
+ #endif
391
+ #if PG_MAJORVERSION_NUM >= 10
392
+ /* Consuming any extra messages. Available since PostgreSQL-10. */
393
+ rb_define_const(rb_mPGconstants, "CONNECTION_CONSUME", INT2FIX(CONNECTION_CONSUME));
394
+ #endif
395
+ #if PG_MAJORVERSION_NUM >= 12
396
+ /* Negotiating GSSAPI. Available since PostgreSQL-12. */
397
+ rb_define_const(rb_mPGconstants, "CONNECTION_GSS_STARTUP", INT2FIX(CONNECTION_GSS_STARTUP));
398
+ #endif
399
+ #if PG_MAJORVERSION_NUM >= 13
400
+ /* Checking target server properties. Available since PostgreSQL-13. */
401
+ rb_define_const(rb_mPGconstants, "CONNECTION_CHECK_TARGET", INT2FIX(CONNECTION_CHECK_TARGET));
402
+ #endif
403
+ #if PG_MAJORVERSION_NUM >= 14
404
+ /* Checking if server is in standby mode. Available since PostgreSQL-14. */
405
+ rb_define_const(rb_mPGconstants, "CONNECTION_CHECK_STANDBY", INT2FIX(CONNECTION_CHECK_STANDBY));
406
+ #endif
447
407
 
448
408
  /****** PG::Connection CLASS CONSTANTS: Nonblocking connection polling status ******/
449
409
 
@@ -458,27 +418,48 @@ Init_pg_ext()
458
418
 
459
419
  /****** PG::Connection CLASS CONSTANTS: Transaction Status ******/
460
420
 
461
- /* Transaction is currently idle (#transaction_status) */
421
+ /* Transaction is currently idle ( Connection#transaction_status ) */
462
422
  rb_define_const(rb_mPGconstants, "PQTRANS_IDLE", INT2FIX(PQTRANS_IDLE));
463
- /* Transaction is currently active; query has been sent to the server, but not yet completed. (#transaction_status) */
423
+ /* Transaction is currently active; query has been sent to the server, but not yet completed. ( Connection#transaction_status ) */
464
424
  rb_define_const(rb_mPGconstants, "PQTRANS_ACTIVE", INT2FIX(PQTRANS_ACTIVE));
465
- /* Transaction is currently idle, in a valid transaction block (#transaction_status) */
425
+ /* Transaction is currently idle, in a valid transaction block ( Connection#transaction_status ) */
466
426
  rb_define_const(rb_mPGconstants, "PQTRANS_INTRANS", INT2FIX(PQTRANS_INTRANS));
467
- /* Transaction is currently idle, in a failed transaction block (#transaction_status) */
427
+ /* Transaction is currently idle, in a failed transaction block ( Connection#transaction_status ) */
468
428
  rb_define_const(rb_mPGconstants, "PQTRANS_INERROR", INT2FIX(PQTRANS_INERROR));
469
- /* Transaction's connection is bad (#transaction_status) */
429
+ /* Transaction's connection is bad ( Connection#transaction_status ) */
470
430
  rb_define_const(rb_mPGconstants, "PQTRANS_UNKNOWN", INT2FIX(PQTRANS_UNKNOWN));
471
431
 
472
432
  /****** PG::Connection CLASS CONSTANTS: Error Verbosity ******/
473
433
 
474
- /* Terse error verbosity level (#set_error_verbosity) */
434
+ /* Error verbosity level ( Connection#set_error_verbosity ).
435
+ * In TERSE mode, returned messages include severity, primary text, and position only; this will normally fit on a single line. */
475
436
  rb_define_const(rb_mPGconstants, "PQERRORS_TERSE", INT2FIX(PQERRORS_TERSE));
476
- /* Default error verbosity level (#set_error_verbosity) */
437
+ /* Error verbosity level ( Connection#set_error_verbosity ).
438
+ * The DEFAULT mode produces messages that include the above plus any detail, hint, or context fields (these might span multiple lines). */
477
439
  rb_define_const(rb_mPGconstants, "PQERRORS_DEFAULT", INT2FIX(PQERRORS_DEFAULT));
478
- /* Verbose error verbosity level (#set_error_verbosity) */
440
+ /* Error verbosity level ( Connection#set_error_verbosity ).
441
+ * The VERBOSE mode includes all available fields. */
479
442
  rb_define_const(rb_mPGconstants, "PQERRORS_VERBOSE", INT2FIX(PQERRORS_VERBOSE));
480
443
 
481
- #ifdef HAVE_PQPING
444
+ /* PQERRORS_SQLSTATE was introduced in PG-12 together with PQresultMemorySize() */
445
+ #ifdef HAVE_PQRESULTMEMORYSIZE
446
+ /* Error verbosity level ( Connection#set_error_verbosity ).
447
+ * 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).
448
+ *
449
+ * Available since PostgreSQL-12.
450
+ */
451
+ rb_define_const(rb_mPGconstants, "PQERRORS_SQLSTATE", INT2FIX(PQERRORS_SQLSTATE));
452
+ #endif
453
+
454
+ #ifdef HAVE_PQRESULTVERBOSEERRORMESSAGE
455
+ /* See Connection#set_error_context_visibility */
456
+ rb_define_const(rb_mPGconstants, "PQSHOW_CONTEXT_NEVER", INT2FIX(PQSHOW_CONTEXT_NEVER));
457
+ /* See Connection#set_error_context_visibility */
458
+ rb_define_const(rb_mPGconstants, "PQSHOW_CONTEXT_ERRORS", INT2FIX(PQSHOW_CONTEXT_ERRORS));
459
+ /* See Connection#set_error_context_visibility */
460
+ rb_define_const(rb_mPGconstants, "PQSHOW_CONTEXT_ALWAYS", INT2FIX(PQSHOW_CONTEXT_ALWAYS));
461
+ #endif
462
+
482
463
  /****** PG::Connection CLASS CONSTANTS: Check Server Status ******/
483
464
 
484
465
  /* Server is accepting connections. */
@@ -489,163 +470,206 @@ Init_pg_ext()
489
470
  rb_define_const(rb_mPGconstants, "PQPING_NO_RESPONSE", INT2FIX(PQPING_NO_RESPONSE));
490
471
  /* Connection not attempted (bad params). */
491
472
  rb_define_const(rb_mPGconstants, "PQPING_NO_ATTEMPT", INT2FIX(PQPING_NO_ATTEMPT));
492
- #endif
493
473
 
494
474
  /****** PG::Connection CLASS CONSTANTS: Large Objects ******/
495
475
 
496
- /* Flag for #lo_creat, #lo_open -- open for writing */
476
+ /* Flag for Connection#lo_creat, Connection#lo_open -- open for writing */
497
477
  rb_define_const(rb_mPGconstants, "INV_WRITE", INT2FIX(INV_WRITE));
498
- /* Flag for #lo_creat, #lo_open -- open for reading */
478
+ /* Flag for Connection#lo_creat, Connection#lo_open -- open for reading */
499
479
  rb_define_const(rb_mPGconstants, "INV_READ", INT2FIX(INV_READ));
500
- /* Flag for #lo_lseek -- seek from object start */
480
+ /* Flag for Connection#lo_lseek -- seek from object start */
501
481
  rb_define_const(rb_mPGconstants, "SEEK_SET", INT2FIX(SEEK_SET));
502
- /* Flag for #lo_lseek -- seek from current position */
482
+ /* Flag for Connection#lo_lseek -- seek from current position */
503
483
  rb_define_const(rb_mPGconstants, "SEEK_CUR", INT2FIX(SEEK_CUR));
504
- /* Flag for #lo_lseek -- seek from object end */
484
+ /* Flag for Connection#lo_lseek -- seek from object end */
505
485
  rb_define_const(rb_mPGconstants, "SEEK_END", INT2FIX(SEEK_END));
506
486
 
507
487
  /****** PG::Result CONSTANTS: result status ******/
508
488
 
509
- /* #result_status constant: The string sent to the server was empty. */
489
+ /* Result#result_status constant - The string sent to the server was empty. */
510
490
  rb_define_const(rb_mPGconstants, "PGRES_EMPTY_QUERY", INT2FIX(PGRES_EMPTY_QUERY));
511
- /* #result_status constant: Successful completion of a command returning no data. */
491
+ /* Result#result_status constant - Successful completion of a command returning no data. */
512
492
  rb_define_const(rb_mPGconstants, "PGRES_COMMAND_OK", INT2FIX(PGRES_COMMAND_OK));
513
- /* #result_status constant: Successful completion of a command returning data
514
- (such as a SELECT or SHOW). */
493
+ /* Result#result_status constant - Successful completion of a command returning data (such as a SELECT or SHOW). */
515
494
  rb_define_const(rb_mPGconstants, "PGRES_TUPLES_OK", INT2FIX(PGRES_TUPLES_OK));
516
- /* #result_status constant: Copy Out (from server) data transfer started. */
495
+ /* Result#result_status constant - Copy Out (from server) data transfer started. */
517
496
  rb_define_const(rb_mPGconstants, "PGRES_COPY_OUT", INT2FIX(PGRES_COPY_OUT));
518
- /* #result_status constant: Copy In (to server) data transfer started. */
497
+ /* Result#result_status constant - Copy In (to server) data transfer started. */
519
498
  rb_define_const(rb_mPGconstants, "PGRES_COPY_IN", INT2FIX(PGRES_COPY_IN));
520
- /* #result_status constant: The server’s response was not understood. */
499
+ /* Result#result_status constant - The server’s response was not understood. */
521
500
  rb_define_const(rb_mPGconstants, "PGRES_BAD_RESPONSE", INT2FIX(PGRES_BAD_RESPONSE));
522
- /* #result_status constant: A nonfatal error (a notice or warning) occurred. */
501
+ /* Result#result_status constant - A nonfatal error (a notice or warning) occurred. */
523
502
  rb_define_const(rb_mPGconstants, "PGRES_NONFATAL_ERROR",INT2FIX(PGRES_NONFATAL_ERROR));
524
- /* #result_status constant: A fatal error occurred. */
503
+ /* Result#result_status constant - A fatal error occurred. */
525
504
  rb_define_const(rb_mPGconstants, "PGRES_FATAL_ERROR", INT2FIX(PGRES_FATAL_ERROR));
526
- /* #result_status constant: Copy In/Out data transfer in progress. */
527
- #ifdef HAVE_CONST_PGRES_COPY_BOTH
505
+ /* Result#result_status constant - Copy In/Out data transfer in progress. */
528
506
  rb_define_const(rb_mPGconstants, "PGRES_COPY_BOTH", INT2FIX(PGRES_COPY_BOTH));
529
- #endif
530
- /* #result_status constant: Single tuple from larger resultset. */
531
- #ifdef HAVE_CONST_PGRES_SINGLE_TUPLE
507
+ /* Result#result_status constant - Single tuple from larger resultset. */
532
508
  rb_define_const(rb_mPGconstants, "PGRES_SINGLE_TUPLE", INT2FIX(PGRES_SINGLE_TUPLE));
509
+
510
+ #ifdef HAVE_PQENTERPIPELINEMODE
511
+ /* Result#result_status constant - The PG::Result represents a synchronization point in pipeline mode, requested by Connection#pipeline_sync.
512
+ *
513
+ * This status occurs only when pipeline mode has been selected. */
514
+ rb_define_const(rb_mPGconstants, "PGRES_PIPELINE_SYNC", INT2FIX(PGRES_PIPELINE_SYNC));
515
+
516
+ /* Result#result_status constant - The PG::Result represents a pipeline that has received an error from the server.
517
+ *
518
+ * Connection#get_result must be called repeatedly, and each time it will return this status code until the end of the current pipeline, at which point it will return PG::PGRES_PIPELINE_SYNC and normal processing can resume.
519
+ */
520
+ rb_define_const(rb_mPGconstants, "PGRES_PIPELINE_ABORTED", INT2FIX(PGRES_PIPELINE_ABORTED));
533
521
  #endif
534
522
 
535
523
  /****** Result CONSTANTS: result error field codes ******/
536
524
 
537
- /* #result_error_field argument constant: The severity; the field contents
538
- * are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE,
539
- * DEBUG, INFO, or LOG (in a notice message), or a localized translation
540
- * of one of these. Always present.
525
+ /* Result#result_error_field argument constant
526
+ *
527
+ * 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
528
+ * of one of these.
529
+ * Always present.
541
530
  */
542
531
  rb_define_const(rb_mPGconstants, "PG_DIAG_SEVERITY", INT2FIX(PG_DIAG_SEVERITY));
543
532
 
544
- /* #result_error_field argument constant: The SQLSTATE code for the
545
- * error. The SQLSTATE code identies the type of error that has occurred;
546
- * it can be used by front-end applications to perform specic operations
547
- * (such as er- ror handling) in response to a particular database
548
- * error. For a list of the possible SQLSTATE codes, see Appendix A.
549
- * This eld is not localizable, and is always present.
533
+ #ifdef PG_DIAG_SEVERITY_NONLOCALIZED
534
+ /* Result#result_error_field argument constant
535
+ *
536
+ * 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).
537
+ * This is identical to the PG_DIAG_SEVERITY field except that the contents are never localized.
538
+ *
539
+ * Available since PostgreSQL-9.6
540
+ */
541
+ rb_define_const(rb_mPGconstants, "PG_DIAG_SEVERITY_NONLOCALIZED", INT2FIX(PG_DIAG_SEVERITY_NONLOCALIZED));
542
+ #endif
543
+ /* Result#result_error_field argument constant
544
+ *
545
+ * The SQLSTATE code for the error.
546
+ * The SQLSTATE code identies the type of error that has occurred; it can be used by front-end applications to perform specific operations (such as error handling) in response to a particular database error.
547
+ * For a list of the possible SQLSTATE codes, see Appendix A.
548
+ * This field is not localizable, and is always present.
550
549
  */
551
550
  rb_define_const(rb_mPGconstants, "PG_DIAG_SQLSTATE", INT2FIX(PG_DIAG_SQLSTATE));
552
-
553
- /* #result_error_field argument constant: The primary human-readable
554
- * error message (typically one line). Always present. */
551
+ /* Result#result_error_field argument constant
552
+ *
553
+ * The primary human-readable error message (typically one line).
554
+ * Always present. */
555
555
  rb_define_const(rb_mPGconstants, "PG_DIAG_MESSAGE_PRIMARY", INT2FIX(PG_DIAG_MESSAGE_PRIMARY));
556
-
557
- /* #result_error_field argument constant: Detail: an optional secondary
558
- * error message carrying more detail about the problem. Might run to
559
- * multiple lines.
556
+ /* Result#result_error_field argument constant
557
+ *
558
+ * Detail: an optional secondary error message carrying more detail about the problem.
559
+ * Might run to multiple lines.
560
560
  */
561
561
  rb_define_const(rb_mPGconstants, "PG_DIAG_MESSAGE_DETAIL", INT2FIX(PG_DIAG_MESSAGE_DETAIL));
562
-
563
- /* #result_error_field argument constant: Hint: an optional suggestion
564
- * what to do about the problem. This is intended to differ from detail
565
- * in that it offers advice (potentially inappropriate) rather than
566
- * hard facts. Might run to multiple lines.
562
+ /* Result#result_error_field argument constant
563
+ *
564
+ * Hint: an optional suggestion what to do about the problem.
565
+ * This is intended to differ from detail in that it offers advice (potentially inappropriate) rather than hard facts.
566
+ * Might run to multiple lines.
567
567
  */
568
-
569
568
  rb_define_const(rb_mPGconstants, "PG_DIAG_MESSAGE_HINT", INT2FIX(PG_DIAG_MESSAGE_HINT));
570
- /* #result_error_field argument constant: A string containing a decimal
571
- * integer indicating an error cursor position as an index into the
572
- * original statement string. The rst character has index 1, and
573
- * positions are measured in characters not bytes.
569
+ /* Result#result_error_field argument constant
570
+ *
571
+ * A string containing a decimal integer indicating an error cursor position as an index into the original statement string.
572
+ *
573
+ * The first character has index 1, and positions are measured in characters not bytes.
574
574
  */
575
-
576
575
  rb_define_const(rb_mPGconstants, "PG_DIAG_STATEMENT_POSITION", INT2FIX(PG_DIAG_STATEMENT_POSITION));
577
- /* #result_error_field argument constant: This is dened the same as
578
- * the PG_DIAG_STATEMENT_POSITION eld, but it is used when the cursor
579
- * position refers to an internally generated command rather than the
580
- * one submitted by the client. The PG_DIAG_INTERNAL_QUERY eld will
581
- * always appear when this eld appears.
576
+ /* Result#result_error_field argument constant
577
+ *
578
+ * 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.
579
+ * The PG_DIAG_INTERNAL_QUERY field will always appear when this field appears.
582
580
  */
583
-
584
581
  rb_define_const(rb_mPGconstants, "PG_DIAG_INTERNAL_POSITION", INT2FIX(PG_DIAG_INTERNAL_POSITION));
585
- /* #result_error_field argument constant: The text of a failed
586
- * internally-generated command. This could be, for example, a SQL
587
- * query issued by a PL/pgSQL function.
582
+ /* Result#result_error_field argument constant
583
+ *
584
+ * The text of a failed internally-generated command.
585
+ * This could be, for example, a SQL query issued by a PL/pgSQL function.
588
586
  */
589
-
590
587
  rb_define_const(rb_mPGconstants, "PG_DIAG_INTERNAL_QUERY", INT2FIX(PG_DIAG_INTERNAL_QUERY));
591
- /* #result_error_field argument constant: An indication of the context
592
- * in which the error occurred. Presently this includes a call stack
593
- * traceback of active procedural language functions and internally-generated
594
- * queries. The trace is one entry per line, most recent rst.
588
+ /* Result#result_error_field argument constant
589
+ *
590
+ * An indication of the context in which the error occurred.
591
+ * Presently this includes a call stack traceback of active procedural language functions and internally-generated queries.
592
+ * The trace is one entry per line, most recent first.
595
593
  */
596
-
597
594
  rb_define_const(rb_mPGconstants, "PG_DIAG_CONTEXT", INT2FIX(PG_DIAG_CONTEXT));
598
- /* #result_error_field argument constant: The le name of the source-code
599
- * location where the error was reported. */
595
+ /* Result#result_error_field argument constant
596
+ *
597
+ * The file name of the source-code location where the error was reported. */
600
598
  rb_define_const(rb_mPGconstants, "PG_DIAG_SOURCE_FILE", INT2FIX(PG_DIAG_SOURCE_FILE));
601
599
 
602
- /* #result_error_field argument constant: The line number of the
603
- * source-code location where the error was reported. */
600
+ /* Result#result_error_field argument constant
601
+ *
602
+ * The line number of the source-code location where the error was reported. */
604
603
  rb_define_const(rb_mPGconstants, "PG_DIAG_SOURCE_LINE", INT2FIX(PG_DIAG_SOURCE_LINE));
605
604
 
606
- /* #result_error_field argument constant: The name of the source-code
607
- * function reporting the error. */
605
+ /* Result#result_error_field argument constant
606
+ *
607
+ * The name of the source-code function reporting the error. */
608
608
  rb_define_const(rb_mPGconstants, "PG_DIAG_SOURCE_FUNCTION", INT2FIX(PG_DIAG_SOURCE_FUNCTION));
609
609
 
610
- #ifdef HAVE_CONST_PG_DIAG_TABLE_NAME
611
- /* #result_error_field argument constant: If the error was associated with a
612
- * specific database object, the name of the schema containing that object, if any. */
610
+ #ifdef PG_DIAG_TABLE_NAME
611
+ /* Result#result_error_field argument constant
612
+ *
613
+ * If the error was associated with a specific database object, the name of the schema containing that object, if any. */
613
614
  rb_define_const(rb_mPGconstants, "PG_DIAG_SCHEMA_NAME", INT2FIX(PG_DIAG_SCHEMA_NAME));
614
615
 
615
- /* #result_error_field argument constant: If the error was associated with a
616
- *specific table, the name of the table. (When this field is present, the schema name
617
- * field provides the name of the table's schema.) */
616
+ /* Result#result_error_field argument constant
617
+ *
618
+ * If the error was associated with a specific table, the name of the table.
619
+ * (When this field is present, the schema name field provides the name of the table's schema.) */
618
620
  rb_define_const(rb_mPGconstants, "PG_DIAG_TABLE_NAME", INT2FIX(PG_DIAG_TABLE_NAME));
619
621
 
620
- /* #result_error_field argument constant: If the error was associated with a
621
- * specific table column, the name of the column. (When this field is present, the
622
- * schema and table name fields identify the table.) */
622
+ /* Result#result_error_field argument constant
623
+ *
624
+ * If the error was associated with a specific table column, the name of the column.
625
+ * (When this field is present, the schema and table name fields identify the table.) */
623
626
  rb_define_const(rb_mPGconstants, "PG_DIAG_COLUMN_NAME", INT2FIX(PG_DIAG_COLUMN_NAME));
624
627
 
625
- /* #result_error_field argument constant: If the error was associated with a
626
- * specific datatype, the name of the datatype. (When this field is present, the
627
- * schema name field provides the name of the datatype's schema.) */
628
+ /* Result#result_error_field argument constant
629
+ *
630
+ * If the error was associated with a specific datatype, the name of the datatype.
631
+ * (When this field is present, the schema name field provides the name of the datatype's schema.) */
628
632
  rb_define_const(rb_mPGconstants, "PG_DIAG_DATATYPE_NAME", INT2FIX(PG_DIAG_DATATYPE_NAME));
629
633
 
630
- /* #result_error_field argument constant: If the error was associated with a
631
- * specific constraint, the name of the constraint. The table or domain that the
632
- * constraint belongs to is reported using the fields listed above. (For this
633
- * purpose, indexes are treated as constraints, even if they weren't created with
634
- * constraint syntax.) */
634
+ /* Result#result_error_field argument constant
635
+ *
636
+ * If the error was associated with a specific constraint, the name of the constraint.
637
+ * The table or domain that the constraint belongs to is reported using the fields listed above.
638
+ * (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.) */
635
639
  rb_define_const(rb_mPGconstants, "PG_DIAG_CONSTRAINT_NAME", INT2FIX(PG_DIAG_CONSTRAINT_NAME));
636
640
  #endif
637
641
 
642
+ #ifdef HAVE_PQENTERPIPELINEMODE
643
+ /* Connection#pipeline_status constant
644
+ *
645
+ * The libpq connection is in pipeline mode.
646
+ */
647
+ rb_define_const(rb_mPGconstants, "PQ_PIPELINE_ON", INT2FIX(PQ_PIPELINE_ON));
648
+
649
+ /* Connection#pipeline_status constant
650
+ *
651
+ * The libpq connection is not in pipeline mode.
652
+ */
653
+ rb_define_const(rb_mPGconstants, "PQ_PIPELINE_OFF", INT2FIX(PQ_PIPELINE_OFF));
654
+
655
+ /* Connection#pipeline_status constant
656
+ *
657
+ * The libpq connection is in pipeline mode and an error occurred while processing the current pipeline.
658
+ * The aborted flag is cleared when PQgetResult returns a result of type PGRES_PIPELINE_SYNC.
659
+ */
660
+ rb_define_const(rb_mPGconstants, "PQ_PIPELINE_ABORTED", INT2FIX(PQ_PIPELINE_ABORTED));
661
+ #endif
662
+
638
663
  /* Invalid OID constant */
639
664
  rb_define_const(rb_mPGconstants, "INVALID_OID", INT2FIX(InvalidOid));
640
665
  rb_define_const(rb_mPGconstants, "InvalidOid", INT2FIX(InvalidOid));
641
666
 
667
+ /* PostgreSQL compiled in default port */
668
+ rb_define_const(rb_mPGconstants, "DEF_PGPORT", INT2FIX(DEF_PGPORT));
669
+
642
670
  /* Add the constants to the toplevel namespace */
643
671
  rb_include_module( rb_mPG, rb_mPGconstants );
644
672
 
645
- #ifdef M17N_SUPPORTED
646
- enc_pg2ruby = st_init_numtable();
647
- #endif
648
-
649
673
  /* Initialize the main extension classes */
650
674
  init_pg_connection();
651
675
  init_pg_result();
@@ -663,5 +687,6 @@ Init_pg_ext()
663
687
  init_pg_binary_encoder();
664
688
  init_pg_binary_decoder();
665
689
  init_pg_copycoder();
690
+ init_pg_recordcoder();
691
+ init_pg_tuple();
666
692
  }
667
-