yugabytedb-ysql 0.3

data/sample/warehouse_partitions.rb

@@ -0,0 +1,311 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+#
+# Script to automatically move partitioned tables and their indexes
+# to a separate area on disk.
+#
+# Mahlon E. Smith <mahlon@martini.nu>
+#
+# Example use case:
+#
+#   - You've got a heavy insert table, such as syslog data.
+#   - This table has a partitioning trigger (or is manually partitioned)
+#     by date, to separate incoming stuff from archival/report stuff.
+#   - You have a tablespace on cheap or slower disk (maybe even
+#     ZFS compressed, or some such!)
+#
+# The only assumption this script makes is that your tables are dated, and
+# the tablespace they're moving into already exists.
+#
+# A full example, using the syslog idea from above, where each child
+# table is date partitioned by a convention of "syslog_YEAR-WEEKOFYEAR":
+#
+#    syslog             # <--- parent
+#    syslog_2012_06     # <--- inherited
+#    syslog_2012_07     # <--- inherited
+#    syslog_2012_08     # <--- inherited
+#    ...
+#
+# You'd run this script like so:
+#
+#    ./warehouse_partitions.rb -F syslog_%Y_%U
+#
+# Assuming this was week 12 of the year, tables syslog_2012_06 through
+# syslog_2012_11 would start sequentially migrating into the tablespace
+# called 'warehouse'.
+#
+
+
+require 'date'
+require 'ostruct'
+require 'optparse'
+require 'pathname'
+require 'etc'
+require 'ysql'
+
+
+### A tablespace migration class.
+###
+class PGWarehouse
+
+	def initialize( opts )
+		@opts = opts
+		@db = YSQL.connect(
+			:dbname   => opts.database,
+			:host     => opts.host,
+			:port     => opts.port,
+			:user     => opts.user,
+			:password => opts.pass,
+			:sslmode  => 'prefer'
+		)
+		@db.exec "SET search_path TO %s" % [ opts.schema ] if opts.schema
+
+		@relations = self.relations
+	end
+
+	attr_reader :db
+
+	######
+	public
+	######
+
+	### Perform the tablespace moves.
+	###
+	def migrate
+		if @relations.empty?
+			$stderr.puts 'No tables were found for warehousing.'
+			return
+		end
+
+		$stderr.puts "Found %d relation%s to move." % [ relations.length, relations.length == 1 ? '' : 's' ]
+		@relations.sort_by{|_,v| v[:name] }.each do |_, val|
+			$stderr.print "  - Moving table '%s' to '%s'... "  % [
+				val[:name], @opts.tablespace
+			]
+
+			if @opts.dryrun
+				$stderr.puts '(not really)'
+
+			else
+				age = self.timer do
+					db.exec "ALTER TABLE %s SET TABLESPACE %s;" % [
+						val[:name], @opts.tablespace
+					]
+				end
+				puts age
+			end
+
+			val[ :indexes ].each do |idx|
+				$stderr.print "      - Moving index '%s' to '%s'... "  % [
+					idx, @opts.tablespace
+				]
+				if @opts.dryrun
+					$stderr.puts '(not really)'
+
+				else
+					age = self.timer do
+						db.exec "ALTER INDEX %s SET TABLESPACE %s;" % [
+							idx, @opts.tablespace
+						]
+					end
+					puts age
+				end
+			end
+		end
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Get OIDs and current tablespaces for everything under the
+	### specified schema.
+	###
+	def relations
+		return @relations if @relations
+		relations = {}
+
+		query =  %q{
+			SELECT c.oid AS oid,
+				c.relname AS name,
+				c.relkind AS kind,
+				t.spcname AS tspace
+			FROM pg_class AS c
+			LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
+			LEFT JOIN pg_tablespace t ON t.oid = c.reltablespace
+			WHERE c.relkind = 'r' }
+		query << "AND n.nspname='#{@opts.schema}'" if @opts.schema
+
+		# Get the relations list, along with each element's current tablespace.
+		#
+		self.db.exec( query ) do |res|
+			res.each do |row|
+				relations[ row['oid'] ] = {
+					:name       => row['name'],
+					:tablespace => row['tspace'],
+					:indexes    => [],
+					:parent     => nil
+				}
+			end
+		end
+
+		# Add table inheritance information.
+		#
+		db.exec 'SELECT inhrelid AS oid, inhparent AS parent FROM pg_inherits' do |res|
+			res.each do |row|
+				relations[ row['oid'] ][ :parent ] = row['parent']
+			end
+		end
+
+		# Remove tables that don't qualify for warehousing.
+		#
+		#   - Tables that are not children of a parent
+		#   - Tables that are already in the warehouse tablespace
+		#   - The currently active child (it's likely being written to!)
+		#   - Any table that can't be parsed into the specified format
+		#
+		relations.reject! do |oid, val|
+			begin
+				val[:parent].nil? ||
+				val[:tablespace] == @opts.tablespace ||
+				val[:name] == Time.now.strftime( @opts.format ) ||
+				! DateTime.strptime( val[:name], @opts.format )
+			rescue ArgumentError
+				true
+			end
+		end
+
+		query = %q{
+			SELECT c.oid AS oid,
+				i.indexname AS name
+			FROM pg_class AS c
+			INNER JOIN pg_indexes AS i
+				ON i.tablename = c.relname }
+		query << "AND i.schemaname='#{@opts.schema}'" if @opts.schema
+
+		# Attach index names to tables.
+		#
+		db.exec( query ) do |res|
+			res.each do |row|
+				relations[ row['oid'] ][ :indexes ] << row['name'] if relations[ row['oid'] ]
+			end
+		end
+
+		return relations
+	end
+
+
+	### Wrap arbitrary commands in a human readable timer.
+	###
+	def timer
+		start = Time.now
+		yield
+		age = Time.now - start
+
+		diff = age
+		secs = diff % 60
+		diff = ( diff - secs ) / 60
+		mins = diff % 60
+		diff = ( diff - mins ) / 60
+		hour = diff % 24
+
+		return "%02d:%02d:%02d" % [ hour, mins, secs ]
+	end
+end
+
+
+### Parse command line arguments.  Return a struct of global options.
+###
+def parse_args( args )
+	options          = OpenStruct.new
+	options.database = Etc.getpwuid( Process.uid ).name
+	options.host     = '127.0.0.1'
+	options.port     = 5432
+	options.user     = Etc.getpwuid( Process.uid ).name
+	options.sslmode  = 'prefer'
+	options.tablespace = 'warehouse'
+
+	opts = OptionParser.new do |opts|
+		opts.banner = "Usage: #{$0} [options]"
+
+		opts.separator ''
+		opts.separator 'Connection options:'
+
+		opts.on( '-d', '--database DBNAME',
+				"specify the database to connect to (default: \"#{options.database}\")" ) do |db|
+			options.database = db
+		end
+
+		opts.on( '-h', '--host HOSTNAME', 'database server host' ) do |host|
+			options.host = host
+		end
+
+		opts.on( '-p', '--port PORT', Integer,
+				"database server port (default: \"#{options.port}\")" ) do |port|
+			options.port = port
+		end
+
+		opts.on( '-n', '--schema SCHEMA', String,
+				"operate on the named schema only (default: none)" ) do |schema|
+			options.schema = schema
+		end
+
+		opts.on( '-T', '--tablespace SPACE', String,
+				"move old tables to this tablespace (default: \"#{options.tablespace}\")" ) do |tb|
+			options.tablespace = tb
+		end
+
+		opts.on( '-F', '--tableformat FORMAT', String,
+				"The naming format (strftime) for the inherited tables (default: none)" ) do |format|
+			options.format = format
+		end
+
+		opts.on( '-U', '--user NAME',
+				"database user name (default: \"#{options.user}\")" ) do |user|
+			options.user = user
+		end
+
+		opts.on( '-W', 'force password prompt' ) do |pw|
+			print 'Password: '
+			begin
+				system 'stty -echo'
+				options.pass = gets.chomp
+			ensure
+				system 'stty echo'
+				puts
+			end
+		end
+
+		opts.separator ''
+		opts.separator 'Other options:'
+
+		opts.on_tail( '--dry-run', "don't actually do anything" ) do
+			options.dryrun = true
+		end
+
+		opts.on_tail( '--help', 'show this help, then exit' ) do
+			$stderr.puts opts
+			exit
+		end
+
+		opts.on_tail( '--version', 'output version information, then exit' ) do
+			puts Stats::VERSION
+			exit
+		end
+	end
+
+	opts.parse!( args )
+	return options
+end
+
+
+if __FILE__ == $0
+	opts = parse_args( ARGV )
+	raise ArgumentError, "A naming format (-F) is required." unless opts.format
+
+	$stdout.sync = true
+	PGWarehouse.new( opts ).migrate
+end
+
+

data/yugabytedb-ysql.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/pg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yugabytedb-ysql"
+  spec.version       = YSQL::VERSION
+  spec.authors       = ["Michael Granger", "Lars Kanis", "YugabyteDB Dev Team"]
+  spec.email         = ["ged@FaerieMUD.org", "lars@greiz-reinsdorf.de", "info@yugabyte.com"]
+
+  spec.summary       = "The Ruby interface to YugabyteDB, based on PG Ruby Driver v#{YSQL::PG_VERSION}"
+  spec.description   = "Pg_YugabyteDB is the Ruby interface to the PostgreSQL-compatible YugabyteDB. It works with YugabyteDB 2.20 and later."
+  spec.homepage      = "https://github.com/yugabyte/ruby-pg"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yugabyte/ruby-pg"
+  spec.metadata["changelog_uri"] = "https://github.com/yugabyte/ruby-pg/blob/master/History.md"
+  spec.metadata["documentation_uri"] = "http://deveiate.org/code/pg"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|translation)/}) }
+  end
+  spec.extensions    = ["ext/extconf.rb"]
+  spec.require_paths = ["lib"]
+  spec.rdoc_options  = ["--main", "README.md",
+                        "--title", "YSQL: The Ruby Driver for YugabyteDB (YSQL)"]
+  spec.extra_rdoc_files = `git ls-files -z *.rdoc *.md lib/*.rb lib/*/*.rb lib/*/*/*.rb ext/*.c ext/*.h`.split("\x0")
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: yugabytedb-ysql
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Michael Granger
+- Lars Kanis
+- YugabyteDB Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-03 00:00:00.000000000 Z
+dependencies: []
+description: Pg_YugabyteDB is the Ruby interface to the PostgreSQL-compatible YugabyteDB.
+  It works with YugabyteDB 2.20 and later.
+email:
+- ged@FaerieMUD.org
+- lars@greiz-reinsdorf.de
+- info@yugabyte.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- Contributors.rdoc
+- History.md
+- README-OS_X.rdoc
+- README-Windows.rdoc
+- README.ja.md
+- README.md
+- ext/gvl_wrappers.c
+- ext/gvl_wrappers.h
+- ext/pg.c
+- ext/pg.h
+- ext/pg_binary_decoder.c
+- ext/pg_binary_encoder.c
+- ext/pg_coder.c
+- ext/pg_connection.c
+- ext/pg_copy_coder.c
+- ext/pg_errors.c
+- ext/pg_record_coder.c
+- ext/pg_result.c
+- ext/pg_text_decoder.c
+- ext/pg_text_encoder.c
+- ext/pg_tuple.c
+- ext/pg_type_map.c
+- ext/pg_type_map_all_strings.c
+- ext/pg_type_map_by_class.c
+- ext/pg_type_map_by_column.c
+- ext/pg_type_map_by_mri_type.c
+- ext/pg_type_map_by_oid.c
+- ext/pg_type_map_in_ruby.c
+- ext/pg_util.c
+- ext/pg_util.h
+- lib/pg/basic_type_map_based_on_result.rb
+- lib/pg/basic_type_map_for_queries.rb
+- lib/pg/basic_type_map_for_results.rb
+- lib/pg/basic_type_registry.rb
+- lib/pg/binary_decoder/date.rb
+- lib/pg/binary_decoder/timestamp.rb
+- lib/pg/binary_encoder/timestamp.rb
+- lib/pg/coder.rb
+- lib/pg/connection.rb
+- lib/pg/exceptions.rb
+- lib/pg/load_balance_service.rb
+- lib/pg/result.rb
+- lib/pg/text_decoder/date.rb
+- lib/pg/text_decoder/inet.rb
+- lib/pg/text_decoder/json.rb
+- lib/pg/text_decoder/numeric.rb
+- lib/pg/text_decoder/timestamp.rb
+- lib/pg/text_encoder/date.rb
+- lib/pg/text_encoder/inet.rb
+- lib/pg/text_encoder/json.rb
+- lib/pg/text_encoder/numeric.rb
+- lib/pg/text_encoder/timestamp.rb
+- lib/pg/tuple.rb
+- lib/pg/type_map_by_column.rb
+- lib/pg/version.rb
+- lib/ysql.rb
+files:
+- ".appveyor.yml"
+- ".gems"
+- ".gemtest"
+- ".github/workflows/binary-gems.yml"
+- ".github/workflows/source-gem.yml"
+- ".gitignore"
+- ".hgsigs"
+- ".hgtags"
+- ".irbrc"
+- ".pryrc"
+- ".tm_properties"
+- ".travis.yml"
+- BSDL
+- Contributors.rdoc
+- Gemfile
+- History.md
+- LICENSE
+- Manifest.txt
+- POSTGRES
+- README-OS_X.rdoc
+- README-Windows.rdoc
+- README.ja.md
+- README.md
+- Rakefile
+- Rakefile.cross
+- certs/ged.pem
+- certs/kanis@comcard.de.pem
+- certs/larskanis-2022.pem
+- certs/larskanis-2023.pem
+- certs/larskanis-2024.pem
+- ext/errorcodes.def
+- ext/errorcodes.rb
+- ext/errorcodes.txt
+- ext/extconf.rb
+- ext/gvl_wrappers.c
+- ext/gvl_wrappers.h
+- ext/pg.c
+- ext/pg.h
+- ext/pg_binary_decoder.c
+- ext/pg_binary_encoder.c
+- ext/pg_coder.c
+- ext/pg_connection.c
+- ext/pg_copy_coder.c
+- ext/pg_errors.c
+- ext/pg_record_coder.c
+- ext/pg_result.c
+- ext/pg_text_decoder.c
+- ext/pg_text_encoder.c
+- ext/pg_tuple.c
+- ext/pg_type_map.c
+- ext/pg_type_map_all_strings.c
+- ext/pg_type_map_by_class.c
+- ext/pg_type_map_by_column.c
+- ext/pg_type_map_by_mri_type.c
+- ext/pg_type_map_by_oid.c
+- ext/pg_type_map_in_ruby.c
+- ext/pg_util.c
+- ext/pg_util.h
+- ext/vc/pg.sln
+- ext/vc/pg_18/pg.vcproj
+- ext/vc/pg_19/pg_19.vcproj
+- lib/pg/basic_type_map_based_on_result.rb
+- lib/pg/basic_type_map_for_queries.rb
+- lib/pg/basic_type_map_for_results.rb
+- lib/pg/basic_type_registry.rb
+- lib/pg/binary_decoder/date.rb
+- lib/pg/binary_decoder/timestamp.rb
+- lib/pg/binary_encoder/timestamp.rb
+- lib/pg/coder.rb
+- lib/pg/connection.rb
+- lib/pg/exceptions.rb
+- lib/pg/load_balance_service.rb
+- lib/pg/result.rb
+- lib/pg/text_decoder/date.rb
+- lib/pg/text_decoder/inet.rb
+- lib/pg/text_decoder/json.rb
+- lib/pg/text_decoder/numeric.rb
+- lib/pg/text_decoder/timestamp.rb
+- lib/pg/text_encoder/date.rb
+- lib/pg/text_encoder/inet.rb
+- lib/pg/text_encoder/json.rb
+- lib/pg/text_encoder/numeric.rb
+- lib/pg/text_encoder/timestamp.rb
+- lib/pg/tuple.rb
+- lib/pg/type_map_by_column.rb
+- lib/pg/version.rb
+- lib/ysql.rb
+- misc/openssl-pg-segfault.rb
+- misc/postgres/History.txt
+- misc/postgres/Manifest.txt
+- misc/postgres/README.txt
+- misc/postgres/Rakefile
+- misc/postgres/lib/postgres.rb
+- misc/ruby-pg/History.txt
+- misc/ruby-pg/Manifest.txt
+- misc/ruby-pg/README.txt
+- misc/ruby-pg/Rakefile
+- misc/ruby-pg/lib/ruby/pg.rb
+- rakelib/task_extension.rb
+- sample/array_insert.rb
+- sample/async_api.rb
+- sample/async_copyto.rb
+- sample/async_mixed.rb
+- sample/check_conn.rb
+- sample/copydata.rb
+- sample/copyfrom.rb
+- sample/copyto.rb
+- sample/cursor.rb
+- sample/disk_usage_report.rb
+- sample/issue-119.rb
+- sample/losample.rb
+- sample/minimal-testcase.rb
+- sample/notify_wait.rb
+- sample/pg_statistics.rb
+- sample/replication_monitor.rb
+- sample/test_binary_values.rb
+- sample/wal_shipper.rb
+- sample/warehouse_partitions.rb
+- yugabytedb-ysql.gemspec
+homepage: https://github.com/yugabyte/ruby-pg
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/yugabyte/ruby-pg
+  source_code_uri: https://github.com/yugabyte/ruby-pg
+  changelog_uri: https://github.com/yugabyte/ruby-pg/blob/master/History.md
+  documentation_uri: http://deveiate.org/code/pg
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+- "--title"
+- 'YSQL: The Ruby Driver for YugabyteDB (YSQL)'
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key: 
+specification_version: 4
+summary: The Ruby interface to YugabyteDB, based on PG Ruby Driver v1.5.6
+test_files: []