minor: docs

This commit is contained in:
Kyle Banker 2010-04-07 15:58:02 -04:00
parent fd43eca514
commit 3d3e983ae0
2 changed files with 10 additions and 1 deletions

View File

@ -80,6 +80,10 @@ module Mongo
# Delete a file from the store. # Delete a file from the store.
# #
# Note that deleting a GridFS file can result in read errors if another process
# is attempting to read a file while it's being deleted. While the odds for this
# kind of race condition are small, it's important to be aware of.
#
# @param [] id # @param [] id
# #
# @return [Boolean] # @return [Boolean]

View File

@ -56,7 +56,8 @@ module Mongo
# loaded. Otherwise, the content type 'binary/octet-stream' will be used. # loaded. Otherwise, the content type 'binary/octet-stream' will be used.
# @options opts [Integer] (262144) :chunk_size size of file chunks in bytes. # @options opts [Integer] (262144) :chunk_size size of file chunks in bytes.
# @options opts [Boolean] :delete_old (false) ensure that old versions of the file are deleted. This option # @options opts [Boolean] :delete_old (false) ensure that old versions of the file are deleted. This option
# only work in 'w' mode. # only work in 'w' mode. Certain precautions must be taken when deleting GridFS files. See the notes under
# GridFileSystem#delete.
# @options opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server # @options opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
# will be validated using an md5 hash. If validation fails, an exception will be raised. # will be validated using an md5 hash. If validation fails, an exception will be raised.
# #
@ -104,6 +105,10 @@ module Mongo
# Delete the file with the given filename. Note that this will delete # Delete the file with the given filename. Note that this will delete
# all versions of the file. # all versions of the file.
# #
# Note that deleting a GridFS file can result in read errors if another process
# is attempting to read a file while it's being deleted. While the odds for this
# kind of race condition are small, it's important to be aware of.
#
# @param [String] filename # @param [String] filename
# #
# @yield [] pass a block that returns an array of documents to be deleted. # @yield [] pass a block that returns an array of documents to be deleted.