bigquery_migration 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 305437e02b080f7394ac109f9ccde37f7cf9a02f
+  data.tar.gz: c3f890726c06b6cfa7830240bf8f701a7957d14f
+SHA512:
+  metadata.gz: 4ace45d55a36b4c62e1561c754ac83c18ae7ed1b8148bde2c8e8c40136a852346ee7a30ebda0731e5ee8d390bf3e34d660393c5d040adae1c9889de0f03cd5f9
+  data.tar.gz: 7626f505d9580eee34731800bee1e1a655e5d64be5e192895898e3ac5d1fbea21ffc47d134cfbfa6ceaa85e52e63e18506bf5d9eea87b4dacfed4654513638b1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+your-project-000.json

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sonots@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# BigqueryMigration
+
+BigqueryMigraiton is a tool or a ruby library to migrate (or alter) BigQuery table schema.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bigquery_migration'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bigquery_migration
+
+## Usage
+
+### CLI
+
+config.yml
+
+```yaml
+bigquery: &bigquery
+  json_keyfile: your-project-000.json
+  dataset: your_dataset_name
+  table: your_table_name
+
+actions:
+- action: create_dataset
+  <<: *bigquery
+- action: migrate_table
+  <<: *bigquery
+  columns:
+    - { name: 'timestamp', type: 'TIMESTAMP' }
+    - name: 'record'
+      type: 'RECORD'
+      fields:
+        - { name: 'string', type: 'STRING' }
+        - { name: 'integer', type: 'INTEGER' }
+```
+
+Run
+
+```
+$ bundle exec bq_migrate run config.yml # dry-run
+$ bundle exec bq_migrate run config.yml --exec
+```
+
+### Library
+
+```ruby
+require 'bigquery_migration'
+
+config = {
+  json_keyfile: '/path/to/your-project-000.json'
+  dataset: 'your_dataset_name'
+  table: 'your_table_name'
+}
+columns = [
+  { name: 'string', type: 'STRING' },
+  { name: 'record', type: 'RECORD', fields: [
+    { name: 'integer', type: 'INTEGER' },
+    { name: 'timestamp', type: 'TIMESTAMP' },
+  ] }
+]
+
+migrator = BigqueryMigration.new(config)
+migrator.migrate_table(columns: columns)
+# migrator.migrate_table(schema_file: '/path/to/schema.json')
+```
+
+## Development
+
+### Run example:
+
+Prepare `example/your-project-000.json`, then
+
+```
+$ bundle exec bq_migrate run example/example.yml # dry-run
+$ bundle exec bq_migrate run example/example.yml --exec
+```
+
+### Run test:
+
+```
+$ bundle exec rake test
+```
+
+To run tests which directly connects to BigQuery, prepare `example/your-project-000.json`, then
+
+````
+$ bundle exec rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/bigquery_migration. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+desc 'Run test_unit based test'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = Dir["test/**/test_*.rb"].sort
+  t.verbose = true
+end
+task :default => :test

data/bigquery_migration.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bigquery_migration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bigquery_migration"
+  spec.version       = BigqueryMigration::VERSION
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+
+  spec.summary       = %q{Migrate BigQuery table schema}
+  spec.description   = %q{Migrate BigQuery table schema.}
+  spec.homepage      = "https://github.com/sonots/bigquery_migration"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "google-api-client"
+  spec.add_dependency "tzinfo"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "test-unit-rr"
+  spec.add_development_dependency "test-unit-power_assert"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bigquery_migration"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/example.yml

@@ -0,0 +1,22 @@
+bigquery: &bigquery
+  json_keyfile: example/your-project-000.json
+  dataset: your_dataset_name
+  table: your_table_name
+
+actions:
+- action: create_dataset
+  <<: *bigquery
+- action: migrate_table
+  <<: *bigquery
+  columns:
+    - { name: 'timestamp', type: 'TIMESTAMP' }
+    - name: 'record'
+      type: 'RECORD'
+      fields:
+        - { name: 'string', type: 'STRING' }
+        - { name: 'integer', type: 'INTEGER' }
+- action: migrate_table
+  <<: *bigquery
+  schema_file: example/schema.json
+- action: delete_table
+  <<: *bigquery

data/example/schema.json

@@ -0,0 +1,22 @@
+[
+  {
+    "name":"timestamp",
+    "type":"TIMESTAMP"
+  },
+  {
+    "name":"long",
+    "type":"INTEGER"
+  },
+  {
+    "name":"string",
+    "type":"STRING"
+  },
+  {
+    "name":"double",
+    "type":"FLOAT"
+  },
+  {
+    "name":"boolean",
+    "type":"BOOLEAN"
+  }
+]

data/exe/bq_migrate

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/bigquery_migration/cli'
+BigqueryMigration::CLI.start(ARGV)

data/lib/bigquery_migration.rb

@@ -0,0 +1,29 @@
+require "bigquery_migration/version"
+require "bigquery_migration/error"
+require "bigquery_migration/schema"
+require "bigquery_migration/logger"
+require "bigquery_migration/bigquery_wrapper"
+
+class BigqueryMigration
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def initialize(*args)
+    @wrapper = BigqueryWrapper.new(*args)
+  end
+
+  # Delegate to BigqueryWrapper instance
+  BigqueryWrapper.instance_methods(false).each do |name|
+    next if method_defined?(name)
+    class_eval <<-"EOS", __FILE__, __LINE__ + 1
+      def #{name}(*args, &block)
+        @wrapper.#{name}(*args, &block)
+      end
+    EOS
+  end
+end

data/lib/bigquery_migration/action.rb

@@ -0,0 +1,85 @@
+require_relative 'schema'
+require_relative 'error'
+require_relative 'hash_util'
+require_relative 'bigquery_wrapper'
+
+class BigqueryMigration
+  class Action
+    attr_reader :config, :opts
+
+    def initialize(config, opts = {})
+      @config = HashUtil.deep_symbolize_keys(config)
+      @opts = HashUtil.deep_symbolize_keys(opts)
+
+      @action = @config[:action]
+      unless self.class.supported_actions.include?(@action)
+        raise ConfigError, "Action #{@action} is not supported"
+      end
+    end
+
+    def run
+      begin
+        success = true
+        result = send(@action)
+      rescue => e
+        result = { error: e.message, error_class: e.class.to_s, error_backtrace: e.backtrace }
+        success = false
+      ensure
+        success = false if result[:success] == false
+      end
+      [success, result]
+    end
+
+    def self.supported_actions
+      Set.new(%w[
+        create_dataset
+        create_table
+        delete_table
+        patch_table
+        migrate_table
+        insert
+        preview
+      ])
+    end
+
+    def client
+      @client ||= BigqueryMigration.new(@config, @opts)
+    end
+
+    def create_dataset
+      client.create_dataset
+    end
+
+    def create_table
+      client.create_table(columns: config[:columns])
+    end
+
+    def delete_table
+      client.delete_table
+    end
+
+    def patch_table
+      client.patch_table(
+        columns: config[:columns],
+        add_columnss: config[:add_columnss]
+      )
+    end
+
+    def migrate_table
+      client.migrate_table(
+        schema_file: config[:schema_file],
+        columns: config[:columns],
+        backup_dataset: config[:backup_dataset],
+        backup_table: config[:backup_table]
+      )
+    end
+
+    def insert
+      client.insert_all_table_data(rows: config[:rows])
+    end
+
+    def preview
+      client.list_table_data(max_results: config[:max_results])
+    end
+  end
+end