---
name: "KiokuDB::Backend::Role::Query"
section: "3pm"
platform: "linux"
package: "libkiokudb-perl"
version: "0.57-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/KiokuDB::Backend::Role::Query"
---

# KiokuDB::Backend::Role::Query(3pm)

Backend specific query API

## NAME

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

## VERSION

version 0.57

## SYNOPSIS

```
    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

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.

## AUTHOR

Yuval Kogman \<nothingmuch@woobling.org\>

## COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Yuval Kogman, Infinity Interactive.

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