Difference between revisions of "API:EPrints/Storage"

From EPrints Documentation
Jump to: navigation, search
Line 4: Line 4:
  
  
<!-- Pod2Wiki=_private_ -->{{API:Unstable}}<!-- Pod2Wiki=head_name --></div>
+
<!-- Pod2Wiki=_private_ -->{{API:Unstable}}<!-- Pod2Wiki=head_name -->==NAME==
==NAME==
 
 
'''EPrints::Storage''' - store and retrieve objects in the storage engine
 
'''EPrints::Storage''' - store and retrieve objects in the storage engine
  
Line 13: Line 12:
  
  
 +
 +
</div>
 
<!-- Pod2Wiki=_private_ -->This should be inserted verbatum into the Wiki page.
 
<!-- Pod2Wiki=_private_ -->This should be inserted verbatum into the Wiki page.
  
<!-- Pod2Wiki=head_synopsis --></div>
+
<!-- Pod2Wiki=head_synopsis -->==SYNOPSIS==
==SYNOPSIS==
 
 
   my $store = $repository-&gt;storage();
 
   my $store = $repository-&gt;storage();
 
    
 
    
Line 30: Line 30:
  
  
<!-- Pod2Wiki=head_description --></div>
+
 
==DESCRIPTION==
+
</div>
 +
<!-- Pod2Wiki=head_description -->==DESCRIPTION==
 
This module is the storage control layer which uses [[API:EPrints/Plugin/Storage|EPrints::Plugin::Storage]] plugins to support various storage back-ends. It enables the storage, retrieval and deletion of data streams. The maximum size of a stream is dependent on the back-end storage mechanism.
 
This module is the storage control layer which uses [[API:EPrints/Plugin/Storage|EPrints::Plugin::Storage]] plugins to support various storage back-ends. It enables the storage, retrieval and deletion of data streams. The maximum size of a stream is dependent on the back-end storage mechanism.
  
Line 39: Line 40:
  
  
<!-- Pod2Wiki=head_methods --></div>
+
 
==METHODS==
+
</div>
 +
<!-- Pod2Wiki=head_methods -->==METHODS==
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 46: Line 48:
  
  
<!-- Pod2Wiki=item_new --></div>
+
 
===$store = EPrints::Storage-&gt;new( $repository )===
+
</div>
 +
<!-- Pod2Wiki=item_new -->===$store = EPrints::Storage-&gt;new( $repository )===
  
 
Create a new storage object for $repository. Should not be used directly, see [[API:EPrints/Session|EPrints::Session]].
 
Create a new storage object for $repository. Should not be used directly, see [[API:EPrints/Session|EPrints::Session]].
Line 56: Line 59:
  
  
<!-- Pod2Wiki=item_store --></div>
+
 
===$len = $store-&gt;store( $fileobj, CODEREF )===
+
</div>
 +
<!-- Pod2Wiki=item_store -->===$len = $store-&gt;store( $fileobj, CODEREF )===
  
 
Read from and store all data from CODEREF for $fileobj. The '''filesize''' field in $fileobj must be set at the expected number of bytes to read from CODEREF.
 
Read from and store all data from CODEREF for $fileobj. The '''filesize''' field in $fileobj must be set at the expected number of bytes to read from CODEREF.
Line 68: Line 72:
  
  
<!-- Pod2Wiki=item_retrieve --></div>
+
 
===$success = $store-&gt;retrieve( $fileobj, CALLBACK )===
+
</div>
 +
<!-- Pod2Wiki=item_retrieve -->===$success = $store-&gt;retrieve( $fileobj, CALLBACK )===
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 76: Line 81:
  
  
<!-- Pod2Wiki=item_delete --></div>
+
 
===$success = $store-&gt;delete( $fileobj )===
+
</div>
 +
<!-- Pod2Wiki=item_delete -->===$success = $store-&gt;delete( $fileobj )===
  
 
Delete all object copies stored for $fileobj.
 
Delete all object copies stored for $fileobj.
Line 86: Line 92:
  
  
<!-- Pod2Wiki=item_delete_copy --></div>
+
 
===$ok = $store-&gt;delete_copy( $plugin, $fileobj )===
+
</div>
 +
<!-- Pod2Wiki=item_delete_copy -->===$ok = $store-&gt;delete_copy( $plugin, $fileobj )===
  
 
Delete the copy of this file stored in $plugin.
 
Delete the copy of this file stored in $plugin.
Line 96: Line 103:
  
  
<!-- Pod2Wiki=item_get_local_copy --></div>
+
 
===$filename = $store-&gt;get_local_copy( $fileobj )===
+
</div>
 +
<!-- Pod2Wiki=item_get_local_copy -->===$filename = $store-&gt;get_local_copy( $fileobj )===
  
 
Return the name of a local copy of the file.
 
Return the name of a local copy of the file.
Line 110: Line 118:
  
  
<!-- Pod2Wiki=item_get_remote_copy --></div>
+
 
===$url = $store-&gt;get_remote_copy( $fileobj )===
+
</div>
 +
<!-- Pod2Wiki=item_get_remote_copy -->===$url = $store-&gt;get_remote_copy( $fileobj )===
  
 
Returns a URL from which this file can be accessed.
 
Returns a URL from which this file can be accessed.
Line 122: Line 131:
  
  
<!-- Pod2Wiki=item_get_plugins --></div>
+
 
===@plugins = $store-&gt;get_plugins( $fileobj )===
+
</div>
 +
<!-- Pod2Wiki=item_get_plugins -->===@plugins = $store-&gt;get_plugins( $fileobj )===
  
 
Returns the [[API:EPrints/Plugin/Storage|EPrints::Plugin::Storage]] plugin(s) to use for $fileobj. If more than one plugin is returned they should be used in turn until one succeeds.
 
Returns the [[API:EPrints/Plugin/Storage|EPrints::Plugin::Storage]] plugin(s) to use for $fileobj. If more than one plugin is returned they should be used in turn until one succeeds.
Line 132: Line 142:
  
  
<!-- Pod2Wiki=item_copy --></div>
+
 
===$ok = $store-&gt;copy( $plugin, $fileobj )===
+
</div>
 +
<!-- Pod2Wiki=item_copy -->===$ok = $store-&gt;copy( $plugin, $fileobj )===
  
 
Copy the contents of $fileobj into another storage $plugin.
 
Copy the contents of $fileobj into another storage $plugin.
Line 144: Line 155:
  
  
<!-- Pod2Wiki=item_open_write --></div>
+
 
===$ok = $storage-&gt;open_write( $fileobj )===
+
</div>
 +
<!-- Pod2Wiki=item_open_write -->===$ok = $storage-&gt;open_write( $fileobj )===
  
 
Start a write session for $fileobj. $fileobj must have at least the "filesize" property set (which is the number of bytes that will be written).
 
Start a write session for $fileobj. $fileobj must have at least the "filesize" property set (which is the number of bytes that will be written).
Line 154: Line 166:
  
  
<!-- Pod2Wiki=item_write --></div>
+
 
===$ok = $storage-&gt;write( $fileobj, $buffer )===
+
</div>
 +
<!-- Pod2Wiki=item_write -->===$ok = $storage-&gt;write( $fileobj, $buffer )===
  
 
Write $buffer to the storage plugin(s).
 
Write $buffer to the storage plugin(s).
Line 164: Line 177:
  
  
<!-- Pod2Wiki=item_close_write --></div>
+
 
===$ok = $storage-&gt;close_write( $fileobj );===
+
</div>
 +
<!-- Pod2Wiki=item_close_write -->===$ok = $storage-&gt;close_write( $fileobj );===
  
 
Finish writing to the storage plugin(s) for $fileobj.
 
Finish writing to the storage plugin(s) for $fileobj.
Line 174: Line 188:
  
  
 +
 +
</div>
 
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Revision as of 12:06, 25 February 2010

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


Warning The interface for this module has not been finalised and may change in the future.
==NAME==

EPrints::Storage - store and retrieve objects in the storage engine

User Comments


This should be inserted verbatum into the Wiki page.

SYNOPSIS

 my $store = $repository->storage();
 
 $store->store(
   $fileobj,    # file object
   "diddle.pdf",  # filename
   $fh        # file handle
 );
 

User Comments


DESCRIPTION

This module is the storage control layer which uses EPrints::Plugin::Storage plugins to support various storage back-ends. It enables the storage, retrieval and deletion of data streams. The maximum size of a stream is dependent on the back-end storage mechanism.

User Comments


METHODS

User Comments


$store = EPrints::Storage->new( $repository )

Create a new storage object for $repository. Should not be used directly, see EPrints::Session.

User Comments


$len = $store->store( $fileobj, CODEREF )

Read from and store all data from CODEREF for $fileobj. The filesize field in $fileobj must be set at the expected number of bytes to read from CODEREF.

Returns undef if the file couldn't be stored, otherwise the number of bytes read.

User Comments


$success = $store->retrieve( $fileobj, CALLBACK )

User Comments


$success = $store->delete( $fileobj )

Delete all object copies stored for $fileobj.

User Comments


$ok = $store->delete_copy( $plugin, $fileobj )

Delete the copy of this file stored in $plugin.

User Comments


$filename = $store->get_local_copy( $fileobj )

Return the name of a local copy of the file.

Will retrieve and cache the remote object using File::Temp if necessary.

Returns undef if retrieval failed.

User Comments


$url = $store->get_remote_copy( $fileobj )

Returns a URL from which this file can be accessed.

Returns undef if this file is not available via another service.

User Comments


@plugins = $store->get_plugins( $fileobj )

Returns the EPrints::Plugin::Storage plugin(s) to use for $fileobj. If more than one plugin is returned they should be used in turn until one succeeds.

User Comments


$ok = $store->copy( $plugin, $fileobj )

Copy the contents of $fileobj into another storage $plugin.

Returns 1 on success, 0 on failure and -1 if a copy already exists in $plugin.

User Comments


$ok = $storage->open_write( $fileobj )

Start a write session for $fileobj. $fileobj must have at least the "filesize" property set (which is the number of bytes that will be written).

User Comments


$ok = $storage->write( $fileobj, $buffer )

Write $buffer to the storage plugin(s).

User Comments


$ok = $storage->close_write( $fileobj );

Finish writing to the storage plugin(s) for $fileobj.

User Comments