pg 1.1.3 → 1.3.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (117) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/.appveyor.yml +36 -0
  4. data/.gems +6 -0
  5. data/.github/workflows/binary-gems.yml +86 -0
  6. data/.github/workflows/source-gem.yml +129 -0
  7. data/.gitignore +13 -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.rdoc +210 -6
  16. data/Manifest.txt +3 -3
  17. data/README-Windows.rdoc +4 -4
  18. data/README.ja.rdoc +1 -2
  19. data/README.rdoc +51 -15
  20. data/Rakefile +31 -140
  21. data/Rakefile.cross +60 -56
  22. data/certs/ged.pem +24 -0
  23. data/certs/larskanis-2022.pem +26 -0
  24. data/ext/errorcodes.def +76 -0
  25. data/ext/errorcodes.txt +21 -2
  26. data/ext/extconf.rb +101 -26
  27. data/ext/gvl_wrappers.c +4 -0
  28. data/ext/gvl_wrappers.h +23 -0
  29. data/ext/pg.c +190 -98
  30. data/ext/pg.h +42 -17
  31. data/ext/pg_binary_decoder.c +20 -16
  32. data/ext/pg_binary_encoder.c +13 -12
  33. data/ext/pg_coder.c +95 -29
  34. data/ext/pg_connection.c +1043 -769
  35. data/ext/pg_copy_coder.c +50 -18
  36. data/ext/pg_record_coder.c +519 -0
  37. data/ext/pg_result.c +326 -142
  38. data/ext/pg_text_decoder.c +15 -9
  39. data/ext/pg_text_encoder.c +185 -53
  40. data/ext/pg_tuple.c +61 -27
  41. data/ext/pg_type_map.c +42 -9
  42. data/ext/pg_type_map_all_strings.c +19 -5
  43. data/ext/pg_type_map_by_class.c +54 -24
  44. data/ext/pg_type_map_by_column.c +73 -34
  45. data/ext/pg_type_map_by_mri_type.c +48 -19
  46. data/ext/pg_type_map_by_oid.c +55 -25
  47. data/ext/pg_type_map_in_ruby.c +51 -20
  48. data/ext/{util.c → pg_util.c} +7 -7
  49. data/ext/{util.h → pg_util.h} +0 -0
  50. data/lib/pg/basic_type_map_based_on_result.rb +47 -0
  51. data/lib/pg/basic_type_map_for_queries.rb +193 -0
  52. data/lib/pg/basic_type_map_for_results.rb +81 -0
  53. data/lib/pg/basic_type_registry.rb +296 -0
  54. data/lib/pg/binary_decoder.rb +1 -0
  55. data/lib/pg/coder.rb +23 -2
  56. data/lib/pg/connection.rb +589 -59
  57. data/lib/pg/constants.rb +1 -0
  58. data/lib/pg/exceptions.rb +1 -0
  59. data/lib/pg/result.rb +13 -1
  60. data/lib/pg/text_decoder.rb +2 -3
  61. data/lib/pg/text_encoder.rb +8 -18
  62. data/lib/pg/type_map_by_column.rb +2 -1
  63. data/lib/pg/version.rb +4 -0
  64. data/lib/pg.rb +48 -33
  65. data/misc/openssl-pg-segfault.rb +31 -0
  66. data/misc/postgres/History.txt +9 -0
  67. data/misc/postgres/Manifest.txt +5 -0
  68. data/misc/postgres/README.txt +21 -0
  69. data/misc/postgres/Rakefile +21 -0
  70. data/misc/postgres/lib/postgres.rb +16 -0
  71. data/misc/ruby-pg/History.txt +9 -0
  72. data/misc/ruby-pg/Manifest.txt +5 -0
  73. data/misc/ruby-pg/README.txt +21 -0
  74. data/misc/ruby-pg/Rakefile +21 -0
  75. data/misc/ruby-pg/lib/ruby/pg.rb +16 -0
  76. data/pg.gemspec +32 -0
  77. data/rakelib/task_extension.rb +46 -0
  78. data/sample/array_insert.rb +20 -0
  79. data/sample/async_api.rb +106 -0
  80. data/sample/async_copyto.rb +39 -0
  81. data/sample/async_mixed.rb +56 -0
  82. data/sample/check_conn.rb +21 -0
  83. data/sample/copydata.rb +71 -0
  84. data/sample/copyfrom.rb +81 -0
  85. data/sample/copyto.rb +19 -0
  86. data/sample/cursor.rb +21 -0
  87. data/sample/disk_usage_report.rb +177 -0
  88. data/sample/issue-119.rb +94 -0
  89. data/sample/losample.rb +69 -0
  90. data/sample/minimal-testcase.rb +17 -0
  91. data/sample/notify_wait.rb +72 -0
  92. data/sample/pg_statistics.rb +285 -0
  93. data/sample/replication_monitor.rb +222 -0
  94. data/sample/test_binary_values.rb +33 -0
  95. data/sample/wal_shipper.rb +434 -0
  96. data/sample/warehouse_partitions.rb +311 -0
  97. data.tar.gz.sig +0 -0
  98. metadata +94 -237
  99. metadata.gz.sig +0 -0
  100. data/ChangeLog +0 -6595
  101. data/lib/pg/basic_type_mapping.rb +0 -459
  102. data/spec/data/expected_trace.out +0 -26
  103. data/spec/data/random_binary_data +0 -0
  104. data/spec/helpers.rb +0 -381
  105. data/spec/pg/basic_type_mapping_spec.rb +0 -508
  106. data/spec/pg/connection_spec.rb +0 -1849
  107. data/spec/pg/connection_sync_spec.rb +0 -41
  108. data/spec/pg/result_spec.rb +0 -491
  109. data/spec/pg/tuple_spec.rb +0 -280
  110. data/spec/pg/type_map_by_class_spec.rb +0 -138
  111. data/spec/pg/type_map_by_column_spec.rb +0 -222
  112. data/spec/pg/type_map_by_mri_type_spec.rb +0 -136
  113. data/spec/pg/type_map_by_oid_spec.rb +0 -149
  114. data/spec/pg/type_map_in_ruby_spec.rb +0 -164
  115. data/spec/pg/type_map_spec.rb +0 -22
  116. data/spec/pg/type_spec.rb +0 -949
  117. data/spec/pg_spec.rb +0 -50
data/History.rdoc CHANGED
@@ -1,3 +1,207 @@
1
+ == v1.3.3 [2022-02-22] Lars Kanis <lars@greiz-reinsdorf.de>
2
+
3
+ Bugfixes:
4
+
5
+ - Fix omission of the third digit of IPv4 addresses in connection URI. #435
6
+ - Fix wrong permission of certs/larskanis-2022.pem in the pg-1.3.2.gem. #432
7
+
8
+
9
+ == v1.3.2 [2022-02-14] Lars Kanis <lars@greiz-reinsdorf.de>
10
+
11
+ Bugfixes:
12
+
13
+ - Cancel only active query after failing transaction. #430
14
+ This avoids an incompatibility with pgbouncer since pg-1.3.0.
15
+ - Fix String objects with non-applied encoding when using COPY or record decoders. #427
16
+ - Update Windows fat binary gem to PostgreSQL-14.2.
17
+
18
+ Enhancements:
19
+
20
+ - Improve extconf.rb checks to reduces the number of compiler calls.
21
+ - Add a check for PGRES_PIPELINE_SYNC, to make sure the library version and the header files are PostgreSQL-14+. #429
22
+
23
+
24
+ == v1.3.1 [2022-02-01] Michael Granger <ged@FaerieMUD.org>
25
+
26
+ Bugfixes:
27
+
28
+ - Fix wrong handling of socket writability on Windows introduced in #417.
29
+ This caused starvation in conn.put_copy_data.
30
+ - Fix error in PG.version_string(true). #419
31
+ - Fix a regression in pg 1.3.0 where Ruby 2.x busy-looping any fractional seconds for every wait. #420
32
+
33
+ Enhancements:
34
+
35
+ - Raise an error when conn.copy_data is used in nonblocking mode.
36
+
37
+
38
+ == v1.3.0 [2022-01-20] Michael Granger <ged@FaerieMUD.org>
39
+
40
+ Install Enhancements:
41
+ - Print some install help if libpq wasn't found. #396
42
+ This should help to pick the necessary package without googling.
43
+ - Update Windows fat binary gem to OpenSSL-1.1.1m and PostgreSQL-14.1.
44
+ - Add binary Windows gems for Ruby 3.0 and 3.1.
45
+ - Make the library path of libpq available in ruby as PG::POSTGRESQL_LIB_PATH and add it to the search paths on Windows similar to +rpath+ on Unix systems. #373
46
+ - Fall back to pkg-config if pg_config is not found. #380
47
+ - Add option to extconf.rb to disable nogvl-wrapping of libpq functions.
48
+ All methods (except PG::Connection.ping) are nonblocking now, so that GVL unlock is in theory no longer necessary.
49
+ However it can have some advantage in concurrency, so that GVL unlock is still enabled by default.
50
+ Use:
51
+ - gem inst pg -- --disable-gvl-unlock
52
+
53
+ API Enhancements:
54
+ - Add full compatibility to Fiber.scheduler introduced in Ruby-3.0. #397
55
+ - Add async_connect and async_send methods and add specific specs for Fiber.scheduler #342
56
+ - Add async_get_result and async_get_last_result
57
+ - Add async_get_copy_data
58
+ - Implement async_put_copy_data/async_put_copy_end
59
+ - Implement async_reset method using the nonblocking libpq API
60
+ - Add async_set_client_encoding which is compatible to scheduler
61
+ - Add async_cancel as a nonblocking version of conn#cancel
62
+ - Add async_encrypt_password
63
+ - Run Connection.ping in a second thread.
64
+ - Make discard_results scheduler friendly
65
+ - Do all socket waiting through the conn.socket_io object.
66
+ - Avoid PG.connect blocking while address resolution by automatically providing the +hostaddr+ parameter and resolving in Ruby instead of libpq.
67
+ - On Windows Fiber.scheduler support requires Ruby-3.1+.
68
+ It is also only partly usable since may ruby IO methods are not yet scheduler aware on Windows.
69
+ - Add support for pipeline mode of PostgreSQL-14. #401
70
+ - Allow specification of multiple hosts in PostgreSQL URI. #387
71
+ - Add new method conn.backend_key - used to implement our own cancel method.
72
+
73
+ Type cast enhancements:
74
+ - Add PG::BasicTypeMapForQueries::BinaryData for encoding of bytea columns. #348
75
+ - Reduce time to build coder maps and permit to reuse them for several type maps per PG::BasicTypeRegistry::CoderMapsBundle.new(conn) . #376
76
+ - Make BasicTypeRegistry a class and use a global default instance of it.
77
+ Now a local type registry can be instanciated and given to the type map, to avoid changing shared global states.
78
+ - Allow PG::BasicTypeMapForQueries to take a Proc as callback for undefined types.
79
+
80
+ Other Enhancements:
81
+ - Convert all PG classes implemented in C to TypedData objects. #349
82
+ - Support ObjectSpace.memsize_of(obj) on all classes implemented in C. #393
83
+ - Make all PG objects implemented in C memory moveable and therefore GC.compact friendly. #349
84
+ - Update errorcodes and error classes to PostgreSQL-14.0.
85
+ - Add PG::CONNECTION_* constants for conn.status of newer PostgreSQL versions.
86
+ - Add better support for logical replication. #339
87
+ - Change conn.socket_io to read+write mode and to a BasicSocket object instead of IO.
88
+ - Use rb_io_wait() and the conn.socket_io object if available for better compatibility to Fiber.scheduler .
89
+ Fall back to rb_wait_for_single_fd() on ruby < 3.0.
90
+ - On Windows use a specialized wait function as a workaround for very poor performance of rb_io_wait(). #416
91
+
92
+ Bugfixes:
93
+ - Release GVL while calling PQping which is a blocking method, but it didn't release GVL so far.
94
+ - Fix Connection#transaction to no longer block on interrupts, for instance when pressing Ctrl-C and cancel a running query. #390
95
+ - Avoid casting of OIDs to fix compat with Redshift database. #369
96
+ - Call conn.block before each conn.get_result call to avoid possible blocking in case of a slow network and multiple query results.
97
+ - Sporadic Errno::ENOTSOCK when using conn.socket_io on Windows #398
98
+
99
+ Deprecated:
100
+ - Add deprecation warning to PG::BasicTypeRegistry.register_type and siblings.
101
+
102
+ Removed:
103
+ - Remove support of ruby-2.2, 2.3 and 2.4. Minimum is ruby-2.5 now.
104
+ - Remove support for PostgreSQL-9.2. Minimum is PostgreSQL-9.3 now.
105
+ - Remove constant PG::REVISION, which was broken since pg-1.1.4.
106
+
107
+ Repository:
108
+ - Replace Hoe by Bundler for gem packaging
109
+ - Add Github Actions CI and testing of source and binary gems.
110
+
111
+
112
+ == v1.2.3 [2020-03-18] Michael Granger <ged@FaerieMUD.org>
113
+
114
+ Bugfixes:
115
+
116
+ - Fix possible segfault at `PG::Coder#encode`, `decode` or their implicit calls through
117
+ a typemap after GC.compact. #327
118
+ - Fix possible segfault in `PG::TypeMapByClass` after GC.compact. #328
119
+
120
+
121
+ == v1.2.2 [2020-01-06] Michael Granger <ged@FaerieMUD.org>
122
+
123
+ Enhancements:
124
+
125
+ - Add a binary gem for Ruby 2.7.
126
+
127
+
128
+ == v1.2.1 [2020-01-02] Michael Granger <ged@FaerieMUD.org>
129
+
130
+ Enhancements:
131
+
132
+ - Added internal API for sequel_pg compatibility.
133
+
134
+
135
+ == v1.2.0 [2019-12-20] Michael Granger <ged@FaerieMUD.org>
136
+
137
+ Repository:
138
+ - Our primary repository has been moved to Github https://github.com/ged/ruby-pg .
139
+ Most of the issues from https://bitbucket.org/ged/ruby-pg have been migrated. #43
140
+
141
+ API enhancements:
142
+ - Add PG::Result#field_name_type= and siblings to allow symbols to be used as field names. #306
143
+ - Add new methods for error reporting:
144
+ - PG::Connection#set_error_context_visibility
145
+ - PG::Result#verbose_error_message
146
+ - PG::Result#result_verbose_error_message (alias)
147
+ - Update errorcodes and error classes to PostgreSQL-12.0.
148
+ - New constants: PG_DIAG_SEVERITY_NONLOCALIZED, PQERRORS_SQLSTATE, PQSHOW_CONTEXT_NEVER, PQSHOW_CONTEXT_ERRORS, PQSHOW_CONTEXT_ALWAYS
149
+
150
+ Type cast enhancements:
151
+ - Add PG::TextEncoder::Record and PG::TextDecoder::Record for en/decoding of Composite Types. #258, #36
152
+ - Add PG::BasicTypeRegistry.register_coder to register instances instead of classes.
153
+ This is useful to register parametrized en/decoders like PG::TextDecoder::Record .
154
+ - Add PG::BasicTypeMapForQueries#encode_array_as= to switch between various interpretations of ruby arrays.
155
+ - Add Time, Array<Time>, Array<BigDecimal> and Array<IPAddr> encoders to PG::BasicTypeMapForQueries
156
+ - Exchange sprintf based float encoder by very fast own implementation with more natural format. #301
157
+ - Define encode and decode methods only in en/decoders that implement it, so that they can be queried by respond_to? .
158
+ - Improve PG::TypeMapByColumn#inspect
159
+ - Accept Integer and Float as input to TextEncoder::Numeric . #310
160
+
161
+ Other enhancements:
162
+ - Allocate the data part and the ruby object of PG::Result in one step, so that we don't need to check for valid data.
163
+ This removes PG::Result.allocate and PG::Result.new, which were callable but without any practical use. #42
164
+ - Make use of PQresultMemorySize() of PostgreSQL-12 and fall back to our internal estimator.
165
+ - Improve performance of PG::Result#stream_each_tuple .
166
+ - Store client encoding in data part of PG::Connection and PG::Result objects, so that we no longer use ruby's internal encoding bits. #280
167
+ - Update Windows fat binary gem to OpenSSL-1.1.1d and PostgreSQL-12.1.
168
+ - Add support for TruffleRuby. It is regularly tested as part of our CI.
169
+ - Enable +frozen_string_literal+ in all pg's ruby files
170
+
171
+ Bugfixes:
172
+ - Update the license in gemspec to "BSD-2-Clause".
173
+ It was incorrectly labeled "BSD-3-Clause". #40
174
+ - Respect PG::Coder#flags in PG::Coder#to_h.
175
+ - Fix PG::Result memsize reporting after #clear.
176
+ - Release field names to GC on PG::Result#clear.
177
+ - Fix double free in PG::Result#stream_each_tuple when an exception is raised in the block.
178
+ - Fix PG::Result#stream_each_tuple to deliver typemapped values.
179
+ - Fix encoding of Array<unknown> with PG::BasicTypeMapForQueries
180
+
181
+ Deprecated:
182
+ - Add a deprecation warning to PG::Connection#socket .
183
+
184
+ Removed:
185
+ - Remove PG::Connection#guess_result_memsize= which was temporary added in pg-1.1.
186
+ - Remove PG::Result.allocate and PG::Result.new (see enhancements).
187
+ - Remove support of tainted objects. #307
188
+ - Remove support of ruby-2.0 and 2.1. Minimum is ruby-2.2 now.
189
+
190
+ Documentation:
191
+ - Update description of connection params. See PG::Connection.new
192
+ - Link many method descriptions to corresponding libpq's documentation.
193
+ - Update sync_* and async_* query method descriptions and document the aliases.
194
+ The primary documentation is now at the async_* methods which are the default since pg-1.1.
195
+ - Fix documentation of many constants
196
+
197
+
198
+ == v1.1.4 [2019-01-08] Michael Granger <ged@FaerieMUD.org>
199
+
200
+ - Fix PG::BinaryDecoder::Timestamp on 32 bit systems. # 284
201
+ - Add new error-codes of PostgreSQL-11.
202
+ - Add ruby-2.6 support for Windows fat binary gems and remove ruby-2.0 and 2.1.
203
+
204
+
1
205
  == v1.1.3 [2018-09-06] Michael Granger <ged@FaerieMUD.org>
2
206
 
3
207
  - Revert opimization that was sometimes causing EBADF in rb_wait_for_single_fd().
@@ -24,10 +228,10 @@ Deprecated (disable warnings per PG_SKIP_DEPRECATION_WARNING=1):
24
228
  - Forwarding conn.async_exec_params to conn.async_exec is deprecated.
25
229
 
26
230
  PG::Connection enhancements:
27
- - Provide PG::Connection#sync_* and PG::Connection#async_* query methods for explicit calling syncronous or asynchronous libpq API.
231
+ - Provide PG::Connection#sync_* and PG::Connection#async_* query methods for explicit calling synchronous or asynchronous libpq API.
28
232
  - Make PG::Connection#exec and siblings switchable between sync and async API per PG::Connection.async_api= and change the default to async flavors.
29
233
  - Add async flavors of exec_params, prepare, exec_prepared, describe_prepared and describe_portal.
30
- They are identical to their syncronous counterpart, but make use of PostgreSQL's async API.
234
+ They are identical to their synchronous counterpart, but make use of PostgreSQL's async API.
31
235
  - Replace `rb_thread_fd_select()` by faster `rb_wait_for_single_fd()` in `conn.block` and `conn.async_exec` .
32
236
  - Add PG::Connection#discard_results .
33
237
  - Raise an ArgumentError for strings containing zero bytes by #escape, #escape_literal, #escape_identifier, #quote_ident and PG::TextEncoder::Identifier. These methods previously truncated strings.
@@ -182,7 +386,7 @@ Bugfixes:
182
386
  - Revert addition of PG::Connection#hostaddr [#202].
183
387
  - Fix decoding of fractional timezones and timestamps [#203]
184
388
  - Fixes for non-C99 compilers
185
- - Avoid possible symbol name clash when linking againt static libpq.
389
+ - Avoid possible symbol name clash when linking against static libpq.
186
390
 
187
391
 
188
392
  == v0.18.1 [2015-01-05] Michael Granger <ged@FaerieMUD.org>
@@ -218,7 +422,7 @@ Enhancements:
218
422
  Bugfixes:
219
423
 
220
424
  - Fix compatibility with signal handlers defined in Ruby. This reverts
221
- cancelation of queries running on top of the blocking libpq API (like
425
+ cancellation of queries running on top of the blocking libpq API (like
222
426
  Connection#exec) in case of signals. As an alternative the #async_exec
223
427
  can be used, which is reverted to use the non-blocking API, again.
224
428
  - Wrap PQcancel to be called without GVL. It internally waits for
@@ -296,7 +500,7 @@ Enhancements:
296
500
 
297
501
  - Tested under Ruby 2.0.0p0.
298
502
  - Add single row mode of PostgreSQL 9.2.
299
- - Set fallback_application_name to programm name $0. Thanks to Will Leinweber
503
+ - Set fallback_application_name to program name $0. Thanks to Will Leinweber
300
504
  for the patch.
301
505
  - Release Ruby's GVL while calls to blocking libpq functions to allow better
302
506
  concurrency in threaded applications.
@@ -304,7 +508,7 @@ Enhancements:
304
508
  - Make use of rb_thread_fd_select() on Ruby 1.9 and avoid deprecated
305
509
  rb_thread_select().
306
510
  - Add an example of how to insert array data using a prepared statement (#145).
307
- - Add continous integration tests on travis-ci.org.
511
+ - Add continuous integration tests on travis-ci.org.
308
512
  - Add PG::Result#each_row for iterative over result sets by row. Thanks to
309
513
  Aaron Patterson for the patch.
310
514
  - Add a PG::Connection#socket_io method for fetching a (non-autoclosing) IO
data/Manifest.txt CHANGED
@@ -1,6 +1,5 @@
1
1
  .gemtest
2
2
  BSDL
3
- ChangeLog
4
3
  Contributors.rdoc
5
4
  History.rdoc
6
5
  LICENSE
@@ -26,6 +25,7 @@ ext/pg_coder.c
26
25
  ext/pg_connection.c
27
26
  ext/pg_copy_coder.c
28
27
  ext/pg_errors.c
28
+ ext/pg_record_coder.c
29
29
  ext/pg_result.c
30
30
  ext/pg_text_decoder.c
31
31
  ext/pg_text_encoder.c
@@ -37,8 +37,8 @@ ext/pg_type_map_by_column.c
37
37
  ext/pg_type_map_by_mri_type.c
38
38
  ext/pg_type_map_by_oid.c
39
39
  ext/pg_type_map_in_ruby.c
40
- ext/util.c
41
- ext/util.h
40
+ ext/pg_util.c
41
+ ext/pg_util.h
42
42
  ext/vc/pg.sln
43
43
  ext/vc/pg_18/pg.vcproj
44
44
  ext/vc/pg_19/pg_19.vcproj
data/README-Windows.rdoc CHANGED
@@ -35,8 +35,8 @@ Binary gems for windows can be built on Linux, OS-X and even on Windows
35
35
  with the help of docker. This is how regular windows gems are built for
36
36
  rubygems.org .
37
37
 
38
- To do this, install boot2docker [on Windows](https://github.com/boot2docker/windows-installer/releases)
39
- or [on OS X](https://github.com/boot2docker/osx-installer/releases) and make
38
+ To do this, install boot2docker {on Windows}[https://github.com/boot2docker/windows-installer/releases]
39
+ or {on OS X}[https://github.com/boot2docker/osx-installer/releases] and make
40
40
  sure it is started. A native Docker installation is best on Linux.
41
41
 
42
42
  Then run:
@@ -50,7 +50,7 @@ containing binaries for all supported ruby versions.
50
50
 
51
51
  == Reporting Problems
52
52
 
53
- If you have any problems you can submit them via
54
- [the project's issue-tracker][bitbucket]. And submit questions, problems, or
53
+ If you have any problems you can submit them via {the project's
54
+ issue-tracker}[https://github.com/ged/ruby-pg/issues]. And submit questions, problems, or
55
55
  solutions, so that it can be improved.
56
56
 
data/README.ja.rdoc CHANGED
@@ -1,7 +1,6 @@
1
1
  = pg
2
2
 
3
- home :: https://bitbucket.org/ged/ruby-pg
4
- mirror :: https://github.com/ged/ruby-pg
3
+ home :: https://github.com/ged/ruby-pg
5
4
  docs :: http://deveiate.org/code/pg
6
5
 
7
6
 
data/README.rdoc CHANGED
@@ -1,8 +1,8 @@
1
1
  = pg
2
2
 
3
- home :: https://bitbucket.org/ged/ruby-pg
4
- mirror :: https://github.com/ged/ruby-pg
3
+ home :: https://github.com/ged/ruby-pg
5
4
  docs :: http://deveiate.org/code/pg
5
+ clog :: link:/History.rdoc
6
6
 
7
7
  {<img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/ged/ruby-pg">}[https://gitter.im/ged/ruby-pg?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]
8
8
 
@@ -11,7 +11,7 @@ docs :: http://deveiate.org/code/pg
11
11
 
12
12
  Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/].
13
13
 
14
- It works with {PostgreSQL 9.2 and later}[http://www.postgresql.org/support/versioning/].
14
+ It works with {PostgreSQL 9.3 and later}[http://www.postgresql.org/support/versioning/].
15
15
 
16
16
  A small example usage:
17
17
 
@@ -25,22 +25,22 @@ A small example usage:
25
25
  puts " PID | User | Query"
26
26
  result.each do |row|
27
27
  puts " %7d | %-16s | %s " %
28
- row.values_at('procpid', 'usename', 'current_query')
28
+ row.values_at('pid', 'usename', 'query')
29
29
  end
30
30
  end
31
31
 
32
32
  == Build Status
33
33
 
34
- {<img src="https://travis-ci.org/ged/ruby-pg.svg?branch=master" alt="Build Status Travis-CI" />}[https://travis-ci.org/ged/ruby-pg]
35
- {<img src="https://ci.appveyor.com/api/projects/status/at4g4swb2cd4xji7/branch/master?svg=true" alt="Build Status Appveyor" />}[https://ci.appveyor.com/project/ged/ruby-pg]
36
-
34
+ {<img src="https://github.com/ged/ruby-pg/actions/workflows/source-gem.yml/badge.svg?branch=master" alt="Build Status Github Actions" />}[https://github.com/ged/ruby-pg/actions/workflows/source-gem.yml]
35
+ {<img src="https://ci.appveyor.com/api/projects/status/gjx5axouf3b1wicp?svg=true" alt="Build Status Appveyor" />}[https://ci.appveyor.com/project/ged/ruby-pg-9j8l3]
36
+ {<img src="https://app.travis-ci.com/larskanis/ruby-pg.svg?branch=master" alt="Build Status" />}[https://app.travis-ci.com/larskanis/ruby-pg]
37
37
 
38
38
  == Requirements
39
39
 
40
- * Ruby 2.2 or newer
41
- * PostgreSQL 9.2.x or later (with headers, -dev packages, etc).
40
+ * Ruby 2.4 or newer
41
+ * PostgreSQL 9.3.x or later (with headers, -dev packages, etc).
42
42
 
43
- It usually work with earlier versions of Ruby/PostgreSQL as well, but those are
43
+ It usually works with earlier versions of Ruby/PostgreSQL as well, but those are
44
44
  not regularly tested.
45
45
 
46
46
 
@@ -78,7 +78,7 @@ There's also {a Google+ group}[http://goo.gl/TFy1U] and a
78
78
  want to chat about something.
79
79
 
80
80
  If you want to install as a signed gem, the public certs of the gem signers
81
- can be found in {the `certs` directory}[https://bitbucket.org/ged/ruby-pg/src/tip/certs/]
81
+ can be found in {the `certs` directory}[https://github.com/ged/ruby-pg/tree/master/certs]
82
82
  of the repository.
83
83
 
84
84
 
@@ -118,6 +118,30 @@ to build composite types by assigning an element encoder/decoder.
118
118
  PG::Coder objects can be used to set up a PG::TypeMap or alternatively
119
119
  to convert single values to/from their string representation.
120
120
 
121
+ The following PostgreSQL column types are supported by ruby-pg (TE = Text Encoder, TD = Text Decoder, BE = Binary Encoder, BD = Binary Decoder):
122
+ * Integer: {TE}[rdoc-ref:PG::TextEncoder::Integer], {TD}[rdoc-ref:PG::TextDecoder::Integer], {BD}[rdoc-ref:PG::BinaryDecoder::Integer] 💡 No links? Switch to {here}[https://deveiate.org/code/pg/README_rdoc.html#label-Type+Casts] 💡
123
+ * BE: {Int2}[rdoc-ref:PG::BinaryEncoder::Int2], {Int4}[rdoc-ref:PG::BinaryEncoder::Int4], {Int8}[rdoc-ref:PG::BinaryEncoder::Int8]
124
+ * Float: {TE}[rdoc-ref:PG::TextEncoder::Float], {TD}[rdoc-ref:PG::TextDecoder::Float], {BD}[rdoc-ref:PG::BinaryDecoder::Float]
125
+ * Numeric: {TE}[rdoc-ref:PG::TextEncoder::Numeric], {TD}[rdoc-ref:PG::TextDecoder::Numeric]
126
+ * Boolean: {TE}[rdoc-ref:PG::TextEncoder::Boolean], {TD}[rdoc-ref:PG::TextDecoder::Boolean], {BE}[rdoc-ref:PG::BinaryEncoder::Boolean], {BD}[rdoc-ref:PG::BinaryDecoder::Boolean]
127
+ * String: {TE}[rdoc-ref:PG::TextEncoder::String], {TD}[rdoc-ref:PG::TextDecoder::String], {BE}[rdoc-ref:PG::BinaryEncoder::String], {BD}[rdoc-ref:PG::BinaryDecoder::String]
128
+ * Bytea: {TE}[rdoc-ref:PG::TextEncoder::Bytea], {TD}[rdoc-ref:PG::TextDecoder::Bytea], {BE}[rdoc-ref:PG::BinaryEncoder::Bytea], {BD}[rdoc-ref:PG::BinaryDecoder::Bytea]
129
+ * Base64: {TE}[rdoc-ref:PG::TextEncoder::ToBase64], {TD}[rdoc-ref:PG::TextDecoder::FromBase64], {BE}[rdoc-ref:PG::BinaryEncoder::FromBase64], {BD}[rdoc-ref:PG::BinaryDecoder::ToBase64]
130
+ * Timestamp:
131
+ * TE: {local}[rdoc-ref:PG::TextEncoder::TimestampWithoutTimeZone], {UTC}[rdoc-ref:PG::TextEncoder::TimestampUtc], {with-TZ}[rdoc-ref:PG::TextEncoder::TimestampWithTimeZone]
132
+ * TD: {local}[rdoc-ref:PG::TextDecoder::TimestampLocal], {UTC}[rdoc-ref:PG::TextDecoder::TimestampUtc], {UTC-to-local}[rdoc-ref:PG::TextDecoder::TimestampUtcToLocal]
133
+ * BD: {local}[rdoc-ref:PG::BinaryDecoder::TimestampLocal], {UTC}[rdoc-ref:PG::BinaryDecoder::TimestampUtc], {UTC-to-local}[rdoc-ref:PG::BinaryDecoder::TimestampUtcToLocal]
134
+ * Date: {TE}[rdoc-ref:PG::TextEncoder::Date], {TD}[rdoc-ref:PG::TextDecoder::Date]
135
+ * JSON and JSONB: {TE}[rdoc-ref:PG::TextEncoder::JSON], {TD}[rdoc-ref:PG::TextDecoder::JSON]
136
+ * Inet: {TE}[rdoc-ref:PG::TextEncoder::Inet], {TD}[rdoc-ref:PG::TextDecoder::Inet]
137
+ * Array: {TE}[rdoc-ref:PG::TextEncoder::Array], {TD}[rdoc-ref:PG::TextDecoder::Array]
138
+ * Composite Type (also called "Row" or "Record"): {TE}[rdoc-ref:PG::TextEncoder::Record], {TD}[rdoc-ref:PG::TextDecoder::Record]
139
+
140
+ The following text formats can also be encoded although they are not used as column type:
141
+ * COPY input and output data: {TE}[rdoc-ref:PG::TextEncoder::CopyRow], {TD}[rdoc-ref:PG::TextDecoder::CopyRow]
142
+ * Literal for insertion into SQL string: {TE}[rdoc-ref:PG::TextEncoder::QuotedLiteral]
143
+ * SQL-Identifier: {TE}[rdoc-ref:PG::TextEncoder::Identifier], {TD}[rdoc-ref:PG::TextDecoder::Identifier]
144
+
121
145
  === PG::TypeMap and derivations (ext/pg_type_map*.c, lib/pg/type_map*.rb)
122
146
 
123
147
  A TypeMap defines which value will be converted by which encoder/decoder.
@@ -129,11 +153,23 @@ A type map can be assigned per connection or per query respectively per
129
153
  result set. Type maps can also be used for COPY in and out data streaming.
130
154
  See PG::Connection#copy_data .
131
155
 
156
+ The following base type maps are available:
157
+ * PG::TypeMapAllStrings - encodes and decodes all values to and from strings (default)
158
+ * PG::TypeMapByClass - selects encoder based on the class of the value to be sent
159
+ * PG::TypeMapByColumn - selects encoder and decoder by column order
160
+ * PG::TypeMapByOid - selects decoder by PostgreSQL type OID
161
+ * PG::TypeMapInRuby - define a custom type map in ruby
162
+
163
+ The following type maps are prefilled with type mappings from the PG::BasicTypeRegistry :
164
+ * PG::BasicTypeMapForResults - a PG::TypeMapByOid prefilled with decoders for common PostgreSQL column types
165
+ * PG::BasicTypeMapBasedOnResult - a PG::TypeMapByOid prefilled with encoders for common PostgreSQL column types
166
+ * PG::BasicTypeMapForQueries - a PG::TypeMapByClass prefilled with encoders for common Ruby value classes
167
+
168
+
132
169
  == Contributing
133
170
 
134
- To report bugs, suggest features, or check out the source with Mercurial,
135
- {check out the project page}[http://bitbucket.org/ged/ruby-pg]. If you prefer
136
- Git, there's also a {Github mirror}[https://github.com/ged/ruby-pg].
171
+ To report bugs, suggest features, or check out the source with Git,
172
+ {check out the project page}[https://github.com/ged/ruby-pg].
137
173
 
138
174
  After checking out the source, run:
139
175
 
@@ -148,7 +184,7 @@ Lars Kanis <lars@greiz-reinsdorf.de>.
148
184
 
149
185
  == Copying
150
186
 
151
- Copyright (c) 1997-2016 by the authors.
187
+ Copyright (c) 1997-2019 by the authors.
152
188
 
153
189
  * Jeff Davis <ruby-pg@j-davis.com>
154
190
  * Guy Decoux (ts) <decoux@moulon.inra.fr>
data/Rakefile CHANGED
@@ -3,20 +3,11 @@
3
3
  require 'rbconfig'
4
4
  require 'pathname'
5
5
  require 'tmpdir'
6
-
7
- begin
8
- require 'rake/extensiontask'
9
- rescue LoadError
10
- abort "This Rakefile requires rake-compiler (gem install rake-compiler)"
11
- end
12
-
13
- begin
14
- require 'hoe'
15
- rescue LoadError
16
- abort "This Rakefile requires hoe (gem install hoe)"
17
- end
18
-
6
+ require 'rake/extensiontask'
19
7
  require 'rake/clean'
8
+ require 'rspec/core/rake_task'
9
+ require 'bundler'
10
+ require 'bundler/gem_helper'
20
11
 
21
12
  # Build directory constants
22
13
  BASEDIR = Pathname( __FILE__ ).dirname
@@ -25,80 +16,23 @@ LIBDIR = BASEDIR + 'lib'
25
16
  EXTDIR = BASEDIR + 'ext'
26
17
  PKGDIR = BASEDIR + 'pkg'
27
18
  TMPDIR = BASEDIR + 'tmp'
19
+ TESTDIR = BASEDIR + "tmp_test_specs"
28
20
 
29
21
  DLEXT = RbConfig::CONFIG['DLEXT']
30
22
  EXT = LIBDIR + "pg_ext.#{DLEXT}"
31
23
 
32
24
  GEMSPEC = 'pg.gemspec'
33
25
 
34
- TEST_DIRECTORY = BASEDIR + "tmp_test_specs"
35
-
36
- CLOBBER.include( TEST_DIRECTORY.to_s )
26
+ CLOBBER.include( TESTDIR.to_s )
37
27
  CLEAN.include( PKGDIR.to_s, TMPDIR.to_s )
38
-
39
- # Set up Hoe plugins
40
- Hoe.plugin :mercurial
41
- Hoe.plugin :signing
42
- Hoe.plugin :deveiate
43
- Hoe.plugin :bundler
44
-
45
- Hoe.plugins.delete :rubyforge
46
- Hoe.plugins.delete :compiler
28
+ CLEAN.include "lib/*/libpq.dll"
29
+ CLEAN.include "lib/pg_ext.*"
30
+ CLEAN.include "lib/pg/postgresql_lib_path.rb"
47
31
 
48
32
  load 'Rakefile.cross'
49
33
 
50
-
51
- # Hoe specification
52
- $hoespec = Hoe.spec 'pg' do
53
- self.readme_file = 'README.rdoc'
54
- self.history_file = 'History.rdoc'
55
- self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
56
- self.extra_rdoc_files.include( 'POSTGRES', 'LICENSE' )
57
- self.extra_rdoc_files.include( 'ext/*.c' )
58
- self.license 'BSD-3-Clause'
59
-
60
- self.developer 'Michael Granger', 'ged@FaerieMUD.org'
61
- self.developer 'Lars Kanis', 'lars@greiz-reinsdorf.de'
62
-
63
- self.dependency 'rake-compiler', '~> 1.0', :developer
64
- self.dependency 'rake-compiler-dock', ['~> 0.6', '>= 0.6.2'], :developer
65
- self.dependency 'hoe-deveiate', '~> 0.9', :developer
66
- self.dependency 'hoe-bundler', '~> 1.0', :developer
67
- self.dependency 'rspec', '~> 3.5', :developer
68
- self.dependency 'rdoc', '~> 5.1', :developer
69
-
70
- self.spec_extras[:extensions] = [ 'ext/extconf.rb' ]
71
-
72
- self.require_ruby_version( '>= 2.0.0' )
73
-
74
- self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
75
- self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
76
-
77
- self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
78
- end
79
-
80
- ENV['VERSION'] ||= $hoespec.spec.version.to_s
81
-
82
- # Tests should pass before checking in
83
- task 'hg:precheckin' => [ :check_history, :check_manifest, :spec, :gemspec ]
84
-
85
- # Support for 'rvm specs'
86
- task :specs => :spec
87
-
88
- # Compile before testing
89
- task :spec => :compile
90
-
91
- # gem-testers support
92
- task :test do
93
- # rake-compiler always wants to copy the compiled extension into lib/, but
94
- # we don't want testers to have to re-compile, especially since that
95
- # often fails because they can't (and shouldn't have to) write to tmp/ in
96
- # the installed gem dir. So we clear the task rake-compiler set up
97
- # to break the dependency between :spec and :compile when running under
98
- # rubygems-test, and then run :spec.
99
- Rake::Task[ EXT.to_s ].clear if File.exist?(EXT.to_s)
100
- Rake::Task[ :spec ].execute
101
- end
34
+ Bundler::GemHelper.install_tasks
35
+ $gem_spec = Bundler.load_gemspec(GEMSPEC)
102
36
 
103
37
  desc "Turn on warnings and debugging in the build."
104
38
  task :maint do
@@ -108,12 +42,12 @@ end
108
42
  # Rake-compiler task
109
43
  Rake::ExtensionTask.new do |ext|
110
44
  ext.name = 'pg_ext'
111
- ext.gem_spec = $hoespec.spec
45
+ ext.gem_spec = $gem_spec
112
46
  ext.ext_dir = 'ext'
113
47
  ext.lib_dir = 'lib'
114
48
  ext.source_pattern = "*.{c,h}"
115
49
  ext.cross_compile = true
116
- ext.cross_platform = CrossLibraries.map &:for_platform
50
+ ext.cross_platform = CrossLibraries.map(&:for_platform)
117
51
 
118
52
  ext.cross_config_options += CrossLibraries.map do |lib|
119
53
  {
@@ -129,62 +63,36 @@ Rake::ExtensionTask.new do |ext|
129
63
 
130
64
  # Add libpq.dll to windows binary gemspec
131
65
  ext.cross_compiling do |spec|
132
- spec.files << "lib/libpq.dll"
66
+ spec.files << "lib/#{spec.platform}/libpq.dll"
133
67
  end
134
68
  end
135
69
 
70
+ RSpec::Core::RakeTask.new(:spec).rspec_opts = "--profile -cfdoc"
71
+ task :test => :spec
136
72
 
137
73
  # Use the fivefish formatter for docs generated from development checkout
138
- if File.directory?( '.hg' )
139
- require 'rdoc/task'
140
-
141
- Rake::Task[ 'docs' ].clear
142
- RDoc::Task.new( 'docs' ) do |rdoc|
143
- rdoc.main = "README.rdoc"
144
- rdoc.rdoc_files.include( "*.rdoc", "ChangeLog", "lib/**/*.rb", 'ext/**/*.{c,h}' )
145
- rdoc.generator = :fivefish
146
- rdoc.title = "PG: The Ruby PostgreSQL Driver"
147
- rdoc.rdoc_dir = 'doc'
148
- end
74
+ require 'rdoc/task'
75
+
76
+ RDoc::Task.new( 'docs' ) do |rdoc|
77
+ rdoc.main = "README.rdoc"
78
+ rdoc.rdoc_files.include( "*.rdoc", "lib/**/*.rb", 'ext/**/*.{c,h}' )
79
+ rdoc.generator = :fivefish
80
+ rdoc.title = "PG: The Ruby PostgreSQL Driver"
81
+ rdoc.rdoc_dir = 'doc'
149
82
  end
150
83
 
84
+ desc "Build the source gem #{$gem_spec.full_name}.gem into the pkg directory"
85
+ task :gem => :build
151
86
 
152
- # Make the ChangeLog update if the repo has changed since it was last built
153
- file '.hg/branch' do
154
- warn "WARNING: You need the Mercurial repo to update the ChangeLog"
155
- end
156
- Rake::Task["ChangeLog"].clear
157
- file 'ChangeLog' do |task|
158
- if File.exist?('.hg/branch')
159
- $stderr.puts "Updating the changelog..."
160
- begin
161
- include Hoe::MercurialHelpers
162
- content = make_changelog()
163
- rescue NameError
164
- abort "Packaging tasks require the hoe-mercurial plugin (gem install hoe-mercurial)"
165
- end
166
- File.open( task.name, 'w', 0644 ) do |fh|
167
- fh.print( content )
168
- end
169
- else
170
- touch 'ChangeLog'
171
- end
172
- end
173
-
174
- # Rebuild the ChangeLog immediately before release
175
- task :prerelease => 'ChangeLog'
176
-
177
-
178
- desc "Stop any Postmaster instances that remain after testing."
179
- task :cleanup_testing_dbs do
180
- require 'spec/lib/helpers'
181
- PgTestingHelpers.stop_existing_postmasters()
182
- Rake::Task[:clean].invoke
87
+ task :clobber do
88
+ puts "Stop any Postmaster instances that remain after testing."
89
+ require_relative 'spec/helpers'
90
+ PG::TestingHelpers.stop_existing_postmasters()
183
91
  end
184
92
 
185
93
  desc "Update list of server error codes"
186
94
  task :update_error_codes do
187
- URL_ERRORCODES_TXT = "http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob_plain;f=src/backend/utils/errcodes.txt;hb=refs/tags/REL_10_4"
95
+ URL_ERRORCODES_TXT = "http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob_plain;f=src/backend/utils/errcodes.txt;hb=refs/tags/REL_14_0"
188
96
 
189
97
  ERRORCODES_TXT = "ext/errorcodes.txt"
190
98
  sh "wget #{URL_ERRORCODES_TXT.inspect} -O #{ERRORCODES_TXT.inspect} || curl #{URL_ERRORCODES_TXT.inspect} -o #{ERRORCODES_TXT.inspect}"
@@ -196,20 +104,3 @@ file 'ext/pg_errors.c' => ['ext/errorcodes.def'] do
196
104
  # trigger compilation of changed errorcodes.def
197
105
  touch 'ext/pg_errors.c'
198
106
  end
199
-
200
- task :gemspec => GEMSPEC
201
- file GEMSPEC => __FILE__
202
- task GEMSPEC do |task|
203
- spec = $hoespec.spec
204
- spec.files.delete( '.gemtest' )
205
- spec.signing_key = nil
206
- spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
207
- spec.cert_chain = [ 'certs/ged.pem' ]
208
- File.open( task.name, 'w' ) do |fh|
209
- fh.write( spec.to_ruby )
210
- end
211
- end
212
-
213
- CLOBBER.include( '*.gemspec' )
214
- task :default => :gemspec
215
-