ddbcli 0.1.0

data/README

@@ -0,0 +1,148 @@
+= sdbcli
+
+== Description
+
+ddbcli is an interactive command-line client of Amazon DynamoDB.
+
+== Source Code
+
+https://bitbucket.org/winebarrel/ddbcli
+
+== Install
+
+  shell> gem install ddbcli
+  shell> export AWS_ACCESS_KEY_ID='...'
+  shell> export AWS_SECRET_ACCESS_KEY='...'
+  shell> export DDB_REGION=ap-northeast-1
+  shell> ddbcli -e 'show tables'
+  [
+    "employees"
+  ]
+  
+  shell> ddbcli -h
+  Usage: ddbcli [options]
+      -k, --access-key=ACCESS_KEY
+      -s, --secret-key=SECRET_KEY
+      -r, --region=REGION_OR_ENDPOINT
+      -e, --eval=COMMAND
+      -t, --timeout=SECOND
+          --consistent-read
+          --retry=NUM
+          --retry-interval=SECOND
+          --debug
+      -h, --help
+  
+  ##### Query #####
+  
+  SHOW TABLES
+    displays a table list
+  
+  SHOW REGIONS
+    displays a region list
+  
+  SHOW CREATE TABLE table_name
+    displays a CREATE TABLE statement
+  
+  CREATE TABLES table_name (
+       key_name {STRING|NUMBER|BINARY} HASH
+    [, key_name {STRING|NUMBER|BINARY} RANGE]
+    [, INDEX index1_name (attr1 {STRING|NUMBER|BINARY}) {ALL|KEYS_ONLY|INCLUDE (attr, ...)}
+     , INDEX index2_name (attr2 {STRING|NUMBER|BINARY}) {ALL|KEYS_ONLY|INCLUDE (attr, ...)}
+     , ...]
+  )
+    creates a table
+  
+  DROP TABLE table_name
+    deletes a table
+  
+  GET {*|attrs} FROM table_name WHERE key1 = '...' AND ...
+    gets items
+  
+  INSERT INTO table_name (attr1, attr2, ...) VALUES ('val1', 'val2', ...), ('val3', 'val4', ...), ...
+    creates items
+  
+  UPDATE table_name {SET|ADD} attr1 = 'val1', ... WHERE key1 = '...' AND ...
+  UPDATE ALL table_name {SET|ADD} attr1 = 'val1', ... [WHERE attr1 = '...' AND ...] [LIMIT limit]
+    updates items
+  
+  DELETE FROM table_name WHERE key1 = '...' AND ..
+  DELETE ALL FROM table_name WHERE [WHERE attr1 = '...' AND ...] [ORDER {ASC|DESC}] [LIMIT limit]
+    deletes items
+  
+  SELECT {*|attrs|COUNT(*)} FROM table_name [USE INDEX (index_name)] [WHERE key1 = '...' AND ...] [ORDER {ASC|DESC}] [LIMIT limit]
+  SELECT ALL {*|attrs|COUNT(*)}  FROM table_name [WHERE attr1 = '...' AND ...] [LIMIT limit]
+    queries using the Query/Scan action
+    see http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html
+  
+  DESC[RIBE] table_name
+    displays information about the table
+  
+  USE region_or_endpoint
+    changes an endpoint
+  
+  NEXT
+    displays a continuation of a result
+    (NEXT statement is published after SELECT statement)
+  
+  
+  ##### Type #####
+  
+  String
+    'London Bridge is...',  "is broken down..." ...
+  
+  Number
+    10, 100, 0.3 ...
+  
+  Binary
+    x'123456789abcd...', x"123456789abcd..." ...
+  
+  Identifier
+    `ABCD...` or Non-keywords
+  
+  
+  ##### Operator #####
+  
+  Query (SELECT)
+    = | <= | < | >= | > | BEGINS_WITH | BETWEEN
+    see http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html#DDB-Query-request-KeyConditions
+  
+  Scan (SELECT ALL)
+    = | <> | != | <= | < | >= | > | NOT NULL | NULL | CONTAINS | NOT CONTAINS | BEGINS_WITH | IN | BETWEEN
+    see http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html#DDB-Scan-request-ScanFilter
+  
+  
+  ##### Pass to Ruby/Shell #####
+  
+  Ryby
+    query | ruby_script
+  
+    ex) SELECT ALL * FROM employees WHERE gender = 'M' | birth_date.map {|i| Time.parse(i) };
+        [
+          "1957-09-16 00:00:00 +0900",
+          "1954-12-16 00:00:00 +0900",
+          "1964-05-23 00:00:00 +0900",
+          ...
+  
+  Shell
+    query ! shell_command
+  
+    ex) SELECT ALL * FROM employees LIMIT 10 ! sort;
+        {"birth_date"=>"1957-09-16", "emp_no"=>452020,...
+        {"birth_date"=>"1963-07-14", "emp_no"=>16998, ...
+        {"birth_date"=>"1964-04-30", "emp_no"=>225407,...
+        ...
+  
+  
+  ##### Command #####
+  
+  .help                           displays this message
+  .quit | .exit                   exits sdbcli
+  .consistent      (true|false)?  displays ConsistentRead parameter or changes it
+  .debug           (true|false)?  displays a debug status or changes it
+  .retry           NUM?           displays number of times of a retry or changes it
+  .retry_interval  SECOND?        displays a retry interval second or changes it
+  .timeout         SECOND?        displays a timeout second or changes it
+  .version                        displays a version
+  
+  shell> ddbcli # show prompt
+

data/bin/ddbcli

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+Version = '0.1.0'
+
+require 'rubygems'
+require 'ddbcli'
+require 'readline'
+
+options = parse_options
+
+driver = DynamoDB::Driver.new(
+  options.access_key_id,
+  options.secret_access_key,
+  options.ddb_endpoint_or_region)
+
+driver.timeout     = options.timeout
+driver.consistent  = !!options.consistent
+driver.retry_num   = options.retry_num
+driver.retry_intvl = options.retry_intvl
+driver.debug       = options.debug
+
+if not $stdin.tty? or options.command
+  # run mode
+  src = options.command || $stdin.read.strip
+
+  # complements separator
+  unless src =~ /\s*(?:;|\\G)\s*\Z/i
+    src << ';'
+  end
+
+  begin
+    evaluate_query(driver, src)
+  rescue => e
+    print_error(e.message)
+    print_error(e.backtrace) if driver.debug
+    exit 1
+  end
+else
+  # interactive mode
+  src = ''
+  prompt1 = lambda { "#{driver.region || 'unknown'}> " }
+  prompt2 = lambda { "#{' ' * (prompt1.call.length - 3)}-> " }
+
+  while buf = Readline.readline((src.empty? ? prompt1.call : prompt2.call), true)
+    # ignore blank lines
+    if /\A\s*\Z/ =~ buf
+      Readline::HISTORY.pop
+      next
+    end
+
+    if src.empty? and buf =~ /\A\.(.+)/
+      evaluate_command(driver, $1)
+    else
+      begin
+        src << (src.empty? ? buf : ("\n" + buf))
+        evaluate_query(driver, src, :show_rows => true)
+      rescue => e
+        print_error(e.message)
+        print_error(e.backtrace) if driver.debug
+      end
+
+      prompt = src.empty? ? prompt1.call : prompt2.call
+    end
+  end # end of while
+end

data/lib/ddbcli.rb

@@ -0,0 +1,13 @@
+require 'ddbcli/ddb-binary'
+require 'ddbcli/ddb-client'
+require 'ddbcli/ddb-driver'
+require 'ddbcli/ddb-endpoint'
+require 'ddbcli/ddb-error'
+require 'ddbcli/ddb-iteratorable'
+require 'ddbcli/ddb-rubyext'
+
+# CLI
+require 'ddbcli/cli/functions'
+require 'ddbcli/cli/evaluate'
+require 'ddbcli/cli/help'
+require 'ddbcli/cli/options'

data/lib/ddbcli/cli/evaluate.rb

@@ -0,0 +1,51 @@
+def evaluate_query(driver, src, opts = {})
+  ss = StringScanner.new(src.dup)
+  buf = ''
+
+  until ss.eos?
+    if (tok = ss.scan %r{[^`'";\\/#]+}) #'
+      buf << tok
+    elsif (tok = ss.scan /`(?:[^`]|``)*`/)
+      buf << tok
+    elsif (tok = ss.scan /'(?:[^']|'')*'/) #'
+      buf << tok
+    elsif (tok = ss.scan /"(?:[^"]|"")*"/) #"
+      buf << tok
+    elsif (tok = ss.scan %r{/\*/?(?:\n|[^/]|[^*]/)*\*/})
+      # nothing to do
+    elsif (tok = ss.scan /--[^\r\n]*(?:\r\n|\r|\n|\Z)/)
+      # nothing to do
+    elsif (tok = ss.scan /#[^\r\n]*(?:\r\n|\r|\n|\Z)/)
+      # nothing to do
+    elsif (tok = ss.scan /(?:\\;)/)
+      buf << ';' # escape of ';'
+    elsif (tok = ss.scan /(?:;|\\G)/)
+      src.replace(ss.rest)
+      query = buf
+      buf = ''
+
+      if query.strip.empty?
+        print_error('No query specified')
+        next
+      end
+
+      start_time = Time.new
+      out = driver.execute(query)
+      elapsed = Time.now - start_time
+
+      if out.kind_of?(DynamoDB::Driver::Rownum)
+        print_rownum(out, :time => elapsed)
+      elsif out.kind_of?(String)
+        puts out
+      elsif out
+        opts = opts.merge(:inline => (tok != '\G'), :time => elapsed)
+        print_json(out, opts)
+      end
+    elsif (tok = ss.scan /./)
+      buf << tok # 落ち穂拾い
+    end
+  end
+
+  src.replace(buf.strip)
+  buf
+end

data/lib/ddbcli/cli/functions.rb

@@ -0,0 +1,160 @@
+def print_error(errmsg, opts = {})
+  errmsg = errmsg.join("\n") if errmsg.kind_of?(Array)
+  errmsg = errmsg.strip.split("\n").map {|i| "// #{i.strip}" }.join("\n")
+  errmsg += "\n\n" unless opts[:strip]
+  $stderr.puts errmsg
+end
+
+def print_rownum(data, opts = {})
+  rownum = data.to_i
+  msg = "// #{rownum} #{rownum > 1 ? 'rows' : 'row'} changed"
+  msg << " (%.2f sec)" % opts[:time] if opts[:time]
+  puts msg
+end
+
+def print_version
+  puts "#{File.basename($0)} #{Version}"
+end
+
+def print_json(data, opts = {})
+  str = nil
+  last_evaluated_key = nil
+
+  if data.kind_of?(DynamoDB::Iteratorable)
+    last_evaluated_key = data.last_evaluated_key
+    data = data.data
+  end
+
+  if data.kind_of?(Array) and opts[:inline]
+    str = "[\n"
+
+    data.each_with_index do |item, i|
+      str << "  #{item.to_json}"
+      str << ',' if i < (data.length - 1)
+      str << "\n"
+    end
+
+    str << "]"
+  else
+    if data.kind_of?(Array) or data.kind_of?(Hash)
+      str = JSON.pretty_generate(data)
+    else
+      str = data.to_json
+    end
+  end
+
+  str.sub!(/(?:\r\n|\r|\n)*\Z/, "\n")
+
+  if opts[:show_rows] and data.kind_of?(Array)
+    str << "// #{data.length} #{data.length > 1 ? 'rows' : 'row'} in set"
+    str << " (%.2f sec)" % opts[:time] if opts[:time]
+    str << "\n"
+  end
+
+  if last_evaluated_key
+    str << "// has more\n"
+  end
+
+  str << "\n"
+  puts str
+end
+
+def evaluate_command(driver, cmd_arg)
+  cmd, arg = cmd_arg.split(/\s+/, 2).map {|i| i.strip }
+  arg = nil if (arg || '').strip.empty?
+
+  r = /\A#{Regexp.compile(cmd)}/i
+
+  commands = {
+    'help' => lambda {
+      print_help
+    },
+
+    ['exit', 'quit'] => lambda {
+      exit 0
+    },
+
+    'timeout' => lambda {
+      case arg
+      when nil
+        puts driver.timeout
+      when /\d+/
+        driver.timeout = arg.to_i
+      else
+        print_error('Invalid argument')
+      end
+    },
+
+    'consistent' => lambda {
+      if arg
+        r_arg = /\A#{Regexp.compile(arg)}/i
+
+        if r_arg =~ 'true'
+          driver.consistent = true
+        elsif r_arg =~ 'false'
+          driver.consistent = false
+        else
+          print_error('Invalid argument')
+        end
+      else
+        puts driver.consistent
+      end
+    },
+
+    'retry' => lambda {
+      case arg
+      when nil
+        puts driver.retry_num
+      when /\d+/
+        driver.retry_num = arg.to_i
+      else
+        print_error('Invalid argument')
+      end
+    },
+
+    'retry_interval' => lambda {
+      case arg
+      when nil
+        puts driver.retry_intvl
+      when /\d+/
+        driver.retry_intvl = arg.to_i
+      else
+        print_error('Invalid argument')
+      end
+    },
+
+    'debug' => lambda {
+      if arg
+        r_arg = /\A#{Regexp.compile(arg)}/i
+
+        if r_arg =~ 'true'
+          driver.debug = true
+        elsif r_arg =~ 'false'
+          driver.debug = false
+        else
+          print_error('Invalid argument')
+        end
+      else
+        puts driver.debug
+      end
+    },
+
+    'version' => lambda {
+      print_version
+    }
+  }
+
+  cmd_name, cmd_proc = commands.find do |name, proc|
+    if name.kind_of?(Array)
+      name.any? {|i| r =~ i }
+    else
+      r =~ name
+    end
+  end
+
+  if cmd_proc
+    cmd_proc.call
+  else
+    print_error('Unknown command')
+  end
+end

data/lib/ddbcli/cli/help.rb

@@ -0,0 +1,116 @@
+def print_help
+  puts <<'EOS'
+##### Query #####
+
+SHOW TABLES
+  displays a table list
+
+SHOW REGIONS
+  displays a region list
+
+SHOW CREATE TABLE table_name
+  displays a CREATE TABLE statement
+
+CREATE TABLES table_name (
+     key_name {STRING|NUMBER|BINARY} HASH
+  [, key_name {STRING|NUMBER|BINARY} RANGE]
+  [, INDEX index1_name (attr1 {STRING|NUMBER|BINARY}) {ALL|KEYS_ONLY|INCLUDE (attr, ...)}
+   , INDEX index2_name (attr2 {STRING|NUMBER|BINARY}) {ALL|KEYS_ONLY|INCLUDE (attr, ...)}
+   , ...]
+)
+  creates a table
+
+DROP TABLE table_name
+  deletes a table
+
+GET {*|attrs} FROM table_name WHERE key1 = '...' AND ...
+  gets items
+
+INSERT INTO table_name (attr1, attr2, ...) VALUES ('val1', 'val2', ...), ('val3', 'val4', ...), ...
+  creates items
+
+UPDATE table_name {SET|ADD} attr1 = 'val1', ... WHERE key1 = '...' AND ...
+UPDATE ALL table_name {SET|ADD} attr1 = 'val1', ... [WHERE attr1 = '...' AND ...] [LIMIT limit]
+  updates items
+
+DELETE FROM table_name WHERE key1 = '...' AND ..
+DELETE ALL FROM table_name WHERE [WHERE attr1 = '...' AND ...] [ORDER {ASC|DESC}] [LIMIT limit]
+  deletes items
+
+SELECT {*|attrs|COUNT(*)} FROM table_name [USE INDEX (index_name)] [WHERE key1 = '...' AND ...] [ORDER {ASC|DESC}] [LIMIT limit]
+SELECT ALL {*|attrs|COUNT(*)}  FROM table_name [WHERE attr1 = '...' AND ...] [LIMIT limit]
+  queries using the Query/Scan action
+  see http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html
+
+DESC[RIBE] table_name
+  displays information about the table
+
+USE region_or_endpoint
+  changes an endpoint
+
+NEXT
+  displays a continuation of a result
+  (NEXT statement is published after SELECT statement)
+
+
+##### Type #####
+
+String
+  'London Bridge is...',  "is broken down..." ...
+
+Number
+  10, 100, 0.3 ...
+
+Binary
+  x'123456789abcd...', x"123456789abcd..." ...
+
+Identifier
+  `ABCD...` or Non-keywords
+
+
+##### Operator #####
+
+Query (SELECT)
+  = | <= | < | >= | > | BEGINS_WITH | BETWEEN
+  see http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html#DDB-Query-request-KeyConditions
+
+Scan (SELECT ALL)
+  = | <> | != | <= | < | >= | > | NOT NULL | NULL | CONTAINS | NOT CONTAINS | BEGINS_WITH | IN | BETWEEN
+  see http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html#DDB-Scan-request-ScanFilter
+
+
+##### Pass to Ruby/Shell #####
+
+Ryby
+  query | ruby_script
+
+  ex) SELECT ALL * FROM employees WHERE gender = 'M' | birth_date.map {|i| Time.parse(i) };
+      [
+        "1957-09-16 00:00:00 +0900",
+        "1954-12-16 00:00:00 +0900",
+        "1964-05-23 00:00:00 +0900",
+        ...
+
+Shell
+  query ! shell_command
+
+  ex) SELECT ALL * FROM employees LIMIT 10 ! sort;
+      {"birth_date"=>"1957-09-16", "emp_no"=>452020,...
+      {"birth_date"=>"1963-07-14", "emp_no"=>16998, ...
+      {"birth_date"=>"1964-04-30", "emp_no"=>225407,...
+      ...
+
+
+##### Command #####
+
+.help                           displays this message
+.quit | .exit                   exits sdbcli
+.consistent      (true|false)?  displays ConsistentRead parameter or changes it
+.debug           (true|false)?  displays a debug status or changes it
+.retry           NUM?           displays number of times of a retry or changes it
+.retry_interval  SECOND?        displays a retry interval second or changes it
+.timeout         SECOND?        displays a timeout second or changes it
+.version                        displays a version
+
+EOS
+end