dbsh 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv-version

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dbsh.gemspec
+gemspec
+gem 'rake'
+gem 'sqlite3'
+gem 'ruby-debug'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dan Hensgen
+
+MIT License
+
+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,40 @@
+# Dbsh
+
+A database console like psql. This is a proof of concept; use at your own risk.
+
+## Installation
+
+    $ gem install dbsh
+
+## Usage
+
+Define a connection in `~/.dbsh`:
+
+    mydb:
+      adapter: mysql
+      host: localhost
+      username: root
+      password: password
+      database: mydb
+
+Then run `dbsh` with your connection:
+
+    $ dbsh mydb
+
+And ask dbsh for help:
+
+    > \h
+
+Dbsh uses [Sequel](http://sequel.rubyforge.org/) for database access, so you
+should be able to connect to anything Sequel can. You'll probably need to
+install [the right database
+gem](http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html) to
+get connected.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/Thorfile

@@ -0,0 +1,6 @@
+class Dbsh < Thor
+  desc 'db_reset', 'Delete and recreate the database'
+  def db_reset
+    system 'rm test.sqlite3 && sqlite3 test.sqlite3 < schema.sql'
+  end
+end

data/bin/dbsh

@@ -0,0 +1,210 @@
+#! /usr/bin/env ruby
+
+require 'readline'
+require 'sequel'
+require 'terminal-table'
+require 'yaml'
+
+#DB = Sequel.oracle 'cink', :user => 'dhensgen', :password => '...'
+#puts DB.fetch('select count(1) from prod_sched').first
+
+config = YAML.load(File.read("#{ENV['HOME']}/.dbsh"))[ARGV[0]]
+DB = Sequel.connect(config)
+
+File.open("#{ENV['HOME']}/.dbsh_history", 'r') do |f|
+  f.each_line do |line|
+    Readline::HISTORY << line.strip
+  end
+end
+
+#Example ~/.dbsh:
+#dbsh_test:
+#  adapter: sqlite
+#  database: test.sqlite3
+# 
+## :adapter=>'postgres', :host=>'localhost', :database=>'blog', :user=>'user', :password=>'password'
+
+HELP = <<END
+\\h             Show this help
+\\d             Show tables
+\\d table_name  Show table columns
+\\. file_name   Execute a sql file
+\\e file_name   Edit file and then execute it
+\\q             Quit
+END
+
+def statement_type(statement)
+  case statement
+    when /\s*select/i then :select
+    when /\s*insert/i then :insert
+    when /\s*update/i then :update
+    when /\s*delete/i then :delete
+    when /\s*\\/i then :command
+    else nil
+  end
+end
+
+def process_statement(statement)
+  case statement_type(statement)
+  when :select
+    dataset = DB[statement]
+    table = Terminal::Table.new(:headings => dataset.columns) do |t|
+      dataset.each do |row|
+        t.add_row(dataset.columns.map {|col| row[col]})
+      end
+    end
+    puts table
+  when :insert
+    DB[statement].insert
+    puts 'Inserted row'
+  when :update
+    puts "Updated #{DB[statement].update} rows"
+  when :delete
+    puts "Deleted #{DB[statement].delete} rows"
+  else
+    puts 'Unknown statement type'
+  end
+end
+
+def process_command(command)
+  case command
+  when /\\q/
+    exit(0)
+  when /\\\./
+    process_statement(File.read(command.split(/\s+/)[1]))
+  when /\\d(\s+\w+)?/
+    if $1
+      table = Terminal::Table.new(:headings => ['Name', 'Type']) do |t|
+        DB.schema($1.strip).each do |col|
+          t.add_row [col.first.to_s, col.last[:db_type]]
+        end
+      end
+      puts table
+    else
+      puts DB.tables.join("\n")
+    end
+  when /\\e\s+(.+)?/
+    if $1
+      system(ENV['EDITOR'], $1)
+      process_statement(File.read $1)
+    else
+      puts DB.tables.join("\n")
+    end
+  when /\\h/
+    puts HELP
+  else
+    puts 'Unknown command'
+  end
+end
+
+File.open("#{ENV['HOME']}/.dbsh_history", 'a') do |history|
+  while line = Readline.readline('> ', true)
+    history.write(line + "\n"); history.flush
+    begin
+      statement_type = statement_type(line)
+      if statement_type == :command
+        process_command(line)
+      else
+        process_statement(line)
+      end
+    rescue Exception => e
+      exit(0) if SystemExit === e 
+      puts 'Error: ' + e.message
+    end
+  end
+end
+
+__END__
+
+OVERVIEW
+
+  A clone of mysql cli with these enhancements:
+
+MVP
+
+X  Connect to databases by name:
+X
+X    $ dbsh rockwell_dev
+X    ~/.dbsh:
+X      rockwell_dev:
+X        adapter: mysql
+X        username: root
+X        password:
+X        database: rockwell_dev
+
+X  Connect to different types of databases:
+X
+X    * mysql
+X    * oracle
+X    * sqlite
+X    * postgres
+
+X  Execute sql:
+X
+X    > select * from illustrations;
+X    id  name     updated_at
+X    --  -------  ----------
+X    10  Filmore  2012-06-12
+X
+X    > delete from illustrations;
+X    Deleted 1 row.
+
+X  Quit:
+X
+X    > \q
+X    $
+
+X  Report errors:
+X
+X    > foo;
+X    ERROR: What is foo?
+
+X  Install:
+X
+X    $ gem install dbsh
+
+X  Readline support:
+X
+X    * History
+X    * Edit line
+
+X  Execute a sql script:
+X
+X    > \. illustrations.sql
+X    ...
+
+X  Explore the database:
+X
+X    > show tables;
+X    name
+X    -------------
+X    illustrations
+X    builds
+X
+X    > desc illustrations;
+X    name       type
+X    ---------- ------------ 
+X    id         integer
+X    name       varchar(256)
+X    updated_at datetime
+
+X  Edit and run a sql script:
+X
+X    > \e illustrations.sql
+X    (open script in $EDITOR, execute script if changes were made)
+
+  Semicolons
+
+    > select 1; select 2
+
+  Execute a sql script from the command line:
+
+    $ dbsh rockwell_dev < illustrations.sql
+    ...
+
+Beyond MVP:
+
+  * Export csv
+  * Color output
+  * Parameterized sql scripts
+  * Column filtering

data/dbsh.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dbsh/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dan Hensgen"]
+  gem.email         = ["dan@methodhead.com"]
+  gem.description   = %q{A database cli in Ruby, like the psql client for Postgres.}
+  gem.summary       = %q{A database cli in Ruby}
+  gem.homepage      = "http://github.com/dmeiz/dbsh"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "dbsh"
+  gem.require_paths = ["lib"]
+  gem.version       = Dbsh::VERSION
+
+  gem.add_dependency('sequel', '>= 3.36.0')
+  gem.add_dependency('terminal-table', '>= 1.4.0')
+end

data/lib/dbsh.rb

@@ -0,0 +1,5 @@
+require "dbsh/version"
+
+module Dbsh
+  # Your code goes here...
+end

data/lib/dbsh/version.rb

@@ -0,0 +1,3 @@
+module Dbsh
+  VERSION = "0.0.1"
+end

data/schema.sql

@@ -0,0 +1,23 @@
+create table dogs (
+  id integer,
+  name varchar(255),
+  breed varchar(255),
+  weight double,
+  created_at datetime,
+  updated_at datetime
+);
+
+insert into dogs values (1, 'Rover', 'Lab', 25.0, '2012-06-06 00:00:00', '2012-06-06 00:00:00');
+insert into dogs values (2, 'Rex', 'Retreiver', 35.0, '2012-06-07 00:00:00', '2012-06-07 00:00:00');
+
+create table cats (
+  id integer,
+  name varchar(255),
+  breed varchar(255),
+  weight double,
+  created_at datetime,
+  updated_at datetime
+);
+
+insert into cats values (1, 'Garfield', 'Tabby', 25.0, '2012-06-06 00:00:00', '2012-06-06 00:00:00');
+insert into cats values (2, 'Tiger', 'Persian', 35.0, '2012-06-07 00:00:00', '2012-06-07 00:00:00');

data/show_dogs.sql

@@ -0,0 +1,4 @@
+select
+  *
+from
+  dogs

data/terminal_table.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'terminal-table'
+
+table = Terminal::Table.new(:headings => ['foo', 'bar']) do |t|
+  t.add_row ['wam', 'bam']
+end
+
+puts table

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: dbsh
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dan Hensgen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 151
+        segments: 
+        - 3
+        - 36
+        - 0
+        version: 3.36.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: terminal-table
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id002
+description: A database cli in Ruby, like the psql client for Postgres.
+email: 
+- dan@methodhead.com
+executables: 
+- dbsh
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Thorfile
+- bin/dbsh
+- dbsh.gemspec
+- lib/dbsh.rb
+- lib/dbsh/version.rb
+- schema.sql
+- show_dogs.sql
+- terminal_table.rb
+homepage: http://github.com/dmeiz/dbsh
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A database cli in Ruby
+test_files: []
+
+has_rdoc: