innodb_ruby 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21b726dd85c361262f577f663a70b008acb56f45fc2a1632147bc94eb622141e
-  data.tar.gz: 720eda759132e67b03c8bcd9c0e50a90625f3de214048e870875cb964bdd8bbe
+  metadata.gz: c2dd793281e3b83403e55c8d4e9104898d5df6099af80dd4453795a524e3fb32
+  data.tar.gz: d6ac28ab11759a618f9a84af611a705644f5f47f9c1cd387360b628bac88f527
 SHA512:
-  metadata.gz: 1814840cf61fd850140e282ea2706c196563881e4de69e6612e890b8dcd6e9b93cd4dbc73c61d8c02fbc071c3e339223eea4d0af636ef00a4505ab1f143e207e
-  data.tar.gz: 85b0326cc2b029ab24a493e1b781e4f9239533bff9b1849e67a4672493ce9775006a08004ce1a4d9aa724b0324354c67465cfcdfa3a722032c7c34f90822c6c1
+  metadata.gz: ffb5ba4b9805d4cb78aaecaec92adb4e6064d73a9349fbeb43fcc938b958adeb14f140747dd540f76d31bbf9a38fbde259bd99f3a9cc64f32a1456efc2006997
+  data.tar.gz: 9e98bd61fe4448fdbb15be66975581fe65d97c342685c21f2309ead8b0ed1fc217b08baf2855c336d8ea426e22b7c0556e0926064722e6cc23a95312a6a63ca4

data/bin/innodb_space

@@ -6,6 +6,18 @@ require "ostruct"
 require "histogram/array"
 require "innodb"
 
+class String
+  def squish!
+    gsub!(/[[:space:]]+/, " ")
+    strip!
+    self
+  end
+
+  def squish
+    dup.squish!
+  end
+end
+
 # Convert a floating point RGB array into an ANSI color number approximating it.
 def rgb_to_ansi(rgb)
   rgb_n = rgb.map { |c| (c * 5.0).round }
@@ -1045,6 +1057,8 @@ def record_dump(page, record_offset)
   raise "Record at offset #{record_offset} not found" unless record
 
   record.dump
+rescue IOError
+  raise "Record could not be read at offset #{record_offset}; is it a valid record offset?"
 end
 
 def record_history(page, record_offset)
@@ -1243,14 +1257,15 @@ Usage: innodb_space <options> <mode>
 
 Invocation examples:
 
-  innodb_space -s ibdata1 [-T tname [-I iname]] [options] <mode>
-    Use ibdata1 as the system tablespace and load the tname table (and the
-    iname index for modes that require it) from data located in the system
-    tablespace data dictionary. This will automatically generate a record
-    describer for any indexes.
+  innodb_space -s ibdata1 [-T table-name [-I index-name [-R record-offset]]] [options] <mode>
+    Use ibdata1 as the system tablespace and load the table-name table (and
+    the index-name index for modes that require it) from data located in the
+    system tablespace data dictionary. This will automatically generate a
+    record describer for any indexes using the data dictionary.
 
-  innodb_space -f tname.ibd [-r ./desc.rb -d DescClass] [options] <mode>
-    Use the tname.ibd table (and the DescClass describer where required).
+  innodb_space -f file-name.ibd [-r ./describer.rb -d DescriberClass] [options] <mode>
+    Use the file-name.ibd tablespace file (and the DescriberClass describer
+    where required) to read the tablespace structures or indexes.
 
 The following options are supported:
 
@@ -1269,11 +1284,22 @@ The following options are supported:
     files named 'ibdata?' which will then be sorted alphabetically and used to
     load the system tablespace.
 
-  --table-name, -T <name>
-    Use the table name <name>.
+  If using the --system-space-file option, the following options may also
+  be used:
+
+    --table-name, -T <name>
+      Use the table name <name>.
+
+    --index-name, -I <name>
+      Use the index name <name>.
 
-  --index-name, -I <name>
-    Use the index name <name>.
+    --system-space-tables, -x
+      Allow opening tables from the system space to support system spaces with
+      tables created without innodb-file-per-table enabled.
+
+    --data-directory, -D <directory>
+      Open per-table tablespace files from <directory> rather than from the
+      directory where the system-space-file is located.
 
   --space-file, -f <file>
     Load the tablespace file <file>.
@@ -1281,6 +1307,9 @@ The following options are supported:
   --page, -p <page>
     Operate on the page <page>.
 
+  --record, -R <offset>
+    Operate on the record located at <offset> within the index page.
+
   --level, -l <level>
     Operate on the level <level>.
 
@@ -1451,12 +1480,15 @@ END_OF_USAGE
   exit exit_code
 end
 
-Signal.trap("INT")  { exit }
-Signal.trap("PIPE") { exit }
+%w[INT PIPE].each do |name|
+  Signal.trap(name) { exit } if Signal.list.include?(name)
+end
 
 @options = OpenStruct.new
 @options.trace                    = 0
 @options.system_space_file        = nil
+@options.system_space_tables      = false
+@options.data_directory           = nil
 @options.space_file               = nil
 @options.table_name               = nil
 @options.index_name               = nil
@@ -1474,6 +1506,8 @@ getopt_options = [
   [ "--help",                     "-?",     GetoptLong::NO_ARGUMENT ],
   [ "--trace",                    "-t",     GetoptLong::NO_ARGUMENT ],
   [ "--system-space-file",        "-s",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--system-space-tables",      "-x",     GetoptLong::NO_ARGUMENT ],
+  [ "--data-directory",           "-D",     GetoptLong::REQUIRED_ARGUMENT ],
   [ "--space-file",               "-f",     GetoptLong::REQUIRED_ARGUMENT ],
   [ "--table-name",               "-T",     GetoptLong::REQUIRED_ARGUMENT ],
   [ "--index-name",               "-I",     GetoptLong::REQUIRED_ARGUMENT ],
@@ -1499,6 +1533,10 @@ getopt.each do |opt, arg|
     @options.trace += 1
   when "--system-space-file"
     @options.system_space_file = arg.split(",")
+  when "--system-space-tables"
+    @options.system_space_tables = true
+  when "--data-directory"
+    @options.data_directory = arg
   when "--space-file"
     @options.space_file = arg.split(",")
   when "--table-name"
@@ -1529,11 +1567,24 @@ end
 # rubocop:disable Style/IfUnlessModifier
 
 unless @options.system_space_file || @options.space_file
-  usage 1, "System space file (-s) or space file (-f) must be specified"
+  usage(1, "Either the --system-space-file (-s) or --space-file (-f) must be specified")
 end
 
 if @options.system_space_file && @options.space_file
-  usage 1, "Only one of system space or space file may be specified"
+  usage(1, "Only one of --system-space-file (-s) or --space-file (-f) may be specified")
+end
+
+system_space_options =
+  @options.table_name || @options.index_name || @options.system_space_tables || @options.data_directory
+
+if !@options.system_space_file && system_space_options
+  usage(
+    1,
+    %{
+      The --table-name (-T), --index-name (-I), --system-space-tables (-x), and --data-directory (-D)
+      options can only be used with the --system-space-file (-s) option
+    }.squish
+  )
 end
 
 BufferCursor.trace! if @options.trace > 1
@@ -1545,12 +1596,18 @@ index = nil
 page = nil
 
 if @options.system_space_file
-  innodb_system = Innodb::System.new(@options.system_space_file)
+  innodb_system = Innodb::System.new(@options.system_space_file, data_directory: @options.data_directory)
 end
 
 if innodb_system && @options.table_name
   table_tablespace = innodb_system.space_by_table_name(@options.table_name)
-  space = table_tablespace || innodb_system.system_space
+  if table_tablespace
+    space = table_tablespace
+  elsif @options.system_space_tables
+    space = innodb_system.system_space
+  else
+    raise "Tablespace file not found and --system-space-tables (-x) is not enabled"
+  end
 elsif @options.space_file
   space = Innodb::Space.new(@options.space_file)
 else
@@ -1580,39 +1637,57 @@ unless mode
 end
 
 if /^(system-|data-dictionary-)/.match(mode) && !innodb_system
-  usage(1, "System tablespace must be specified using -s/--system-space-file")
+  usage(1, "System tablespace must be specified using --system-space-file (-s)")
 end
 
 if /^space-/.match(mode) && !space
   usage(
     1,
-    "Tablespace must be specified using either -f/--space-file " \
-    "or a combination of -s/--system-space-file and -T/--table"
+    %{
+      Tablespace must be specified using either --space-file (-f)
+      or a combination of --system-space-file (-s) and --table (-T)
+    }.squish
   )
 end
 
 if /^index-/.match(mode) && !index
   usage(
     1,
-    "Index must be specified using a combination of either -f/--space-file and -p/--page " \
-    "or -s/--system-space-file, -T/--table-name, and -I/--index-name"
+    %{
+      Index must be specified using a combination of either --space-file (-f) and --page (-p)
+      or --system-space-file (-s), --table-name (-T), and --index-name (-I)
+    }.squish
   )
 end
 
 if /^page-/.match(mode) && !page
-  usage(1, "Page number must be specified using -p/--page")
+  usage(1, "Page number must be specified using --page (-p)")
 end
 
 if /^record-/.match(mode) && !@options.record
-  usage(1, "Record offset must be specified using -R/--record")
+  usage(1, "Record offset must be specified using --record (-R)")
+end
+
+if /^record-/.match(mode) && !page
+  usage(
+    1,
+    %{
+      An index page must be available when using --record (-R); specify either
+      --page (-p) or --table-name (-T) and --index-name (-I) for the index root page.
+    }
+  )
+end
+
+if /^record-/.match(mode) && page.type != :INDEX
+  usage(1, "Mode #{mode} may be used only with index pages")
 end
 
 if /-list-iterate$/.match(mode) && !@options.list
-  usage(1, "List name must be specified using -L/--list")
+  usage(1, "List name must be specified using --list (-L)")
 end
 
 if /-level-/.match(mode) && !@options.level
-  usage(1, "Level must be specified using -l/--level")
+  usage(1, "Level must be specified using --level (-l)")
 end
 
 if %w[
@@ -1621,13 +1696,13 @@ if %w[
   index-digraph
   index-level-summary
 ].include?(mode) && !index.record_describer
-  usage(1, "Record describer must be specified using -d/--describer")
+  usage(1, "Record describer must be specified using --describer (-d)")
 end
 
 if %w[
   space-index-fseg-pages-summary
 ].include?(mode) && !@options.fseg_id
-  usage(1, "File segment id must be specified using -F/--fseg-id")
+  usage(1, "File segment id must be specified using --fseg-id (-F)")
 end
 
 # rubocop:enable Style/IfUnlessModifier

data/lib/innodb/list.rb

@@ -100,6 +100,11 @@ module Innodb
       @base.length
     end
 
+    # Is the list currently empty?
+    def empty?
+      length.zero?
+    end
+
     # Return the first object in the list using the list base node "first"
     # address pointer.
     def first

data/lib/innodb/system.rb

@@ -19,7 +19,7 @@ module Innodb
     # The space ID of the system space, always 0.
     SYSTEM_SPACE_ID = 0
 
-    def initialize(arg)
+    def initialize(arg, data_directory: nil)
       if arg.is_a?(Array) && arg.size > 1
         data_filenames = arg
       else
@@ -35,7 +35,7 @@ module Innodb
       @spaces = {}
       @orphans = []
       @config = {
-        datadir: File.dirname(data_filenames.first),
+        data_directory: data_directory || File.dirname(data_filenames.first),
       }
 
       add_space_file(data_filenames)
@@ -70,7 +70,7 @@ module Innodb
     # Add a space by table name, constructing an appropriate filename
     # from the provided table name.
     def add_table(table_name)
-      space_file = "%s/%s.ibd" % [config[:datadir], table_name]
+      space_file = "%s/%s.ibd" % [config[:data_directory], table_name]
       if File.exist?(space_file)
         add_space_file(space_file)
       else

data/lib/innodb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Innodb
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: innodb_ruby
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Jeremy Cole
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-17 00:00:00.000000000 Z
+date: 2021-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata