Git Product home page Git Product logo

data-searchengine-elasticsearch's Introduction

NAME

Data::SearchEngine::ElasticSearch - ElasticSearch support for Data::SearchEngine

VERSION

version 0.07

SYNOPSIS

use Data::SearchEngine::Query;
use Data::SearchEngine::ElasticSearch;

my $dse = Data::SearchEngine::ElasticSearch->new(
    servers => [ '127.0.0.1:9200' ]
);

my $query = Data::SearchEngine::Query->new(
    index => 'tweets',
    page => 1,
    count => 10,
    order => { _score => { order => 'asc' } },
    type => 'query_string',
    facets => {
        etype => { terms => { field => 'etype' } },
        author_organization_literal => { terms => { field => 'author_organization_literal' } },
        author_literal => { terms => { field => 'author_literal' } },
        source_literal => { terms => { field => 'source_literal' } },
    }
);

my $results = $dse->search($query);

DESCRIPTION

Data::SearchEngine::ElasticSearch is a backend for Data::SearchEngine. It aims to generalize the features of ElasticSearch so that application authors are insulated from some of the differences betwene search modules.

IMPLEMENTATION NOTES

Incomplete

ElasticSearch's query DSL is large and complex. It is not well suited to abstraction by a library like this one. As such you will almost likely find this abstraction lacking. Expect it to improve as the author uses more of ElasticSearch's features in applications.

Explanations

Setting debug to a true value will cause to be set when the query is sent to ElasticSearch. You can find the explanation by examining the raw attribute of the Data::SearchEngine::Results object.

Queries

It is expected that if your Data::SearchEngine::Query object has any query set then it must also have a type.

The query is then passed on to ElasticSearch thusly:

$es->search(
    # ...
    query => { $query->type => $query->query }
    # ...
);

So if you want to do a query_string query, you would set up your query like this:

my $query = Data::SearchEngine::Query->new(
    # ...
    type => 'query_string',
    query => { query => 'some query text' }
    # ...
);

See the documents for ElasticSearch's DLS for more details.

Indexing

ElasticSearch wants an index and type for each Item that is indexed. It is expected that you will populate these values in the item thusly:

my $item = Data::SearchEngine::Item->new( id => $something, values => { index => 'twitter', type => 'tweet', # and whatever else } ); $dse->add($item);

ATTRIBUTES

servers

The servers to which we'll be connecting.

transport

The transport to use. Refer to ElasticSearch for more information.

METHODS

add ([ $items ])

Add items to the index. Keep in mind that the Data::SearchEngine::Item should have values set for index and type.

present ($item)

Returns true if the Data::SearchEngine::Item is present. Uses the item's id.

remove_by_id ($item)

Remove the specified item from the index. Uses the item's id.

search ($query)

Search!

AUTHOR

Cory G Watson [email protected]

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Cold Hard Code, LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

data-searchengine-elasticsearch's People

Contributors

gphat avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.