pg_fts 0.0.0 → 0.2.0

data/lib/pg/fts/index/one_to_many.rb

@@ -0,0 +1,314 @@
+# one document, many sources
+class PG::FTS::Index::OneToMany
+  attr_reader :table, :fields, :catalog, :document, :key, :foreign_key, :name
+  alias source table
+
+  include PG::FTS::Index
+  include PG::FTS::Naming
+  include PG::FTS::TSVector
+
+  # rubocop:disable Metrics/ParameterLists
+  def initialize(table, *fields,
+                 document: nil, key: nil, foreign_key: nil,
+                 catalog: nil,
+                 as: nil)
+    @table = table
+    @fields = fields
+    @catalog = catalog || PG::FTS.catalog
+    @document = document || fail(ArgumentError, ':document required')
+    @key = key || :id
+    @foreign_key = foreign_key || :"#{document}_id"
+    @name = as
+  end
+  # rubocop:enable Metrics/ParameterLists
+
+  def build_query
+    <<-SQL.gsub(/^ {4}/, '')
+    INSERT INTO "#{PG::FTS.table}" (
+      "document_id",
+      "document_table",
+      "source_id",
+      "source_table",
+      "tsv")
+    SELECT "#{document}"."#{key}",
+           '#{document}',
+           "#{source}"."#{key}",
+           '#{source}',
+           #{ts_vector(source)}
+    FROM "#{document}", "#{source}"
+    WHERE "#{document}"."#{key}" = "#{source}"."#{foreign_key}";
+    SQL
+  end
+
+  def on_source_insert_query
+    <<-SQL.gsub(/^ {4}/, '')
+    INSERT INTO "#{PG::FTS.table}" (
+      "document_id",
+      "document_table",
+      "source_id",
+      "source_table",
+      "tsv")
+    SELECT
+      "#{document}"."#{key}",
+      '#{document}',
+      NEW."#{key}",
+      '#{source}',
+      #{ts_vector}
+    FROM "#{document}"
+    WHERE "#{document}"."#{key}" = NEW."#{foreign_key}";
+    SQL
+  end
+
+  def on_source_insert_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_source_insert_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        IF NEW."#{foreign_key}" IS NULL THEN
+          RETURN NEW;
+        END IF;
+        #{on_source_insert_query.gsub(/^/, '    ')}
+        RETURN NEW;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_source_update_query
+    <<-SQL.gsub(/^ {4}/, '')
+    UPDATE "#{PG::FTS.table}"
+    SET
+      "tsv" = (#{ts_vector}),
+      "document_table" = '#{document}',
+      "document_id" = NEW."#{foreign_key}"
+    FROM "#{document}"
+    WHERE "#{document}"."#{key}" = NEW."#{foreign_key}"
+      AND "#{PG::FTS.table}"."source_id" = OLD."#{key}"
+      AND "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_id" = OLD."#{foreign_key}"
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_source_update_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_source_update_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_source_update_query.gsub(/^/, '    ')}
+        IF NOT FOUND THEN
+          #{on_source_insert_query.gsub(/^/, '    ')}
+          IF NOT FOUND THEN
+            #{on_source_delete_query.gsub(/^/, '    ')}
+          END IF;
+          RETURN NEW;
+        END IF;
+        RETURN NEW;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_source_delete_query
+    <<-SQL.gsub(/^ {4}/, '')
+    DELETE FROM "#{PG::FTS.table}"
+    WHERE "#{PG::FTS.table}"."source_id" = OLD."#{key}"
+      AND "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_id" = OLD."#{foreign_key}"
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_source_delete_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_source_delete_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_source_delete_query.gsub(/^/, '    ')}
+        RETURN OLD;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_source_truncate_query
+    <<-SQL.gsub(/^ {4}/, '')
+    DELETE FROM "#{PG::FTS.table}"
+    WHERE "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_source_truncate_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_source_truncate_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_source_truncate_query.gsub(/^/, '    ')}
+        RETURN NULL;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_source_insert_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_source_insert_trigger_name}"
+    AFTER INSERT ON "#{source}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_source_insert_procedure_name}"();
+    SQL
+  end
+
+  def on_source_update_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_source_update_trigger_name}"
+    AFTER UPDATE ON "#{source}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_source_update_procedure_name}"();
+    SQL
+  end
+
+  def on_source_delete_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_source_delete_trigger_name}"
+    AFTER DELETE ON "#{source}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_source_delete_procedure_name}"();
+    SQL
+  end
+
+  def on_source_truncate_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_source_truncate_trigger_name}"
+    AFTER TRUNCATE ON "#{source}"
+    FOR EACH STATEMENT
+    EXECUTE PROCEDURE "#{on_source_truncate_procedure_name}"();
+    SQL
+  end
+
+  def on_document_insert_query
+    <<-SQL.gsub(/^ {4}/, '')
+    INSERT INTO "#{PG::FTS.table}" (
+      "document_id",
+      "document_table",
+      "source_id",
+      "source_table",
+      "tsv")
+    SELECT
+      NEW."#{key}",
+      '#{document}',
+      "#{source}"."#{key}",
+      '#{source}',
+      #{ts_vector(source)}
+    FROM "#{source}"
+    WHERE "#{source}"."#{foreign_key}" = NEW."#{key}";
+    SQL
+  end
+
+  def on_document_insert_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_insert_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_insert_query.gsub(/^/, '    ')}
+        RETURN NEW;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_update_query
+    <<-SQL.gsub(/^ {4}/, '')
+    SQL
+  end
+
+  def on_document_update_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_update_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_update_query.gsub(/^/, '    ')}
+        RETURN NEW;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_delete_query
+    <<-SQL.gsub(/^ {4}/, '')
+    DELETE FROM "#{PG::FTS.table}"
+    WHERE "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_id" = OLD."#{key}"
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_document_delete_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_delete_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_delete_query.gsub(/^/, '    ')}
+        RETURN OLD;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_truncate_query
+    <<-SQL.gsub(/^ {4}/, '')
+    DELETE FROM "#{PG::FTS.table}"
+    WHERE "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_document_truncate_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_truncate_procedure_name}"()
+    RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_truncate_query.gsub(/^/, '    ')}
+        RETURN NULL;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_insert_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_insert_trigger_name}"
+    AFTER INSERT ON "#{document}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_document_insert_procedure_name}"();
+    SQL
+  end
+
+  def on_document_update_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_update_trigger_name}"
+    AFTER UPDATE ON "#{document}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_document_update_procedure_name}"();
+    SQL
+  end
+
+  def on_document_delete_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_delete_trigger_name}"
+    AFTER DELETE ON "#{document}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_document_delete_procedure_name}"();
+    SQL
+  end
+
+  def on_document_truncate_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_truncate_trigger_name}"
+    AFTER TRUNCATE ON "#{document}"
+    FOR EACH STATEMENT
+    EXECUTE PROCEDURE "#{on_document_truncate_procedure_name}"();
+    SQL
+  end
+end

data/lib/pg/fts/index/self.rb

@@ -0,0 +1,160 @@
+class PG::FTS::Index::Self
+  attr_reader :table, :fields, :key, :catalog, :name
+  alias source table
+  alias document table
+  alias foreign_key key
+
+  include PG::FTS::Index
+  include PG::FTS::Naming
+  include PG::FTS::TSVector
+
+  def initialize(table, *fields, key: nil, catalog: nil, as: nil)
+    @table = table
+    @fields = fields
+    @key = key || :id
+    @catalog = catalog || PG::FTS.catalog
+    @name = as
+  end
+
+  def build_query
+    <<-SQL.gsub(/^ {4}/, '')
+    INSERT INTO "#{PG::FTS.table}" (
+      "document_id",
+      "document_table",
+      "source_id",
+      "source_table",
+      "tsv")
+    SELECT "#{document}"."#{key}",
+           '#{document}',
+           "#{source}"."#{key}",
+           '#{source}',
+           #{ts_vector(source)}
+    FROM "#{document}";
+    SQL
+  end
+
+  def on_document_insert_query
+    <<-SQL.gsub(/^ {4}/, '')
+    INSERT INTO "#{PG::FTS.table}" (
+      "document_id",
+      "document_table",
+      "source_id",
+      "source_table",
+      "tsv")
+    VALUES (
+      NEW."#{key}",
+      '#{document}',
+      NEW."#{key}",
+      '#{source}',
+      #{ts_vector});
+    SQL
+  end
+
+  def on_document_insert_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_insert_procedure_name}"() RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_insert_query.gsub(/^/, '    ')}
+        RETURN NEW;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_update_query
+    <<-SQL.gsub(/^ {4}/, '')
+    UPDATE "#{PG::FTS.table}" SET "tsv" = (#{ts_vector})
+    WHERE "#{PG::FTS.table}"."source_id" = NEW."#{key}"
+      AND "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_id" = NEW."#{key}"
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_document_update_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_update_procedure_name}"() RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_update_query.gsub(/^/, '    ')}
+        RETURN NEW;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_delete_query
+    <<-SQL.gsub(/^ {4}/, '')
+    DELETE FROM "#{PG::FTS.table}"
+    WHERE "#{PG::FTS.table}"."source_id" = OLD."#{key}"
+      AND "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_id" = OLD."#{key}"
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_document_delete_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_delete_procedure_name}"() RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_delete_query.gsub(/^/, '    ')}
+        RETURN OLD;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_truncate_query
+    <<-SQL.gsub(/^ {4}/, '')
+    DELETE FROM "#{PG::FTS.table}"
+    WHERE "#{PG::FTS.table}"."source_table" = '#{source}'
+      AND "#{PG::FTS.table}"."document_table" = '#{document}';
+    SQL
+  end
+
+  def on_document_truncate_procedure
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE FUNCTION "#{on_document_truncate_procedure_name}"() RETURNS TRIGGER AS $$
+      BEGIN
+        #{on_document_truncate_query.gsub(/^/, '    ')}
+        RETURN NULL;
+      END;
+    $$ LANGUAGE plpgsql;
+    SQL
+  end
+
+  def on_document_insert_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_insert_trigger_name}"
+    AFTER INSERT ON "#{document}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_document_insert_procedure_name}"();
+    SQL
+  end
+
+  def on_document_update_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_update_trigger_name}"
+    AFTER UPDATE ON "#{document}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_document_update_procedure_name}"();
+    SQL
+  end
+
+  def on_document_delete_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_delete_trigger_name}"
+    AFTER DELETE ON "#{document}"
+    FOR EACH ROW
+    EXECUTE PROCEDURE "#{on_document_delete_procedure_name}"();
+    SQL
+  end
+
+  def on_document_truncate_trigger
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TRIGGER "#{on_document_truncate_trigger_name}"
+    AFTER TRUNCATE ON "#{document}"
+    FOR EACH STATEMENT
+    EXECUTE PROCEDURE "#{on_document_truncate_procedure_name}"();
+    SQL
+  end
+end

data/lib/pg/fts/index.rb

@@ -0,0 +1,151 @@
+module PG::FTS::Index
+  def create
+    [:document, :source, :link].each do |type|
+      [:insert, :update, :delete, :truncate].each do |op|
+        [:procedure, :trigger].each do |item|
+          name = "on_#{type}_#{op}_#{item}"
+          yield(send(name)) if respond_to?(name)
+        end
+      end
+    end
+  end
+
+  def drop_procedure_query(name)
+    <<-SQL.gsub(/^ {4}/, '')
+    DROP FUNCTION IF EXISTS "#{send(name + '_name')}" ();
+    SQL
+  end
+
+  def drop_trigger_query(name, type)
+    t = case type
+        when :document then document
+        when :source then source
+        when :link then link
+        end
+
+    <<-SQL.gsub(/^ {4}/, '')
+    DROP TRIGGER IF EXISTS "#{send(name + '_name')}" ON "#{t}";
+    SQL
+  end
+
+  def drop
+    [:document, :source, :link].each do |type|
+      [:insert, :update, :delete, :truncate].each do |op|
+        name = "on_#{type}_#{op}_trigger"
+        yield(drop_trigger_query(name, type)) if respond_to?(name)
+        name = "on_#{type}_#{op}_procedure"
+        yield(drop_procedure_query(name)) if respond_to?(name)
+      end
+    end
+  end
+
+  def clear
+    yield(on_document_truncate_query)
+  end
+
+  def build
+    yield(build_query)
+  end
+
+  def rebuild(&executor)
+    clear(&executor)
+    build(&executor)
+  end
+
+  class << self
+    def drop_all_procedures
+      procedures = yield <<-SQL.gsub(/^ {6}/, '')
+      SELECT routine_name AS name
+      FROM information_schema.routines
+      WHERE routine_name LIKE '%_tsv'
+        AND routine_type = 'FUNCTION';
+      SQL
+
+      procedures.each do |procedure|
+        yield <<-SQL.gsub(/^ {8}/, '')
+        DROP FUNCTION IF EXISTS "#{procedure['name']}" ();
+        SQL
+      end
+    end
+
+    def drop_all_triggers
+      triggers = yield <<-SQL.gsub(/^ {6}/, '')
+      SELECT tgname AS name, relname AS table
+      FROM pg_trigger
+      INNER JOIN pg_class ON pg_class.oid = tgrelid
+      WHERE tgname like '%_tsv';
+      SQL
+
+      triggers.each do |trigger|
+        yield <<-SQL.gsub(/^ {8}/, '')
+        DROP TRIGGER IF EXISTS "#{trigger['name']}" ON "#{trigger['table']}";
+        SQL
+      end
+    end
+
+    def drop_all(&executor)
+      drop_all_triggers(&executor)
+      drop_all_procedures(&executor)
+    end
+
+    def create(*indices, &executor)
+      indices.each { |index| index.create(&executor) }
+    end
+
+    def drop(*indices, &executor)
+      indices.each { |index| index.drop(&executor) }
+    end
+
+    def clear(*indices, &executor)
+      indices.each { |index| index.clear(&executor) }
+    end
+
+    def build(*indices, &executor)
+      indices.each { |index| index.build(&executor) }
+    end
+
+    def rebuild(*indices, &executor)
+      indices.each { |index| index.rebuild(&executor) }
+    end
+
+    def recreate(*indices, &executor)
+      drop_all(&executor)
+      create(*indices, &executor)
+    end
+
+    def reset(*indices, &executor)
+      recreate(*indices, &executor)
+      PG::FTS.clear(&executor)
+    end
+  end
+
+  module Module
+    def create(&executor)
+      PG::FTS::Index.create(*constants.map { |e| const_get(e) }, &executor)
+    end
+
+    def drop(&executor)
+      PG::FTS::Index.drop(*constants.map { |e| const_get(e) }, &executor)
+    end
+
+    def clear(&executor)
+      PG::FTS::Index.clear(*constants.map { |e| const_get(e) }, &executor)
+    end
+
+    def build(&executor)
+      PG::FTS::Index.build(*constants.map { |e| const_get(e) }, &executor)
+    end
+
+    def rebuild(&executor)
+      PG::FTS::Index.rebuild(*constants.map { |e| const_get(e) }, &executor)
+    end
+  end
+end
+
+require 'pg/fts/naming'
+require 'pg/fts/ts_vector'
+require 'pg/fts/index/self'
+require 'pg/fts/index/many_to_one'
+require 'pg/fts/index/one_to_many'
+require 'pg/fts/index/momo'
+require 'pg/fts/index/ommo'