Contents

require 'elasticsearch'
require 'uri'

require 'rom/gateway'
require 'rom/support/inflector'
require 'rom/elasticsearch/dataset'

module ROM
  module Elasticsearch
    # Elasticsearch gateway
    #
    # @example basic configuration
    #   conf = ROM::Configuration.new(:elasticsearch, 'http://localhost:9200')
    #
    #   class Posts < ROM::Relation[:elasticsearch]
    #     schema(:posts) do
    #       attribute :id, Types::Int
    #       attribute :title, Types::String
    #
    #       primary_key :id
    #     end
    #
    #     def like(title)
    #       query(prefix: { title: title })
    #     end
    #   end
    #
    #   conf.register_relation(Posts)
    #
    #   rom = ROM.container(conf)
    #
    #   posts = rom.relations[:posts]
    #
    #   posts.command(:create).call(id: 1, title: 'Hello World')
    #
    #   posts.like('Hello').first
    #
    # @api public
    class Gateway < ROM::Gateway
      adapter :elasticsearch

      # @!attribute [r] url
      #   @return [URI] Connection URL
      attr_reader :url

      # @!attribute [r] client
      #   @return [::Elasticsearch::Client] configured ES client
      attr_reader :client

      # @api private
      def initialize(uri, log: false)
        @url = URI.parse(uri)
        @client = ::Elasticsearch::Client.new(url: url, log: log)
      end

      # Return true if a dataset with the given :index exists
      #
      # @param [Symbol] index The name of the index
      #
      # @return [Boolean]
      #
      # @api public
      def dataset?(index)
        client.indices.exists?(index: index)
      end
      alias_method :index?, :dataset?

      # Get a dataset by its :index name
      #
      # @param [Symbol] index The name of the index
      #
      # @return [Dataset]
      #
      # @api public
      def dataset(index)
        Dataset.new(client, params: { index: index, type: Inflector.singularize(index).to_sym })
      end
      alias_method :[], :dataset
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
rom-elasticsearch-0.2.1	lib/rom/elasticsearch/gateway.rb
rom-elasticsearch-0.2.0	lib/rom/elasticsearch/gateway.rb
rom-elasticsearch-0.1.1	lib/rom/elasticsearch/gateway.rb