File Coverage

blib/lib/KiokuDB/Backend/Role/Query/Simple.pm

Criterion	Covered	Total	%
statement	12	12	100.0
branch	2	2	100.0
condition			n/a
subroutine	4	4	100.0
pod	0	2	0.0
total	18	20	90.0

#!/usr/bin/perl

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

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

requires "simple_search";

sub simple_search_filter {
    my ( $self, $stream, $proto ) = @_;
    return $stream;
}

# FIXME unify with Attribute, and put this in the default simple_search_filter
# implementation
# that way *really* lazy backends can just alias simple_search to scan and
# still be feature complete even if they are retardedly slow

sub compare_naive {
    my ( $self, $got, $exp ) = @_;

    foreach my $key ( keys %$exp ) {
        return unless overload::StrVal($got->{$key}) eq overload::StrVal($exp->{$key});
    }

    return 1;
}

__PACKAGE__

__END__

=pod

=head1 NAME

KiokuDB::Backend::Role::Query::Simple - Simple query api

=head1 SYNOPSIS

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

    sub simple_search {
        my ( $self, $proto ) = @_;

        # return all candidate entries in the root set matching fields in $proto
        return Data::Stream::Bulk::Foo->new(...);
    }

=head1 DESCRIPTION

This role requires a C<simple_search> method to be implemented.

The method accepts one argument, the hash of the proto to search for.

This is still loosely defined, but the basic functionality is based on
attribute matching:

    $kiokudb->search({ name => "Mia" });

will search for objects whose C<name> attribute contains the string C<Mia>.

More complex operations will be defined in the future.

=cut