NAME

Doodle::Index

ABSTRACT

Doodle Index Class

SYNOPSIS

use Doodle;
use Doodle::Index;
use Doodle::Table;

my $ddl = Doodle->new;

my $table = Doodle::Table->new(
  name => 'users',
  doodle => $ddl
);

my $self = Doodle::Index->new(
  table => $table,
  columns => ['email', 'access_token']
);

DESCRIPTION

This package provides table index representation.

LIBRARIES

This package uses type constraints from:

Doodle::Library

ATTRIBUTES

This package has the following attributes:

columns

columns(ArrayRef[Str])

This attribute is read-only, accepts (ArrayRef[Str]) values, and is optional.

data

data(Data)

This attribute is read-only, accepts (Data) values, and is optional.

name

name(Str)

This attribute is read-only, accepts (Str) values, and is optional.

table

table(Table)

This attribute is read-only, accepts (Table) values, and is required.

METHODS

This package implements the following methods:

create

create(Any %args) : Command

Registers an index create and returns the Command object.

create example #1

# given: synopsis

my $create = $self->create;

delete

delete(Any %args) : Command

Registers an index delete and returns the Command object.

delete example #1

# given: synopsis

my $delete = $self->delete;

doodle

doodle() : Doodle

Returns the associated Doodle object.

doodle example #1

# given: synopsis

my $doodle = $self->doodle;

unique

unique() : Index

Denotes that the index should be created and enforced as unique and returns itself.

unique example #1

# given: synopsis

my $unique = $self->unique;

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated in the "license file".