diff --git a/lib/MogileFS/Worker/Query.pm b/lib/MogileFS/Worker/Query.pm index 4593139d..14720baa 100644 --- a/lib/MogileFS/Worker/Query.pm +++ b/lib/MogileFS/Worker/Query.pm @@ -1828,6 +1828,66 @@ __END__ MogileFS::Worker::Query -- implements the MogileFS client protocol +=head1 SUPPORTED COMMANDS + +This is a list of supported commands that can be sent to the tracker. + +=head2 create_open + +This command is used to create a new file in MogileFS with the specified domain and key. + +=head3 Parameters + +=over + +=item B = I + +B<(required)> The name of domain the new file is being stored in + +=item B = I + +B<(required)> The key for the new file + +=item B = I + +The class to use for the new file + +=item B = I + +a boolean indicating that multiple target mogstored devices should be returned + +=item B = I + +This is the estimated number of bytes for the new file, it is used to ensure returned devices have enough free space. + +=back + +=head3 Response + +=over + +=item B = I + +The id of the new file. + +=item B = I + +The id of the device this file will be stored on. (Only returned when B is false) + +=item B = I + +The url of the mogstored devices to store the file on. (Only returned when B is false) + +=item B = I + +=item B = I + +=item B = I + +When B is true, B indicates the number of potential mogstored devices that are being returned, with a B and B for each potential device, # is a value between 1 and B, inclusive. + +=back + =head1 SEE ALSO L