intosql 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b676b287df23b8fe20bbcb97825e67771ac377d15b0bb92aeb74852c4e9e5dbe
-  data.tar.gz: 7486228ea1d9f8b5908c7b5d8a398f5a2c60d621d5984b13e6ac3af964fc552e
+  metadata.gz: e1bd39e307362f1004ebb0c6b2cafe15fd5048483237a1c4d4964bd09b4cea5f
+  data.tar.gz: 9b8b6b32ff26c1f73ff8522b766162cd238ae6c8e817c5fb2ee3adae52170d58
 SHA512:
-  metadata.gz: 3397f1e8a866a81eb52e64c6db766df8709f49b0fc3cab1b6cafef0b0f076df9e9e0b8c9f0b5a5a689c4aa18df3bc82d64383db7bdeff12363b928dcb7898494
-  data.tar.gz: 932b8af6b15e7ffab77f9f65ade11449eee62cfc553d36e7b8b1812115b61d1ad023210479e693d331ae803b950c192868c7341f23b4c891e19e032ac8cf9761
+  metadata.gz: 58af7ac347d3f456b8c77a05fd1829111303fa3e1bea35b76193fecc2e41b0ad348052dba3a3258d5dcd05c23f329d3ff08e702cca863c855835d42057e2bcbd
+  data.tar.gz: 8e85321133271a88a84dc97a3835f8038a551c4f3af6f4050f7094fce8db284be581a84da7e20144dafbcc6bd9b0b956e8656df11bd911caaed0d408a083cb96

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.1
+
+- The README says a MySQL or MariaDB dump converts to any of the six databases, and its report carries the codes of each target.
+
+## 0.2.0
+
+- Reports of database dumps: `source`, `tables` and `not_converted`.
+
 ## 0.1.0
 
 - `convert` and `convert_url`, every conversion endpoint (`create`, `create_from_url`, `upload`, `start`, `retrieve`, `list`, `cancel`, `create_case`, `delete`, `wait`), `usage` and `spec`.

data/README.md

@@ -22,6 +22,16 @@ puts conversion.report[:rows][:converted], conversion.output.url
 
 The file streams to storage as it is; the output URL downloads the script for ten minutes. Read the conversion again (`intosql.conversions.retrieve(id)`) for a fresh one.
 
+A MySQL or MariaDB dump (`.sql`, `.sql.gz`) converts to any of the six databases like any file. `job_report` reads the report with each of its tables:
+
+```ruby
+conversion = intosql.convert("shop.sql.gz", spec: IntoSQL.spec(dialect: "postgresql"))
+
+conversion.job_report.tables.each do |table|
+  puts "#{table.name}: #{table.rows} rows"
+end
+```
+
 ## Convert a file by URL
 
 ```ruby

data/lib/intosql/models.rb

@@ -36,7 +36,8 @@ module IntoSQL
     end
   end
 
-  # A conversion as the API answers it. `spec` and `report` are hashes with symbol keys.
+  # A conversion as the API answers it. `spec` and `report` are hashes with symbol keys;
+  # `job_report` reads `report` as a typed JobReport.
   Conversion = Struct.new(
     :id, :status, :name, :bytes, :spec, :report, :error, :output, :upload,
     :created_at, :started_at, :finished_at, :expires_at,
@@ -49,6 +50,11 @@ module IntoSQL
       fields[:upload] &&= UploadTarget.from_h(fields[:upload])
       new(**fields)
     end
+
+    # The report as a JobReport, or nil before the conversion ran.
+    def job_report
+      report && JobReport.from_h(report)
+    end
   end
 
   # A conversion sent to IntoSQL because it didn't come out right.

data/lib/intosql/report.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module IntoSQL
+  # What a database dump defines besides tables. The engine may add kinds; they arrive as plain strings.
+  module ObjectKind
+    VIEW = "view"
+    TRIGGER = "trigger"
+    PROCEDURE = "procedure"
+    FUNCTION = "function"
+    EVENT = "event"
+    ALL = [VIEW, TRIGGER, PROCEDURE, FUNCTION, EVENT].freeze
+  end
+
+  # A correction the engine made, numbered like a proofreader's mark. `code` is a string.
+  Fix = Struct.new(:number, :code, :column, :row, :args, keyword_init: true) do
+    extend Model
+  end
+
+  # Something that stopped the conversion, left a row out or needs a look. `code` is a string.
+  Problem = Struct.new(:code, :severity, :column, :row, :args, keyword_init: true) do
+    extend Model
+  end
+
+  # One column as it was read and as it was written. `fixes` holds the numbers of the fixes that touched it.
+  ColumnReport = Struct.new(
+    :source_name, :name, :sql_type, :kind, :precision, :scale, :max_chars, :nullable, :fixes, :excluded, :as_text,
+    keyword_init: true
+  ) do
+    def self.from_h(hash)
+      new(**hash.slice(*members), fixes: hash[:fixes] || [])
+    end
+  end
+
+  # Where a database dump comes from: `dialect`, `version`, `producer`, `charset` and `databases`.
+  SourceReport = Struct.new(:dialect, :version, :producer, :charset, :databases, keyword_init: true) do
+    def self.from_h(hash)
+      new(**hash.slice(*members), databases: hash[:databases] || [])
+    end
+  end
+
+  # One table of a database dump, with its own rows, columns, fixes and problems.
+  TableReport = Struct.new(:source_name, :name, :schema, :rows, :columns, :fixes, :problems, keyword_init: true) do
+    def self.from_h(hash)
+      new(
+        **hash.slice(*members),
+        columns: Reports.list(hash[:columns], ColumnReport),
+        fixes: Reports.list(hash[:fixes], Fix),
+        problems: Reports.list(hash[:problems], Problem)
+      )
+    end
+  end
+
+  # A view, trigger, routine or event of a dump that the conversion did not carry.
+  NotConverted = Struct.new(:kind, :name, keyword_init: true) do
+    extend Model
+  end
+
+  # What a conversion did. `input`, `rows` and `timings` stay hashes with symbol keys.
+  # For a database dump, `source`, `tables` and `not_converted` say what it held; otherwise they are nil and empty.
+  JobReport = Struct.new(
+    :version, :input, :dialect, :table, :columns, :rows, :fixes, :problems, :timings,
+    :source, :tables, :not_converted,
+    keyword_init: true
+  ) do
+    def self.from_h(hash)
+      new(
+        **hash.slice(*members),
+        columns: Reports.list(hash[:columns], ColumnReport),
+        fixes: Reports.list(hash[:fixes], Fix),
+        problems: Reports.list(hash[:problems], Problem),
+        source: hash[:source] && SourceReport.from_h(hash[:source]),
+        tables: Reports.list(hash[:tables], TableReport),
+        not_converted: Reports.list(hash[:not_converted], NotConverted)
+      )
+    end
+  end
+
+  # Builds the typed lists of a report, empty when the field is missing.
+  module Reports
+    def self.list(items, type)
+      (items || []).map { |item| type.from_h(item) }
+    end
+  end
+end

data/lib/intosql/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IntoSQL
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/intosql.rb

@@ -3,6 +3,7 @@
 require_relative "intosql/version"
 require_relative "intosql/errors"
 require_relative "intosql/models"
+require_relative "intosql/report"
 require_relative "intosql/transport"
 require_relative "intosql/source"
 require_relative "intosql/spec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intosql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - IntoSQL
@@ -24,6 +24,7 @@ files:
 - lib/intosql/conversions.rb
 - lib/intosql/errors.rb
 - lib/intosql/models.rb
+- lib/intosql/report.rb
 - lib/intosql/source.rb
 - lib/intosql/spec.rb
 - lib/intosql/transport.rb