groonga-schema 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4263ea2b622faf07dde90bbf256235c636287fc9
+  data.tar.gz: 103bdca013e9f45a0aaeeb440054eed76df0b900
+SHA512:
+  metadata.gz: 53d4be054208120b9f7e8afbac2c5e605bb2929878718cfc6a5f7b6681d794236238d9365a508a1b8ecb9af0fe7cfc5cf2de315bed75748ec505bb5326185933
+  data.tar.gz: 6e70cdcdab3aee8125cbde03d2e95f0487fcca9464bfabd5aae356240d4f837d99d43b96e5710e284b869a5d420f320ed890c5a2fcaaad229dc505f8608469a6

data/.yardopts

@@ -0,0 +1,9 @@
+--protected
+--no-private
+--output doc/reference/en
+--title "groonga-schema API Reference"
+--markup markdown
+--markup-provider kramdown
+--po-dir doc/po
+-
+doc/text/*

data/Gemfile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+source "https://rubygems.org/"
+
+gemspec

data/README.md

@@ -0,0 +1,164 @@
+# README
+
+[![Gem Version](https://badge.fury.io/rb/groonga-schema.svg)](http://badge.fury.io/rb/groonga-schema)
+[![Build Status](https://travis-ci.org/groonga/groonga-schema.svg?branch=master)](https://travis-ci.org/groonga/groonga-schema)
+
+## Name
+
+groonga-schema
+
+## Description
+
+Groonga-schema is a Ruby library and tool to processes [Groonga](http://groonga.org/)'s schema.
+
+## Install
+
+    % gem install groonga-schema
+
+## Usage
+
+### As a tool
+
+Here are command lines provided by groonga-schema:
+
+  * `groonga-schema-diff`: It reports difference between 2 schema.
+
+#### `groonga-schema-diff`
+
+`groonga-schema-diff` reports difference between 2 schema:
+
+```text
+% groonga-schema-diff FROM_SCHEMA TO_SCHEMA
+```
+
+The output of `groonga-schema-diff` is a Groonga command list. It
+means that you can apply difference by processing the output of
+`groonga-schema-diff` by Groonga. The relation of them are similar to
+`diff` and `patch`.
+
+The following example shows about it.
+
+Here are sample schema:
+
+`current.grn`:
+
+```text
+table_create Logs TABLE_NO_KEY
+column_create Logs timestamp COLUMN_SCALAR ShortText
+```
+
+`new.grn`:
+
+```text
+table_create Logs TABLE_NO_KEY
+column_create Logs timestamp COLUMN_SCALAR Time
+```
+
+In the `current.grn` schema, `Logs.timestamp` column's value type is
+`ShortText`. In the `new.grn` schema, it's `Time`.
+
+Here is the output of `groonga-schema-diff`:
+
+```text
+% groonga-schema-diff current.grn new.grn
+column_create --flags "COLUMN_SCALAR" --name "timestamp_new" --table "Logs" --type "Time"
+column_copy --from_name "timestamp" --from_table "Logs" --to_name "timestamp_new" --to_table "Logs"
+column_rename --name "timestamp" --new_name "timestamp_old" --table "Logs"
+column_rename --name "timestamp_new" --new_name "timestamp" --table "Logs"
+
+column_remove --name "timestamp_old" --table "Logs"
+```
+
+The output Groonga command list does the followings:
+
+  1. Create a new column `Logs.timestamp_new`. The value type of the new column is `Time` not `ShortText`.
+
+  2. Copy data to `Logs.timestamp_new` from `Logs.timestamp`.
+
+  3. Rename `Logs.timestamp` to `Logs.timestamp_old`.
+
+  4. Rename `Logs.timestamp_new` to `Logs.timestamp`.
+
+  5. Remove `Logs.timestamp_old`.
+
+It means that the output Groonga command list supports data migration.
+
+Here is a sample database to show data migration:
+
+```text
+% groonga DB_PATH dump
+table_create Logs TABLE_NO_KEY
+column_create Logs timestamp COLUMN_SCALAR ShortText
+
+load --table Logs
+[
+["_id","timestamp"],
+[1,"2016-08-16 00:00:01"],
+[2,"2016-08-16 00:00:02"],
+[3,"2016-08-16 00:00:03"],
+[4,"2016-08-16 00:00:04"],
+[5,"2016-08-16 00:00:05"]
+]
+```
+
+You can apply the change by the following command lines:
+
+```text
+% groonga-schema-diff current.grn new.grn > diff.grn
+% groonga --file diff.grn DB_PATH
+```
+
+Or:
+
+```text
+% groonga-schema-diff current.grn new.grn | groonga DB_PATH
+```
+
+Here is the sample database after applying the changes:
+
+```text
+% groonga DB_PATH dump
+table_create Logs TABLE_NO_KEY
+column_create Logs timestamp COLUMN_SCALAR Time
+
+load --table Logs
+[
+["_id","timestamp"],
+[1,1471273201.0],
+[2,1471273202.0],
+[3,1471273203.0],
+[4,1471273204.0],
+[5,1471273205.0]
+]
+```
+
+`Logs.timestamp` column's value type is changed to `Time` from
+`ShortText` and data are also converted.
+
+### As a library
+
+TODO...
+
+## Dependencies
+
+* Ruby
+
+## Mailing list
+
+* English: [groonga-talk@lists.sourceforge.net](https://lists.sourceforge.net/lists/listinfo/groonga-talk)
+* Japanese: [groonga-dev@lists.sourceforge.jp](http://lists.sourceforge.jp/mailman/listinfo/groonga-dev)
+
+## Chat
+
+* English: [Gitter:groonga/en](https://gitter.im/groonga/en)
+* Japanese: [Gitter:groonga/ja](https://gitter.im/groonga/ja)
+
+## Authors
+
+* Kouhei Sutou \<kou@clear-code.com\>
+
+## License
+
+LGPLv2.1 or later. See doc/text/lgpl-2.1.txt for details.
+
+(Kouhei Sutou has a right to change the license including contributed patches.)

data/Rakefile

@@ -0,0 +1,45 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+task :default => :test
+
+require "rubygems"
+require "bundler/gem_helper"
+require "packnga"
+
+base_dir = File.join(File.dirname(__FILE__))
+
+helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
+end
+
+helper.install
+spec = helper.gemspec
+
+Packnga::DocumentTask.new(spec) do |task|
+  task.translate_languages = ["ja"]
+end
+
+Packnga::ReleaseTask.new(spec) do
+end
+
+desc "Run tests"
+task :test do
+  ruby("test/run-test.rb")
+end

data/bin/groonga-schema-diff

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga-schema"
+
+exit(GroongaSchema::CommandLine::GroongaSchemaDiff.run(ARGV))