File Coverage

blib/lib/KiokuDB/Backend/Role/Clear.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

#!/usr/bin/perl

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

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

requires "clear";

__PACKAGE__

__END__

=pod

=head1 NAME

KiokuDB::Backend::Role::Clear - Backend clearing api

=head1 SYNOPSIS

    package KiokuDB::Backend::MySpecialBackend;
    use Moose;

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

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

    sub clear {
        ...
    }

=head1 DESCRIPTION

This backend role provides an api for removing all entries from a backend.

This is optionally used by the dump loader script, and parts of the test suite.

=head1 REQUIRED METHODS

=over 4

=item clear

This method should clear all entries in the backend.

=back