Changeset 13057

Timestamp:

Apr 27, 2007, 11:26:04 AM (19 years ago)

Author:

jhoblitt

Message:

doc find_objects()

File:

• trunk/Nebulous/lib/Nebulous/Client.pod (modified) (2 diffs)

trunk/Nebulous/lib/Nebulous/Client.pod

@@ -19 +19 @@
     $neb->lock( "key", 'write' );
     $neb->unlock( "key", 'write' );
+    my $uris = $neb->find_objects( $pattern );
     my $uris = $neb->find_instances( "key", "node01" );
     my $path = $neb->find( "key" );
@@ -232 +233 @@
 
 
+=item * find_objects($pattern)
+
+Lists all storage objects that match C<$pattern>.  Where C<$pattern> is a POSIX
+1003.2 compatable regular repression.  Note that this is I<NOT> a Perl or PCRE
+regular expression.
+
+=over 4
+
+=item * pattern
+
+The storage object key (name).
+
+This parameter is optional.
+
+=back
+
+Returns an arrayref of scalars.
+
+
 =item * find_instances($key, $volume)