pg 1.2.3 → 1.6.1

data/README.rdoc

@@ -1,213 +0,0 @@
-= pg
-
-home :: https://github.com/ged/ruby-pg
-docs :: http://deveiate.org/code/pg
-
-{<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]
-
-
-== Description
-
-Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/].
-
-It works with {PostgreSQL 9.2 and later}[http://www.postgresql.org/support/versioning/].
-
-A small example usage:
-
-  #!/usr/bin/env ruby
-
-  require 'pg'
-
-  # Output a table of current connections to the DB
-  conn = PG.connect( dbname: 'sales' )
-  conn.exec( "SELECT * FROM pg_stat_activity" ) do |result|
-    puts "     PID | User             | Query"
-    result.each do |row|
-      puts " %7d | %-16s | %s " %
-        row.values_at('procpid', 'usename', 'current_query')
-    end
-  end
-
-== Build Status
-
-{<img src="https://travis-ci.org/ged/ruby-pg.svg?branch=master" alt="Build Status Travis-CI" />}[https://travis-ci.org/ged/ruby-pg]
-{<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]
-
-
-== Requirements
-
-* Ruby 2.2 or newer
-* PostgreSQL 9.2.x or later (with headers, -dev packages, etc).
-
-It usually works with earlier versions of Ruby/PostgreSQL as well, but those are
-not regularly tested.
-
-
-== Versioning
-
-We tag and release gems according to the {Semantic Versioning}[http://semver.org/] principle.
-
-As a result of this policy, you can (and should) specify a dependency on this gem using the {Pessimistic Version Constraint}[http://guides.rubygems.org/patterns/#pessimistic-version-constraint] with two digits of precision.
-
-For example:
-
-  spec.add_dependency 'pg', '~> 1.0'
-
-
-== How To Install
-
-Install via RubyGems:
-
-    gem install pg
-
-You may need to specify the path to the 'pg_config' program installed with
-Postgres:
-
-    gem install pg -- --with-pg-config=<path to pg_config>
-
-If you're installing via Bundler, you can provide compile hints like so:
-
-    bundle config build.pg --with-pg-config=<path to pg_config>
-
-See README-OS_X.rdoc for more information about installing under MacOS X, and
-README-Windows.rdoc for Windows build/installation instructions.
-
-There's also {a Google+ group}[http://goo.gl/TFy1U] and a
-{mailing list}[http://groups.google.com/group/ruby-pg] if you get stuck, or just
-want to chat about something.
-
-If you want to install as a signed gem, the public certs of the gem signers
-can be found in {the `certs` directory}[https://github.com/ged/ruby-pg/tree/master/certs]
-of the repository.
-
-
-== Type Casts
-
-Pg can optionally type cast result values and query parameters in Ruby or
-native C code. This can speed up data transfers to and from the database,
-because String allocations are reduced and conversions in (slower) Ruby code
-can be omitted.
-
-Very basic type casting can be enabled by:
-
-    conn.type_map_for_results = PG::BasicTypeMapForResults.new conn
-    # ... this works for result value mapping:
-    conn.exec("select 1, now(), '{2,3}'::int[]").values
-        # => [[1, 2014-09-21 20:51:56 +0200, [2, 3]]]
-
-    conn.type_map_for_queries = PG::BasicTypeMapForQueries.new conn
-    # ... and this for param value mapping:
-    conn.exec_params("SELECT $1::text, $2::text, $3::text", [1, 1.23, [2,3]]).values
-        # => [["1", "1.2300000000000000E+00", "{2,3}"]]
-
-But Pg's type casting is highly customizable. That's why it's divided into
-2 layers:
-
-=== Encoders / Decoders (ext/pg_*coder.c, lib/pg/*coder.rb)
-
-This is the lower layer, containing encoding classes that convert Ruby
-objects for transmission to the DBMS and decoding classes to convert
-received data back to Ruby objects. The classes are namespaced according
-to their format and direction in PG::TextEncoder, PG::TextDecoder,
-PG::BinaryEncoder and PG::BinaryDecoder.
-
-It is possible to assign a type OID, format code (text or binary) and
-optionally a name to an encoder or decoder object. It's also possible
-to build composite types by assigning an element encoder/decoder.
-PG::Coder objects can be used to set up a PG::TypeMap or alternatively
-to convert single values to/from their string representation.
-
-The following PostgreSQL column types are supported by ruby-pg (TE = Text Encoder, TD = Text Decoder, BE = Binary Encoder, BD = Binary Decoder):
-* 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] 💡
-  * BE: {Int2}[rdoc-ref:PG::BinaryEncoder::Int2], {Int4}[rdoc-ref:PG::BinaryEncoder::Int4], {Int8}[rdoc-ref:PG::BinaryEncoder::Int8]
-* Float: {TE}[rdoc-ref:PG::TextEncoder::Float], {TD}[rdoc-ref:PG::TextDecoder::Float], {BD}[rdoc-ref:PG::BinaryDecoder::Float]
-* Numeric: {TE}[rdoc-ref:PG::TextEncoder::Numeric], {TD}[rdoc-ref:PG::TextDecoder::Numeric]
-* 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]
-* 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]
-* 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]
-* 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]
-* Timestamp:
-  * TE: {local}[rdoc-ref:PG::TextEncoder::TimestampWithoutTimeZone], {UTC}[rdoc-ref:PG::TextEncoder::TimestampUtc], {with-TZ}[rdoc-ref:PG::TextEncoder::TimestampWithTimeZone]
-  * TD: {local}[rdoc-ref:PG::TextDecoder::TimestampLocal], {UTC}[rdoc-ref:PG::TextDecoder::TimestampUtc], {UTC-to-local}[rdoc-ref:PG::TextDecoder::TimestampUtcToLocal]
-  * BD: {local}[rdoc-ref:PG::BinaryDecoder::TimestampLocal], {UTC}[rdoc-ref:PG::BinaryDecoder::TimestampUtc], {UTC-to-local}[rdoc-ref:PG::BinaryDecoder::TimestampUtcToLocal]
-* Date: {TE}[rdoc-ref:PG::TextEncoder::Date], {TD}[rdoc-ref:PG::TextDecoder::Date]
-* JSON and JSONB: {TE}[rdoc-ref:PG::TextEncoder::JSON], {TD}[rdoc-ref:PG::TextDecoder::JSON]
-* Inet: {TE}[rdoc-ref:PG::TextEncoder::Inet], {TD}[rdoc-ref:PG::TextDecoder::Inet]
-* Array: {TE}[rdoc-ref:PG::TextEncoder::Array], {TD}[rdoc-ref:PG::TextDecoder::Array]
-* Composite Type (also called "Row" or "Record"): {TE}[rdoc-ref:PG::TextEncoder::Record], {TD}[rdoc-ref:PG::TextDecoder::Record]
-
-The following text formats can also be encoded although they are not used as column type:
-* COPY input and output data: {TE}[rdoc-ref:PG::TextEncoder::CopyRow], {TD}[rdoc-ref:PG::TextDecoder::CopyRow]
-* Literal for insertion into SQL string: {TE}[rdoc-ref:PG::TextEncoder::QuotedLiteral]
-* SQL-Identifier: {TE}[rdoc-ref:PG::TextEncoder::Identifier], {TD}[rdoc-ref:PG::TextDecoder::Identifier]
-
-=== PG::TypeMap and derivations (ext/pg_type_map*.c, lib/pg/type_map*.rb)
-
-A TypeMap defines which value will be converted by which encoder/decoder.
-There are different type map strategies, implemented by several derivations
-of this class. They can be chosen and configured according to the particular
-needs for type casting. The default type map is PG::TypeMapAllStrings.
-
-A type map can be assigned per connection or per query respectively per
-result set. Type maps can also be used for COPY in and out data streaming.
-See PG::Connection#copy_data .
-
-The following base type maps are available:
-* PG::TypeMapAllStrings - encodes and decodes all values to and from strings (default)
-* PG::TypeMapByClass - selects encoder based on the class of the value to be sent
-* PG::TypeMapByColumn - selects encoder and decoder by column order
-* PG::TypeMapByOid - selects decoder by PostgreSQL type OID
-* PG::TypeMapInRuby - define a custom type map in ruby
-
-The following type maps are prefilled with type mappings from the PG::BasicTypeRegistry :
-* PG::BasicTypeMapForResults - a PG::TypeMapByOid prefilled with decoders for common PostgreSQL column types
-* PG::BasicTypeMapBasedOnResult - a PG::TypeMapByOid prefilled with encoders for common PostgreSQL column types
-* PG::BasicTypeMapForQueries - a PG::TypeMapByClass prefilled with encoders for common Ruby value classes
-
-
-== Contributing
-
-To report bugs, suggest features, or check out the source with Git,
-{check out the project page}[https://github.com/ged/ruby-pg].
-
-After checking out the source, run:
-
-    $ rake newb
-
-This task will install any missing dependencies, run the tests/specs, and
-generate the API documentation.
-
-The current maintainers are Michael Granger <ged@FaerieMUD.org> and
-Lars Kanis <lars@greiz-reinsdorf.de>.
-
-
-== Copying
-
-Copyright (c) 1997-2019 by the authors.
-
-* Jeff Davis <ruby-pg@j-davis.com>
-* Guy Decoux (ts) <decoux@moulon.inra.fr>
-* Michael Granger <ged@FaerieMUD.org>
-* Lars Kanis <lars@greiz-reinsdorf.de>
-* Dave Lee
-* Eiji Matsumoto <usagi@ruby.club.or.jp>
-* Yukihiro Matsumoto <matz@ruby-lang.org>
-* Noboru Saitou <noborus@netlab.jp>
-
-You may redistribute this software under the same terms as Ruby itself; see
-https://www.ruby-lang.org/en/about/license.txt or the BSDL file in the source
-for details.
-
-Portions of the code are from the PostgreSQL project, and are distributed
-under the terms of the PostgreSQL license, included in the file POSTGRES.
-
-Portions copyright LAIKA, Inc.
-
-
-== Acknowledgments
-
-See Contributors.rdoc for the many additional fine people that have contributed
-to this library over the years.
-
-We are thankful to the people at the ruby-list and ruby-dev mailing lists.
-And to the people who developed PostgreSQL.

data/Rakefile.cross

@@ -1,299 +0,0 @@
-# -*- rake -*-
-
-require 'uri'
-require 'tempfile'
-require 'rbconfig'
-require 'rake/clean'
-require 'rake/extensiontask'
-require 'rake/extensioncompiler'
-require 'ostruct'
-
-MISCDIR = BASEDIR + 'misc'
-
-NUM_CPUS = if File.exist?('/proc/cpuinfo')
-	File.read('/proc/cpuinfo').scan('processor').length
-elsif RUBY_PLATFORM.include?( 'darwin' )
-	`system_profiler SPHardwareDataType | grep 'Cores' | awk '{print $5}'`.chomp
-else
-	1
-end
-
-class CrossLibrary < OpenStruct
-	include Rake::DSL
-
-	def initialize(for_platform, openssl_config, toolchain)
-		super()
-
-		self.for_platform               = for_platform
-		self.openssl_config             = openssl_config
-		self.host_platform              = toolchain
-
-		# Cross-compilation constants
-		self.openssl_version            = ENV['OPENSSL_VERSION'] || '1.1.1d'
-		self.postgresql_version         = ENV['POSTGRESQL_VERSION'] || '12.1'
-
-		# Check if symlinks work in the current working directory.
-		# This fails, if rake-compiler-dock is running on a Windows box.
-		begin
-			FileUtils.rm_f '.test_symlink'
-			FileUtils.ln_s '/', '.test_symlink'
-		rescue NotImplementedError, SystemCallError
-			# Symlinks don't work -> use home directory instead
-			self.compile_home               = Pathname( "~/.ruby-pg-build" ).expand_path
-		else
-			self.compile_home               = Pathname( "./build" ).expand_path
-		end
-		self.static_sourcesdir          = compile_home + 'sources'
-		self.static_builddir            = compile_home + 'builds' + for_platform
-		CLOBBER.include( static_sourcesdir )
-		CLEAN.include( static_builddir )
-
-		# Static OpenSSL build vars
-		self.static_openssl_builddir    = static_builddir + "openssl-#{openssl_version}"
-
-		self.openssl_source_uri         =
-			URI( "http://www.openssl.org/source/openssl-#{openssl_version}.tar.gz" )
-		self.openssl_tarball            = static_sourcesdir + File.basename( openssl_source_uri.path )
-		self.openssl_makefile           = static_openssl_builddir + 'Makefile'
-
-		self.libssl                     = static_openssl_builddir + 'libssl.a'
-		self.libcrypto                  = static_openssl_builddir + 'libcrypto.a'
-
-		self.openssl_patches            = Rake::FileList[ (MISCDIR + "openssl-#{openssl_version}.*.patch").to_s ]
-
-		# Static PostgreSQL build vars
-		self.static_postgresql_builddir = static_builddir + "postgresql-#{postgresql_version}"
-		self.postgresql_source_uri      = begin
-			uristring = "http://ftp.postgresql.org/pub/source/v%s/postgresql-%s.tar.bz2" %
-				[ postgresql_version, postgresql_version ]
-			URI( uristring )
-		end
-		self.postgresql_tarball         = static_sourcesdir + File.basename( postgresql_source_uri.path )
-
-		self.static_postgresql_srcdir   = static_postgresql_builddir + 'src'
-		self.static_postgresql_libdir   = static_postgresql_srcdir + 'interfaces/libpq'
-		self.static_postgresql_incdir   = static_postgresql_srcdir + 'include'
-
-		self.postgresql_global_makefile = static_postgresql_srcdir + 'Makefile.global'
-		self.postgresql_shlib_makefile  = static_postgresql_srcdir + 'Makefile.shlib'
-		self.postgresql_shlib_mf_orig   = static_postgresql_srcdir + 'Makefile.shlib.orig'
-		self.postgresql_lib             = static_postgresql_libdir + 'libpq.dll'
-		self.postgresql_patches         = Rake::FileList[ (MISCDIR + "postgresql-#{postgresql_version}.*.patch").to_s ]
-
-		# clean intermediate files and folders
-		CLEAN.include( static_builddir.to_s )
-
-		#####################################################################
-		### C R O S S - C O M P I L A T I O N - T A S K S
-		#####################################################################
-
-
-		directory static_sourcesdir.to_s
-
-		#
-		# Static OpenSSL build tasks
-		#
-		directory static_openssl_builddir.to_s
-
-		# openssl source file should be stored there
-		file openssl_tarball => static_sourcesdir do |t|
-			download( openssl_source_uri, t.name )
-		end
-
-		# Extract the openssl builds
-		file static_openssl_builddir => openssl_tarball do |t|
-			puts "extracting %s to %s" % [ openssl_tarball, static_openssl_builddir.parent ]
-			static_openssl_builddir.mkpath
-			run 'tar', '-xzf', openssl_tarball.to_s, '-C', static_openssl_builddir.parent.to_s
-			openssl_makefile.unlink if openssl_makefile.exist?
-
-			openssl_patches.each do |patchfile|
-				puts "  applying patch #{patchfile}..."
-				run 'patch', '-Np1', '-d', static_openssl_builddir.to_s,
-				'-i', File.expand_path( patchfile, BASEDIR )
-			end
-		end
-
-		self.cmd_prelude = [
-			"env",
-			"CROSS_COMPILE=#{host_platform}-",
-			"CFLAGS=-DDSO_WIN32",
-		]
-
-
-		# generate the makefile in a clean build location
-		file openssl_makefile => static_openssl_builddir do |t|
-			chdir( static_openssl_builddir ) do
-				cmd = cmd_prelude.dup
-				cmd << "./Configure" << openssl_config
-
-				run( *cmd )
-			end
-		end
-
-		desc "compile static openssl libraries"
-		task "openssl_libs:#{for_platform}" => [ libssl, libcrypto ]
-
-		task "compile_static_openssl:#{for_platform}" => openssl_makefile do |t|
-			chdir( static_openssl_builddir ) do
-				cmd = cmd_prelude.dup
-				cmd << 'make' << "-j#{NUM_CPUS}" << 'build_libs'
-
-				run( *cmd )
-			end
-		end
-
-		desc "compile static #{libssl}"
-		file libssl => "compile_static_openssl:#{for_platform}" do |t|
-			rm t.name.gsub(/\.a$/, ".dll.a")
-		end
-
-		desc "compile static #{libcrypto}"
-		file libcrypto => "compile_static_openssl:#{for_platform}" do |t|
-			rm t.name.gsub(/\.a$/, ".dll.a")
-		end
-
-
-
-		#
-		# Static PostgreSQL build tasks
-		#
-		directory static_postgresql_builddir.to_s
-
-
-		# postgresql source file should be stored there
-		file postgresql_tarball => static_sourcesdir do |t|
-			download( postgresql_source_uri, t.name )
-		end
-
-		# Extract the postgresql sources
-		file static_postgresql_builddir => postgresql_tarball do |t|
-			puts "extracting %s to %s" % [ postgresql_tarball, static_postgresql_builddir.parent ]
-			static_postgresql_builddir.mkpath
-			run 'tar', '-xjf', postgresql_tarball.to_s, '-C', static_postgresql_builddir.parent.to_s
-
-			postgresql_patches.each do |patchfile|
-				puts "  applying patch #{patchfile}..."
-				run 'patch', '-Np1', '-d', static_postgresql_builddir.to_s,
-				'-i', File.expand_path( patchfile, BASEDIR )
-			end
-		end
-
-		# generate the makefile in a clean build location
-		file postgresql_global_makefile => [ static_postgresql_builddir, "openssl_libs:#{for_platform}" ] do |t|
-			options = [
-				"--target=#{host_platform}",
-				"--host=#{host_platform}",
-				'--with-openssl',
-				'--without-zlib',
-			]
-
-			chdir( static_postgresql_builddir ) do
-				configure_path = static_postgresql_builddir + 'configure'
-				cmd = [ configure_path.to_s, *options ]
-				cmd << "CFLAGS=-L#{static_openssl_builddir}"
-				cmd << "LDFLAGS=-L#{static_openssl_builddir}"
-				cmd << "LDFLAGS_SL=-L#{static_openssl_builddir}"
-				cmd << "LIBS=-lwsock32 -lgdi32 -lws2_32"
-				cmd << "CPPFLAGS=-I#{static_openssl_builddir}/include"
-
-				run( *cmd )
-			end
-		end
-
-
-		# make libpq.dll
-		task postgresql_lib => [ postgresql_global_makefile ] do |t|
-			# Work around missing dependency to libcommon in PostgreSQL-9.4.0
-			chdir( static_postgresql_srcdir + "common" ) do
-				sh 'make', "-j#{NUM_CPUS}"
-			end
-			chdir( static_postgresql_srcdir + "port" ) do
-				sh 'make', "-j#{NUM_CPUS}"
-			end
-
-			chdir( postgresql_lib.dirname ) do
-				sh 'make',
-					"-j#{NUM_CPUS}",
-					postgresql_lib.basename.to_s,
-					'SHLIB_LINK=-lssl -lcrypto -lcrypt32 -lgdi32 -lsecur32 -lwsock32 -lws2_32'
-			end
-		end
-
-
-		#desc 'compile libpg.a'
-		task "native:#{for_platform}" => postgresql_lib
-
-		# copy libpq.dll to lib dir
-		dest_libpq = "lib/#{for_platform}/#{postgresql_lib.basename}"
-		directory File.dirname(dest_libpq)
-		file dest_libpq => [postgresql_lib, File.dirname(dest_libpq)] do
-			cp postgresql_lib, dest_libpq
-		end
-
-		stage_libpq = "tmp/#{for_platform}/stage/#{dest_libpq}"
-		directory File.dirname(stage_libpq)
-		file stage_libpq => [postgresql_lib, File.dirname(stage_libpq)] do |t|
-			cp postgresql_lib, stage_libpq
-		end
-	end
-
-	def download(url, save_to)
-		part = save_to+".part"
-		sh "wget #{url.to_s.inspect} -O #{part.inspect} || curl #{url.to_s.inspect} -o #{part.inspect}"
-		FileUtils.mv part, save_to
-	end
-
-	def run(*args)
-		sh(*args)
-	end
-end
-
-CrossLibraries = [
-	['x86-mingw32', 'mingw', 'i686-w64-mingw32'],
-	['x64-mingw32', 'mingw64', 'x86_64-w64-mingw32'],
-].map do |platform, openssl_config, toolchain|
-	CrossLibrary.new platform, openssl_config, toolchain
-end
-
-desc 'cross compile pg for win32'
-task :cross => [ :mingw32 ]
-
-task :mingw32 do
-	# Use Rake::ExtensionCompiler helpers to find the proper host
-	unless Rake::ExtensionCompiler.mingw_host then
-		warn "You need to install mingw32 cross compile functionality to be able to continue."
-		warn "Please refer to your distribution/package manager documentation about installation."
-		fail
-	end
-end
-
-task 'gem:windows:prepare' do
-	require 'io/console'
-	require 'rake_compiler_dock'
-
-	# Copy gem signing key and certs to be accessable from the docker container
-	mkdir_p 'build/gem'
-	sh "cp ~/.gem/gem-*.pem build/gem/ || true"
-	sh "bundle package"
-	begin
-		OpenSSL::PKey.read(File.read(File.expand_path("~/.gem/gem-private_key.pem")), ENV["GEM_PRIVATE_KEY_PASSPHRASE"] || "")
-	rescue OpenSSL::PKey::PKeyError
-		ENV["GEM_PRIVATE_KEY_PASSPHRASE"] = STDIN.getpass("Enter passphrase of gem signature key: ")
-		retry
-	end
-end
-
-CrossLibraries.each do |xlib|
-	platform = xlib.for_platform
-	desc "Build fat binary gem for platform #{platform}"
-	task "gem:windows:#{platform}" => ['ChangeLog', 'gem:windows:prepare', xlib.openssl_tarball, xlib.postgresql_tarball] do
-		RakeCompilerDock.sh <<-EOT, platform: platform
-			(cp build/gem/gem-*.pem ~/.gem/ || true) &&
-			bundle install --local &&
-			rake native:#{platform} pkg/#{$hoespec.spec.full_name}-#{platform}.gem MAKE="make -j`nproc`"
-		EOT
-	end
-	desc "Build the windows binary gems"
-	multitask 'gem:windows' => "gem:windows:#{platform}"
-end