GridFSBucket (mongo-java-driver 3.1.0 API)

@ThreadSafe
public interface GridFSBucket

Represents a GridFS Bucket

Since:: 3.1

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`delete(ObjectId id)` Given a `id`, delete this stored file's files collection document and associated chunks from a GridFS bucket.
`void`	`downloadToStream(BsonValue id, OutputStream destination)` Deprecated. using custom id values for with GridFS is no longer supported
`void`	`downloadToStream(ObjectId id, OutputStream destination)` Downloads the contents of the stored file specified by `id` and writes the contents to the `destination` Stream.
`void`	`downloadToStreamByName(String filename, OutputStream destination)` Downloads the contents of the latest version of the stored file specified by `filename` and writes the contents to the `destination` Stream.
`void`	`downloadToStreamByName(String filename, OutputStream destination, GridFSDownloadByNameOptions options)` Downloads the contents of the stored file specified by `filename` and by the revision in `options` and writes the contents to the `destination` Stream.
`void`	`drop()` Drops the data associated with this bucket from the database.
`GridFSFindIterable`	`find()` Finds all documents in the files collection.
`GridFSFindIterable`	`find(Bson filter)` Finds all documents in the collection that match the filter.
`String`	`getBucketName()` The bucket name.
`int`	`getChunkSizeBytes()` Sets the chunk size in bytes.
`ReadPreference`	`getReadPreference()` Get the read preference for the GridFSBucket.
`WriteConcern`	`getWriteConcern()` Get the write concern for the GridFSBucket.
`GridFSDownloadStream`	`openDownloadStream(BsonValue id)` Deprecated. using custom id values for with GridFS is no longer supported
`GridFSDownloadStream`	`openDownloadStream(ObjectId id)` Opens a Stream from which the application can read the contents of the stored file specified by `id`.
`GridFSDownloadStream`	`openDownloadStreamByName(String filename)` Opens a Stream from which the application can read the contents of the latest version of the stored file specified by the `filename`.
`GridFSDownloadStream`	`openDownloadStreamByName(String filename, GridFSDownloadByNameOptions options)` Opens a Stream from which the application can read the contents of the stored file specified by `filename` and the revision in `options`.
`GridFSUploadStream`	`openUploadStream(String filename)` Opens a Stream that the application can write the contents of the file to.
`GridFSUploadStream`	`openUploadStream(String filename, GridFSUploadOptions options)` Opens a Stream that the application can write the contents of the file to.
`void`	`rename(ObjectId id, String newFilename)` Renames the stored file with the specified `id`.
`ObjectId`	`uploadFromStream(String filename, InputStream source)` Uploads a user file to a GridFS bucket.
`ObjectId`	`uploadFromStream(String filename, InputStream source, GridFSUploadOptions options)` Uploads a user file to a GridFS bucket.
`GridFSBucket`	`withChunkSizeBytes(int chunkSizeBytes)` Create a new GridFSBucket instance with a new chunk size in bytes.
`GridFSBucket`	`withReadPreference(ReadPreference readPreference)` Create a new GridFSBucket instance with a different read preference.
`GridFSBucket`	`withWriteConcern(WriteConcern writeConcern)` Create a new GridFSBucket instance with a different write concern.

- Method Detail
  - getBucketName
```
String getBucketName()
```
    The bucket name.
    
    Returns:
    
    the bucket name
  - getChunkSizeBytes
```
int getChunkSizeBytes()
```
    Sets the chunk size in bytes. Defaults to 255.
    
    Returns:
    
    the chunk size in bytes.
  - getWriteConcern
```
WriteConcern getWriteConcern()
```
    Get the write concern for the GridFSBucket.
    
    Returns:
    
    the WriteConcern
  - getReadPreference
```
ReadPreference getReadPreference()
```
    Get the read preference for the GridFSBucket.
    
    Returns:
    
    the ReadPreference
  - withChunkSizeBytes
```
GridFSBucket withChunkSizeBytes(int chunkSizeBytes)
```
    Create a new GridFSBucket instance with a new chunk size in bytes.
    
    Parameters:
    
    chunkSizeBytes - the new chunk size in bytes.
    
    Returns:
    
    a new GridFSBucket instance with the different chunk size in bytes
  - withReadPreference
```
GridFSBucket withReadPreference(ReadPreference readPreference)
```
    Create a new GridFSBucket instance with a different read preference.
    
    Parameters:
    
    readPreference - the new ReadPreference for the database
    
    Returns:
    
    a new GridFSBucket instance with the different readPreference
  - withWriteConcern
```
GridFSBucket withWriteConcern(WriteConcern writeConcern)
```
    Create a new GridFSBucket instance with a different write concern.
    
    Parameters:
    
    writeConcern - the new WriteConcern for the database
    
    Returns:
    
    a new GridFSBucket instance with the different writeConcern
  - openUploadStream
```
GridFSUploadStream openUploadStream(String filename)
```
    Opens a Stream that the application can write the contents of the file to.
    As the application writes the contents to the returned Stream, the contents are uploaded as chunks in the chunks collection. When the application signals it is done writing the contents of the file by calling close on the returned Stream, a files collection document is created in the files collection.
    
    Parameters:
    
    filename - the filename for the stream
    
    Returns:
    
    the GridFSUploadStream that provides the ObjectId for the file to be uploaded and the Stream to which the application will write the contents.
  - openUploadStream
```
GridFSUploadStream openUploadStream(String filename,
                                    GridFSUploadOptions options)
```
    Opens a Stream that the application can write the contents of the file to.
    As the application writes the contents to the returned Stream, the contents are uploaded as chunks in the chunks collection. When the application signals it is done writing the contents of the file by calling close on the returned Stream, a files collection document is created in the files collection.
    
    Parameters:
    
    filename - the filename for the stream
    
    options - the GridFSUploadOptions
    
    Returns:
    
    the GridFSUploadStream that provides the ObjectId for the file to be uploaded and the Stream to which the application will write the contents.
  - uploadFromStream
```
ObjectId uploadFromStream(String filename,
                          InputStream source)
```
    Uploads a user file to a GridFS bucket.
    Reads the contents of the user file from the Stream and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.
    
    Parameters:
    
    filename - the filename for the stream
    
    source - the Stream providing the file data
    
    Returns:
    
    the ObjectId of the uploaded file.
  - uploadFromStream
```
ObjectId uploadFromStream(String filename,
                          InputStream source,
                          GridFSUploadOptions options)
```
    Uploads a user file to a GridFS bucket.
    Reads the contents of the user file from the Stream and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.
    
    Parameters:
    
    filename - the filename for the stream
    
    source - the Stream providing the file data
    
    options - the GridFSUploadOptions
    
    Returns:
    
    the ObjectId of the uploaded file.
  - openDownloadStream
```
GridFSDownloadStream openDownloadStream(ObjectId id)
```
    Opens a Stream from which the application can read the contents of the stored file specified by id.
    
    Parameters:
    
    id - the ObjectId of the file to be put into a stream.
    
    Returns:
    
    the stream
  - downloadToStream
```
void downloadToStream(ObjectId id,
                      OutputStream destination)
```
    Downloads the contents of the stored file specified by id and writes the contents to the destination Stream.
    
    Parameters:
    
    id - the ObjectId of the file to be written to the destination stream
    
    destination - the destination stream
  - openDownloadStream
```
@Deprecated
GridFSDownloadStream openDownloadStream(BsonValue id)
```
    Deprecated. using custom id values for with GridFS is no longer supported
    
    Opens a Stream from which the application can read the contents of the stored file specified by id.
    
    Parameters:
    
    id - the custom id value of the file, to be put into a stream.
    
    Returns:
    
    the stream
  - downloadToStream
```
@Deprecated
void downloadToStream(BsonValue id,
                                  OutputStream destination)
```
    Deprecated. using custom id values for with GridFS is no longer supported
    
    Downloads the contents of the stored file specified by id and writes the contents to the destination Stream.
    
    Parameters:
    
    id - the custom id of the file, to be written to the destination stream
    
    destination - the destination stream
  - openDownloadStreamByName
```
GridFSDownloadStream openDownloadStreamByName(String filename)
```
    Opens a Stream from which the application can read the contents of the latest version of the stored file specified by the filename.
    
    Parameters:
    
    filename - the name of the file to be downloaded
    
    Returns:
    
    the stream
  - openDownloadStreamByName
```
GridFSDownloadStream openDownloadStreamByName(String filename,
                                              GridFSDownloadByNameOptions options)
```
    Opens a Stream from which the application can read the contents of the stored file specified by filename and the revision in options.
    
    Parameters:
    
    filename - the name of the file to be downloaded
    
    options - the download options
    
    Returns:
    
    the stream
  - downloadToStreamByName
```
void downloadToStreamByName(String filename,
                            OutputStream destination)
```
    Downloads the contents of the latest version of the stored file specified by filename and writes the contents to the destination Stream.
    
    Parameters:
    
    filename - the name of the file to be downloaded
    
    destination - the destination stream
  - downloadToStreamByName
```
void downloadToStreamByName(String filename,
                            OutputStream destination,
                            GridFSDownloadByNameOptions options)
```
    Downloads the contents of the stored file specified by filename and by the revision in options and writes the contents to the destination Stream.
    
    Parameters:
    
    filename - the name of the file to be downloaded
    
    destination - the destination stream
    
    options - the download options
  - find
```
GridFSFindIterable find()
```
    Finds all documents in the files collection.
    
    Returns:
    
    the GridFS find iterable interface
    
    MongoDB documentation
    
    Find
  - find
```
GridFSFindIterable find(Bson filter)
```
    Finds all documents in the collection that match the filter.
    Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data:
```
  
      Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
  
  
```
    Parameters:
    
    filter - the query filter
    
    Returns:
    
    the GridFS find iterable interface
    
    See Also:
    
    Filters
  - delete
```
void delete(ObjectId id)
```
    Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
    
    Parameters:
    
    id - the ObjectId of the file to be deleted
  - rename
```
void rename(ObjectId id,
            String newFilename)
```
    Renames the stored file with the specified id.
    
    Parameters:
    
    id - the id of the file in the files collection to rename
    
    newFilename - the new filename for the file
  - drop
```
void drop()
```
    Drops the data associated with this bucket from the database.

Interface GridFSBucket

Method Summary

Method Detail

getBucketName

getChunkSizeBytes

getWriteConcern

getReadPreference

withChunkSizeBytes

withReadPreference

withWriteConcern

openUploadStream

openUploadStream

uploadFromStream

uploadFromStream

openDownloadStream

downloadToStream

openDownloadStream

downloadToStream

openDownloadStreamByName

openDownloadStreamByName

downloadToStreamByName

downloadToStreamByName

find

find

delete

rename

drop