com.mongodb.reactivestreams.client.gridfs

Interface GridFSBucket

@ThreadSafe
public interface GridFSBucket

Represents a GridFS Bucket

Since:

1.3

Method Summary

Methods

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Success>	delete(org.bson.BsonValue id) Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
org.reactivestreams.Publisher<Success>	delete(org.bson.types.ObjectId id) Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
org.reactivestreams.Publisher<Long>	downloadToStream(org.bson.BsonValue id, AsyncOutputStream destination) Downloads the contents of the stored file specified by id and writes the contents to the destination AsyncOutputStream.
org.reactivestreams.Publisher<Long>	downloadToStream(org.bson.types.ObjectId id, AsyncOutputStream destination) Downloads the contents of the stored file specified by id and writes the contents to the destination AsyncOutputStream.
org.reactivestreams.Publisher<Long>	downloadToStream(String filename, AsyncOutputStream destination) Downloads the contents of the latest version of the stored file specified by filename and writes the contents to the destination Stream.
org.reactivestreams.Publisher<Long>	downloadToStream(String filename, AsyncOutputStream destination, com.mongodb.client.gridfs.model.GridFSDownloadOptions 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.
org.reactivestreams.Publisher<Success>	drop() Drops the data associated with this bucket from the database.
GridFSFindPublisher	find() Finds all documents in the files collection.
GridFSFindPublisher	find(org.bson.conversions.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.
com.mongodb.ReadConcern	getReadConcern() Get the read concern for the GridFSBucket.
com.mongodb.ReadPreference	getReadPreference() Get the read preference for the GridFSBucket.
com.mongodb.WriteConcern	getWriteConcern() Get the write concern for the GridFSBucket.
GridFSDownloadStream	openDownloadStream(org.bson.BsonValue id) Opens a AsyncInputStream from which the application can read the contents of the stored file specified by id.
GridFSDownloadStream	openDownloadStream(org.bson.types.ObjectId id) Opens a AsyncInputStream from which the application can read the contents of the stored file specified by id.
GridFSDownloadStream	openDownloadStream(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	openDownloadStream(String filename, com.mongodb.client.gridfs.model.GridFSDownloadOptions 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(org.bson.BsonValue id, String filename) Opens a AsyncOutputStream that the application can write the contents of the file to.
GridFSUploadStream	openUploadStream(org.bson.BsonValue id, String filename, com.mongodb.client.gridfs.model.GridFSUploadOptions options) Opens a AsyncOutputStream that the application can write the contents of the file to.
GridFSUploadStream	openUploadStream(String filename) Opens a AsyncOutputStream that the application can write the contents of the file to.
GridFSUploadStream	openUploadStream(String filename, com.mongodb.client.gridfs.model.GridFSUploadOptions options) Opens a AsyncOutputStream that the application can write the contents of the file to.
org.reactivestreams.Publisher<Success>	rename(org.bson.BsonValue id, String newFilename) Renames the stored file with the specified id.
org.reactivestreams.Publisher<Success>	rename(org.bson.types.ObjectId id, String newFilename) Renames the stored file with the specified id.
org.reactivestreams.Publisher<Success>	uploadFromStream(org.bson.BsonValue id, String filename, AsyncInputStream source) Uploads the contents of the given AsyncInputStream to a GridFS bucket.
org.reactivestreams.Publisher<Success>	uploadFromStream(org.bson.BsonValue id, String filename, AsyncInputStream source, com.mongodb.client.gridfs.model.GridFSUploadOptions options) Uploads the contents of the given AsyncInputStream to a GridFS bucket.
org.reactivestreams.Publisher<org.bson.types.ObjectId>	uploadFromStream(String filename, AsyncInputStream source) Uploads the contents of the given AsyncInputStream to a GridFS bucket.
org.reactivestreams.Publisher<org.bson.types.ObjectId>	uploadFromStream(String filename, AsyncInputStream source, com.mongodb.client.gridfs.model.GridFSUploadOptions options) Uploads the contents of the given AsyncInputStream to a GridFS bucket.
GridFSBucket	withChunkSizeBytes(int chunkSizeBytes) Create a new GridFSBucket instance with a new chunk size in bytes.
GridFSBucket	withReadConcern(com.mongodb.ReadConcern readConcern) Create a new MongoDatabase instance with a different read concern.
GridFSBucket	withReadPreference(com.mongodb.ReadPreference readPreference) Create a new GridFSBucket instance with a different read preference.
GridFSBucket	withWriteConcern(com.mongodb.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

com.mongodb.WriteConcern getWriteConcern()

Get the write concern for the GridFSBucket.

Returns:

the WriteConcern

getReadPreference

com.mongodb.ReadPreference getReadPreference()

Get the read preference for the GridFSBucket.

Returns:

the ReadPreference

getReadConcern

com.mongodb.ReadConcern getReadConcern()

Get the read concern for the GridFSBucket.

Returns:

the ReadConcern

MongoDB documentation

Read Concern

Since server release

3.2

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(com.mongodb.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(com.mongodb.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

withReadConcern

GridFSBucket withReadConcern(com.mongodb.ReadConcern readConcern)

Create a new MongoDatabase instance with a different read concern.

Parameters:

readConcern - the new ReadConcern for the database

Returns:

a new GridFSBucket instance with the different ReadConcern

MongoDB documentation

Read Concern

Since server release

3.2

openUploadStream

GridFSUploadStream openUploadStream(String filename)

Opens a AsyncOutputStream 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,
                                  com.mongodb.client.gridfs.model.GridFSUploadOptions options)

Opens a AsyncOutputStream 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.

openUploadStream

GridFSUploadStream openUploadStream(org.bson.BsonValue id,
                                  String filename)

Opens a AsyncOutputStream 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:

id - the custom id value of the file

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(org.bson.BsonValue id,
                                  String filename,
                                  com.mongodb.client.gridfs.model.GridFSUploadOptions options)

Opens a AsyncOutputStream 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:

id - the custom id value of the file

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

org.reactivestreams.Publisher<org.bson.types.ObjectId> uploadFromStream(String filename,
                                                                      AsyncInputStream source)

Uploads the contents of the given AsyncInputStream to a GridFS bucket.

Reads the contents of the user file from the source 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:

a publisher with a single element, the ObjectId of the uploaded file.

uploadFromStream

org.reactivestreams.Publisher<org.bson.types.ObjectId> uploadFromStream(String filename,
                                                                      AsyncInputStream source,
                                                                      com.mongodb.client.gridfs.model.GridFSUploadOptions options)

Uploads the contents of the given AsyncInputStream to a GridFS bucket.

Reads the contents of the user file from the source 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:

a publisher with a single element, the ObjectId of the uploaded file.

uploadFromStream

org.reactivestreams.Publisher<Success> uploadFromStream(org.bson.BsonValue id,
                                                      String filename,
                                                      AsyncInputStream source)

Uploads the contents of the given AsyncInputStream to a GridFS bucket.

Reads the contents of the user file from the source 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:

id - the custom id value of the file

filename - the filename for the stream

source - the Stream providing the file data

Returns:

a publisher with a single element, representing when the successful upload of the source.

uploadFromStream

org.reactivestreams.Publisher<Success> uploadFromStream(org.bson.BsonValue id,
                                                      String filename,
                                                      AsyncInputStream source,
                                                      com.mongodb.client.gridfs.model.GridFSUploadOptions options)

Uploads the contents of the given AsyncInputStream to a GridFS bucket.

Reads the contents of the user file from the source 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:

id - the custom id value of the file

filename - the filename for the stream

source - the Stream providing the file data

options - the GridFSUploadOptions

Returns:

a publisher with a single element, representing when the successful upload of the source.

openDownloadStream

GridFSDownloadStream openDownloadStream(org.bson.types.ObjectId id)

Opens a AsyncInputStream 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

org.reactivestreams.Publisher<Long> downloadToStream(org.bson.types.ObjectId id,
                                                   AsyncOutputStream destination)

Downloads the contents of the stored file specified by id and writes the contents to the destination AsyncOutputStream.

Parameters:

id - the ObjectId of the file to be written to the destination stream

destination - the destination stream

Returns:

a publisher with a single element, representing the amount of data written

openDownloadStream

GridFSDownloadStream openDownloadStream(org.bson.BsonValue id)

Opens a AsyncInputStream 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

org.reactivestreams.Publisher<Long> downloadToStream(org.bson.BsonValue id,
                                                   AsyncOutputStream destination)

Downloads the contents of the stored file specified by id and writes the contents to the destination AsyncOutputStream.

Parameters:

id - the custom id of the file, to be written to the destination stream

destination - the destination stream

Returns:

a publisher with a single element, representing the amount of data written

openDownloadStream

GridFSDownloadStream openDownloadStream(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

openDownloadStream

GridFSDownloadStream openDownloadStream(String filename,
                                      com.mongodb.client.gridfs.model.GridFSDownloadOptions 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

downloadToStream

org.reactivestreams.Publisher<Long> downloadToStream(String filename,
                                                   AsyncOutputStream 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

Returns:

a publisher with a single element, representing the amount of data written

downloadToStream

org.reactivestreams.Publisher<Long> downloadToStream(String filename,
                                                   AsyncOutputStream destination,
                                                   com.mongodb.client.gridfs.model.GridFSDownloadOptions 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

Returns:

a publisher with a single element, representing the amount of data written

find

GridFSFindPublisher find()

Finds all documents in the files collection.

Returns:

the GridFS find iterable interface

MongoDB documentation

Find

find

GridFSFindPublisher find(org.bson.conversions.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

org.reactivestreams.Publisher<Success> delete(org.bson.types.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

Returns:

a publisher with a single element, representing that the file has been deleted

delete

org.reactivestreams.Publisher<Success> delete(org.bson.BsonValue 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

Returns:

a publisher with a single element, representing that the file has been deleted

rename

org.reactivestreams.Publisher<Success> rename(org.bson.types.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

Returns:

a publisher with a single element, representing that the file has been renamed

rename

org.reactivestreams.Publisher<Success> rename(org.bson.BsonValue 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

Returns:

a publisher with a single element, representing that the file has been renamed

drop

org.reactivestreams.Publisher<Success> drop()

Drops the data associated with this bucket from the database.

Returns:

a publisher with a single element, representing that the collections have been dropped