fluent-plugin-droonga 0.0.2

data/lib/droonga/worker.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013 droonga project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require "droonga/executor"
+
+module Droonga
+  module Worker
+    attr_reader :context, :envelope, :name
+
+    def initialize
+      @executor = Executor.new(config.merge(:proxy => false))
+    end
+
+    def run
+      $log.trace("#{log_tag}: run: start")
+      @running = true
+      while @running
+        $log.trace("#{log_tag}: run: pull_message: start")
+        @executor.execute_one
+        $log.trace("#{log_tag}: run: pull_message: done")
+      end
+      @executor.shutdown
+      $log.trace("#{log_tag}: run: done")
+    end
+
+    def stop
+      $log.trace("#{log_tag}: stop: start")
+      @running = false
+      $log.trace("#{log_tag}: stop: done")
+    end
+
+    private
+    def log_tag
+      "[#{Process.ppid}][#{Process.pid}] worker"
+    end
+  end
+end

data/lib/fluent/plugin/out_droonga.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013 droonga project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require "droonga/engine"
+
+module Fluent
+  class DroongaOutput < Output
+    Plugin.register_output("droonga", self)
+
+    config_param :name, :string, :default => ""
+    config_param :proxy, :bool, :default => false
+    config_param :n_workers, :integer, :default => 0
+    config_param :database, :string, :default => ""
+    config_param :queue_name, :string, :default => "DroongaQueue"
+    config_param :handlers, :default => [] do |value|
+      value.split(/\s*,\s*/)
+    end
+
+    def start
+      super
+      @engine = Droonga::Engine.new(:database => @database,
+                                    :queue_name => @queue_name,
+                                    :n_workers => @n_workers,
+                                    :handlers => @handlers,
+                                    :name => @name,
+                                    :proxy => @proxy)
+      @engine.start
+    end
+
+    def shutdown
+      @engine.shutdown
+      super
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        @engine.emit(tag, time, record)
+      end
+      chain.next
+    end
+  end
+end

data/lib/groonga_command_converter.rb

@@ -0,0 +1,137 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013 droonga project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require "groonga/command/parser"
+require "digest/sha1"
+require "time"
+
+module Droonga
+  class GroongaCommandConverter
+    STATUS_OK = 200.freeze
+
+    def initialize(options={})
+      @options = options
+      @count = 0
+
+      @command_parser = Groonga::Command::Parser.new
+    end
+
+    def convert(input, &block)
+      @command_parser.on_command do |command|
+        case command.name
+        when "table_create"
+          yield create_table_create_command(command)
+        when "column_create"
+          yield create_column_create_command(command)
+        when "select"
+          yield create_select_command(command)
+        end
+      end
+
+      parsed_values = nil
+      parsed_columns = nil
+      @command_parser.on_load_start do |command|
+        parsed_values = []
+        parsed_columns = nil
+      end
+      @command_parser.on_load_columns do |command, columns|
+        parsed_columns = columns
+      end
+      @command_parser.on_load_value do |command, value|
+        parsed_values << value
+      end
+      @command_parser.on_load_complete do |command|
+        command[:columns] = parsed_columns.join(",")
+        command[:values] = parsed_values.to_json
+        split_load_command_to_add_commands(command, &block)
+      end
+
+      input.each_line do |line|
+        @command_parser << line
+      end
+      @command_parser.finish
+    end
+
+    private
+    def create_envelope(type, body)
+      id = @options[:id]
+      if id.nil?
+        id = new_unique_id
+      else
+        id = "#{id}:#{@count}"
+        @count += 1
+      end
+
+      {
+        :id => id,
+        :date => format_date(@options[:date] || Time.now),
+        :replyTo => @options[:reply_to],
+        :statusCode => @options[:status_code] || STATUS_OK,
+        :dataset => @options[:dataset],
+        :type => type,
+        :body => body,
+      }
+    end
+
+    def new_unique_id
+      now = Time.now
+      now_msec = now.to_i * 1000 + now.usec
+      random_string = rand(36 ** 16).to_s(36) # Base36
+      Digest::SHA1.hexdigest("#{now_msec}:#{random_string}")
+    end
+
+    def format_date(time)
+      time.iso8601
+    end
+
+    def create_table_create_command(command)
+      create_envelope("table_create", command.arguments)
+    end
+
+    def create_column_create_command(command)
+      create_envelope("column_create", command.arguments)
+    end
+
+    def split_load_command_to_add_commands(command, &block)
+      columns = command[:columns].split(",")
+      values = command[:values]
+      values = JSON.parse(values)
+      values.each do |record|
+        body = {
+          :table => command[:table],
+        }
+
+        record_values = {}
+        record.each_with_index do |value, column_index|
+          column = columns[column_index]
+          if column == "_key"
+            body[:key] = value
+          else
+            record_values[column.to_sym] = value
+          end
+        end
+        body[:values] = record_values unless record_values.empty?
+
+        yield create_envelope("add", body)
+      end
+    end
+
+    def create_select_command(command)
+      create_envelope("select", command.arguments)
+    end
+  end
+end

data/sample/cluster/catalog.json

@@ -0,0 +1,43 @@
+{
+  "effective_date": "2013-09-01T00:00:00Z",
+  "zones": ["localhost:23003/droonga"],
+  "farms": {
+    "localhost:23003/droonga": {
+      "device": ".",
+      "capacity": 10
+    }
+  },
+  "datasets": {
+    "Droonga": {
+      "workers": 2,
+      "plugins": ["search", "groonga", "add"],
+      "number_of_replicas": 2,
+      "number_of_partitions": 2,
+      "partition_key": "_key",
+      "date_range": "infinity",
+      "ring": {
+        "localhost:23041": {
+          "weight": 50,
+          "partitions": {
+            "2013-09-01": [
+              "localhost:23003/droonga.000",
+              "localhost:23003/droonga.001"
+            ]
+          }
+        },
+        "localhost:23042": {
+          "weight": 50,
+          "partitions": {
+            "2013-09-01": [
+              "localhost:23003/droonga.002",
+              "localhost:23003/droonga.003"
+            ]
+          }
+        }
+      }
+    }
+  },
+  "options": {
+    "plugins": ["select"]
+  }
+}

data/sample/cluster/fluentd.conf

@@ -0,0 +1,12 @@
+<source>
+  type forward
+  port 23003
+</source>
+<match droonga.message>
+  name localhost:23003/droonga
+  type droonga
+  proxy true
+</match>
+<match output.message>
+  type stdout
+</match>

data/sample/fluentd.conf

@@ -0,0 +1,8 @@
+<source>
+  type forward
+</source>
+
+<match droonga.message>
+  type droonga
+  handlers search,groonga
+</match>

data/test/fixtures/catalog.json

@@ -0,0 +1,43 @@
+{
+  "effective_date": "2013-09-01T00:00:00Z",
+  "zones": ["localhost:23003/test"],
+  "farms": {
+    "localhost:23003/test": {
+      "device": ".",
+      "capacity": 10
+    }
+  },
+  "datasets": {
+    "Test": {
+      "workers": 0,
+      "plugins": ["for_dataset"],
+      "number_of_replicas": 2,
+      "number_of_partitions": 2,
+      "partition_key": "_key",
+      "date_range": "infinity",
+      "ring": {
+        "localhost:23041": {
+          "weight": 50,
+          "partitions": {
+            "2013-09-01": [
+              "localhost:23003/test.000",
+              "localhost:23003/test.001"
+            ]
+          }
+        },
+        "localhost:23042": {
+          "weight": 50,
+          "partitions": {
+            "2013-09-01": [
+              "localhost:23003/test.002",
+              "localhost:23003/test.003"
+            ]
+          }
+        }
+      }
+    }
+  },
+  "options": {
+    "plugins": ["for_global"]
+  }
+}

data/test/fixtures/document.grn

@@ -0,0 +1,23 @@
+table_create Bigram TABLE_PAT_KEY ShortText \
+  --default_tokenizer TokenBigram \
+  --normalizer NormalizerAuto
+
+
+table_create Sections TABLE_HASH_KEY ShortText
+column_create Sections title COLUMN_SCALAR ShortText
+column_create Sections content COLUMN_SCALAR Text
+column_create Bigram Sections_title COLUMN_INDEX|WITH_POSITION Sections title
+column_create Bigram Sections_content COLUMN_INDEX|WITH_POSITION Sections content
+
+load --table Sections
+[
+{"_key": "1.1", "title": "Groonga overview", "content": "Groonga is a fast and accurate full text search engine based on inverted index. One of the characteristics of groonga is that a newly registered document instantly appears in search results. Also, groonga allows updates without read locks. These characteristics result in superior performance on real-time applications."},
+{"_key": "1.2", "title": "Full text search and Instant update", "content": "In widely used DBMSs, updates are immediately processed, for example, a newly registered record appears in the result of the next query. In contrast, some full text search engines do not support instant updates, because it is difficult to dynamically update inverted indexes, the underlying data structure."},
+{"_key": "1.3", "title": "Column store and aggregate query", "content": "People can collect more than enough data in the Internet era. However, it is difficult to extract informative knowledge from a large database, and such a task requires a many-sided analysis through trial and error. For example, search refinement by date, time and location may reveal hidden patterns. Aggregate queries are useful to perform this kind of tasks."},
+{"_key": "1.4", "title": "Inverted index and tokenizer", "content": "An inverted index is a traditional data structure used for large-scale full text search. A search engine based on inverted index extracts index terms from a document when it is added. Then in retrieval, a query is divided into index terms to find documents containing those index terms. In this way, index terms play an important role in full text search and thus the way of extracting index terms is a key to a better search engine."},
+{"_key": "1.5", "title": "Sharable storage and read lock-free", "content": "Multi-core processors are mainstream today and the number of cores per processor is increasing. In order to exploit multiple cores, executing multiple queries in parallel or dividing a query into sub-queries for parallel processing is becoming more important."},
+{"_key": "1.6", "title": "Geo-location (latitude and longitude) search", "content": "Location services are getting more convenient because of mobile devices with GPS. For example, if you are going to have lunch or dinner at a nearby restaurant, a local search service for restaurants may be very useful, and for such services, fast geo-location search is becoming more important."},
+{"_key": "1.7", "title": "Groonga library", "content": "The basic functions of groonga are provided in a C library and any application can use groonga as a full text search engine or a column-oriented database. Also, libraries for languages other than C/C++, such as Ruby, are provided in related projects. See related projects for details."},
+{"_key": "1.8", "title": "Groonga server", "content": "Groonga provides a built-in server command which supports HTTP, the memcached binary protocol and the groonga query transfer protocol (gqtp). Also, a groonga server supports query caching, which significantly reduces response time for repeated read queries. Using this command, groonga is available even on a server that does not allow you to install new libraries."},
+{"_key": "1.9", "title": "Groonga storage engine", "content": "Groonga works not only as an independent column-oriented DBMS but also as storage engines of well-known DBMSs. For example, mroonga is a MySQL pluggable storage engine using groonga. By using mroonga, you can use groonga for column-oriented storage and full text search. A combination of a built-in storage engine, MyISAM or InnoDB, and a groonga-based full text search engine is also available. All the combinations have good and bad points and the best one depends on the application. See related projects for details."}
+]

data/test/helper.rb

@@ -0,0 +1,24 @@
+# Copyright (C) 2013 droonga project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require_relative "helper/sandbox"
+require_relative "helper/fixture"
+require_relative "helper/stub_worker"
+require_relative "helper/watch_helper"
+
+class Test::Unit::TestCase
+  include Sandbox
+  include Fixture
+end

data/test/helper/fixture.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2013 droonga project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Fixture
+  def fixture_directory
+    File.join(File.dirname(__FILE__), "..", "fixtures")
+  end
+
+  def fixture_path(*path_components)
+    File.join(fixture_directory, *path_components)
+  end
+
+  def fixture_data(*path_components)
+    File.read(fixture_path(*path_components))
+  end
+end

data/test/helper/sandbox.rb

@@ -0,0 +1,73 @@
+# Copyright (C) 2013 droonga project
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Sandbox
+  class << self
+    def included(base)
+      base.setup :setup_sandbox, :before => :prepend
+      base.teardown :teardown_sandbox, :after => :append
+    end
+  end
+
+  def setup_sandbox
+    setup_temporary_directory
+
+    setup_context
+
+    @database_path = @temporary_directory + "database"
+    @database = nil
+  end
+
+  def setup_temporary_directory
+    @base_temporary_directory = Pathname(File.dirname(__FILE__)) + "tmp"
+    memory_file_system = "/run/shm"
+    if File.exist?(memory_file_system)
+      FileUtils.mkdir_p(@base_temporary_directory.parent.to_s)
+      FileUtils.rm_f(@base_temporary_directory.to_s)
+      FileUtils.ln_s(memory_file_system, @base_temporary_directory.to_s)
+    else
+      FileUtils.mkdir_p(@base_temporary_directory.to_s)
+    end
+
+    @temporary_directory = @base_temporary_directory + "fluent-plugin-droonga"
+    FileUtils.rm_rf(@temporary_directory.to_s)
+    FileUtils.mkdir_p(@temporary_directory.to_s)
+  end
+
+  def setup_context
+    Groonga::Context.default = nil
+    Groonga::Context.default_options = nil
+  end
+
+  def restore(dumped_command)
+    context = Groonga::Context.new
+    database = context.create_database(@database_path.to_s)
+    context.restore(dumped_command)
+    database.close
+    context.close
+  end
+
+  def teardown_sandbox
+    Groonga::Context.default.close
+    Groonga::Context.default = nil
+    GC.start
+    teardown_temporary_directory
+  end
+
+  def teardown_temporary_directory
+    FileUtils.rm_rf(@temporary_directory.to_s)
+    FileUtils.rm_rf(@base_temporary_directory.to_s)
+  end
+end