KiokuDB::Backend::Role::Query - Backend specific query API

KiokuDB documentation Contained in the KiokuDB distribution.

Index

Code Index:

NAME

Top

KiokuDB::Backend::Role::Query - Backend specific query API

SYNOPSIS

Top

    with qw(KiokuDB::Backend::Role::Query);

    sub search {
        my ( $self, @args ) = @_;

        # return all entries in the root set matching @args (backend specific)
        return Data::Stream::Bulk::Foo->new(...);
    }

DESCRIPTION

Top

This role is for backend specific searching. Anything that is not KiokuDB::Backend::Role::Query::Simple is a backend specific search, be it a Search::GIN::Query, or something else.

The backend is expected to interpret the search arguments which are passed through from search in KiokuDB as is, and return a Data::Stream::Bulk of matching entries.

KiokuDB documentation Contained in the KiokuDB distribution. 
#!/usr/bin/perl

package KiokuDB::Backend::Role::Query;
use Moose::Role;

use namespace::clean -except => 'meta';

requires "search";

sub search_filter {
    my ( $self, $stream, @args ) = @_;
    return $stream;
}

__PACKAGE__

__END__