Daisuke Maki > Data-ResourceSet-0.00003 > Data::ResourceSet

Download:
Data-ResourceSet-0.00003.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.00003   Source  

NAME ^

Data::ResourceSet - A Bundle Of Resources

SYNOPSIS ^

  my $cluster = Data::ResourceSet->new(
    resources => {
      schema => {
        name1 => $dbic_schema1
        name2 => $dbic_schema2
      },
      s3bucket => {
        name1 => $s3bucket1,
        name2 => $s3bucket2,
      }
    }
  );

  my $photo_meta =
    $cluster->resource('schema', 'Name')->resultset('Photo')->find($photo_id);
  my $photo_file =
    $cluster->resource('s3bucket', 'Name')->get_key($key, $filename);

DESCRIPTION ^

Data::ResourceSet is a bag of "stuff", where you can refer to the "stuff" by name, and the "stuff" will be initialized for you.

For example, say you have multiple DBIx::Class::Schema objects in your app. You would like to make the reference to each resource as abstract as possible so you don't hard code anything. Then you can create an instance of Data::ResourceSet and refer to these schemas by name.

Here are two ways to do it. First is to simply create a resource set from already instantiated schemas:

  my $schema1 = MyCluster1->connect($dsn, $user, $pass);
  my $schema2 = MyCluster2->connect($dsn, $user, $pass);
  my $resources = Data::ResourceSet->new({
    resources => {
      schema => {
        cluster1 => $schema1,
        cluster2 => $schema2,
      }
    }
  });

  $resources->resource('schema', 'cluster1')->resultset('FooBar')->search(...)

The other way to do it is by giving a similar hash, but give only the config

  my $resources = Data::ResourceSet->new({
    resources_config => {
      schema => {
        cluster1 => {
          module      => '+DBIx::Class::Schema',
          consturctor => 'connect',
          args        => [ $dsn, $user, $pass ],
        },
        cluster2 => {
          module      => '+DBIx::Class::Schema',
          consturctor => 'connect',
          args        => [ $dsn, $user, $pass ],
        }
      }
    }
  });
  $resources->resource('schema', 'cluster1')->resultset('FooBar')->search(...)

The difference between the first and the second example above is that the latter does a lazy initialization. So if you don't want to connect until you actually use the connection, then the second way is the way to go.

You can also specify this config on a per-package level, say, when you subclass Data::ResourceSet:

  package MyApp::ResourceSet;
  use base qw(Data::ResourceSet);

  __PACKAGE__->config(
    resources => {
      schema => {
        cluster1 => {
          module      => '+DBIx::Class::Schema',
          consturctor => 'connect',
          args        => [ $dsn, $user, $pass ],
        },
        cluster2 => {
          module      => '+DBIx::Class::Schema',
          consturctor => 'connect',
          args        => [ $dsn, $user, $pass ],
        }
      }
    }
  });

  my $resources = MyApp::ResourceSet->new;
  $resources->resource('schema', 'cluster1')->resultset('FooBar')->search(...)

You can also use Data::ResourceSet::Adaptor, which can be a proxy between Data::ResourceSet and your actual resource.

  package MyProxy;
  use base qw(Data::ResourceSet::Adaptor);

  sub ACCEPT_CONTEXT
  {
    my($self, $c, @args) = @_;
    ...
    return $whatever;
  }

  my $resource = Data::ResourceSet->new({
    resource_config => {
      foo => {
        bar => {
          module => '+MyProxy',
          args   => \%whatever
        }
      }
    }
  });

APPLICATION ^

Data::ResourceSet is inspired by Catalyst and its method of being a glue mediator between components. You can use it in applications where you have multiple components, and you don't want to refer to a hardcoded resource.

Also, it's quite handy when you want to partition your storage on large applications. In such cases, you should create multiple Data::ResourceSet objects with the same keys:

  my $schema1 = DBIx::Class::Schema->connect(...);
  my $schema2 = DBIx::Class::Schema->connect(...);

  my $cluster1 = Data::ResourceSet->new({
    resources => {
      schema => {
        name => $schema1,
      }
    }
  });
  
  my $cluster2 = Data::ResourceSet->new({
    resources => {
      schema => {
        name => $schema2,
      }
    }
  });

  # For whichever cluster above...
  $cluster->resource('schema', 'name')->resultset(...)

METHODS ^

new(\%args)

resources => \%data
resources_config => \%config

resource($type, $name)

Gets a resource by its type and name

construct_resource

Constructs a resource by its config

find_config

Find the configuration for a resource

AUTHOR ^

Copyright (c) 2008 Daisuke Maki daisuke@endeworks.jp

LICENSE ^

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself (Artistic License v1.0/v2.0).

See http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: