Mongo Scala Driver - org.mongodb.scala.gridfs.GridFSBucket

final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def ##(): Int

Definition Classes: AnyRef → Any

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def asInstanceOf[T0]: T0

Definition Classes: Any

lazy val bucketName: String

The bucket name.

returns: the bucket name

lazy val chunkSizeBytes: Int

Sets the chunk size in bytes.

Sets the chunk size in bytes. Defaults to 255.

returns: the chunk size in bytes.

def clone(): AnyRef

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @native() @throws( ... )

def delete(clientSession: ClientSession, id: BsonValue): Observable[Completed]

Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.

clientSession: the client session with which to associate this operation
id: the ObjectId of the file to be deleted
returns: a Observable with a single element indicating when the operation has completed

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def delete(clientSession: ClientSession, id: ObjectId): Observable[Completed]

Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.

clientSession: the client session with which to associate this operation
id: the ObjectId of the file to be deleted
returns: a Observable with a single element indicating when the operation has completed

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def delete(id: BsonValue): Observable[Completed]

Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.

id: the ObjectId of the file to be deleted
returns: a Observable with a single element indicating when the operation has completed

def delete(id: ObjectId): Observable[Completed]

Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.

id: the ObjectId of the file to be deleted
returns: a Observable with a single element indicating when the operation has completed

lazy val disableMD5: Boolean

Returns true if computing MD5 checksums when uploading files is disabled.

returns: true if computing MD5 checksums when uploading files is disabled.

Since: 2.4

def downloadToStream(clientSession: ClientSession, filename: String, destination: AsyncOutputStream, options: GridFSDownloadOptions): Observable[Long]

Downloads the contents of the stored file specified by filename and by the revision in options and writes the contents to the destination Stream.

clientSession: the client session with which to associate this operation
filename: the name of the file to be downloaded
destination: the destination stream
options: the download options
returns: a Observable with a single element indicating the file has been downloaded

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def downloadToStream(clientSession: ClientSession, filename: String, destination: AsyncOutputStream): Observable[Long]

Downloads the contents of the latest version of the stored file specified by filename and writes the contents to the destination Stream.

clientSession: the client session with which to associate this operation
filename: the name of the file to be downloaded
destination: the destination stream
returns: a Observable with a single element indicating the file has been downloaded

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def downloadToStream(clientSession: ClientSession, id: BsonValue, destination: AsyncOutputStream): Observable[Long]

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

clientSession: the client session with which to associate this operation
id: the custom id of the file, to be written to the destination stream
destination: the destination stream
returns: a Observable with a single element indicating the file has been downloaded

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def downloadToStream(clientSession: ClientSession, id: ObjectId, destination: AsyncOutputStream): Observable[Long]

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

clientSession: the client session with which to associate this operation
id: the ObjectId of the file to be written to the destination stream
destination: the destination stream
returns: a Observable with a single element indicating the file has been downloaded

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def downloadToStream(filename: String, destination: AsyncOutputStream, options: GridFSDownloadOptions): Observable[Long]

Downloads the contents of the stored file specified by filename and by the revision in options and writes the contents to the destination Stream.

filename: the name of the file to be downloaded
destination: the destination stream
options: the download options
returns: a Observable with a single element indicating the file has been downloaded

def downloadToStream(filename: String, destination: AsyncOutputStream): Observable[Long]

Downloads the contents of the latest version of the stored file specified by filename and writes the contents to the destination Stream.

filename: the name of the file to be downloaded
destination: the destination stream
returns: a Observable with a single element indicating the file has been downloaded

def downloadToStream(id: BsonValue, destination: AsyncOutputStream): Observable[Long]

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

id: the custom id of the file, to be written to the destination stream
destination: the destination stream
returns: a Observable with a single element indicating the file has been downloaded

def downloadToStream(id: ObjectId, destination: AsyncOutputStream): Observable[Long]

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

id: the ObjectId of the file to be written to the destination stream
destination: the destination stream
returns: a Observable with a single element indicating the file has been downloaded

def drop(clientSession: ClientSession): Observable[Completed]

Drops the data associated with this bucket from the database.

clientSession: the client session with which to associate this operation
returns: a Observable with a single element indicating when the operation has completed

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def drop(): Observable[Completed]

Drops the data associated with this bucket from the database.

returns: a Observable with a single element indicating when the operation has completed

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def finalize(): Unit

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

def find(clientSession: ClientSession, filter: Bson): GridFSFindObservable

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"));

clientSession: the client session with which to associate this operation
filter: the query filter
returns: the GridFS find iterable interface

Since: 2.2
Note: Requires MongoDB 3.6 or greater
See also: com.mongodb.client.model.Filters

def find(clientSession: ClientSession): GridFSFindObservable

Finds all documents in the files collection.

clientSession: the client session with which to associate this operation
returns: the GridFS find iterable interface

Since: 2.2
Note: Requires MongoDB 3.6 or greater
See also: Find

def find(filter: Bson): GridFSFindObservable

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"));

filter: the query filter
returns: the GridFS find iterable interface

See also: com.mongodb.client.model.Filters

def find(): GridFSFindObservable

Finds all documents in the files collection.

returns: the GridFS find iterable interface

See also: Find

final def getClass(): Class[_]

Definition Classes: AnyRef → Any
Annotations: @native()

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef
Annotations: @native()

final def notifyAll(): Unit

Definition Classes: AnyRef
Annotations: @native()

def openDownloadStream(clientSession: ClientSession, filename: String, options: GridFSDownloadOptions): GridFSDownloadStream

Opens a Stream from which the application can read the contents of the stored file specified by filename and the revision in options.

clientSession: the client session with which to associate this operation
filename: the name of the file to be downloaded
options: the download options
returns: the stream

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openDownloadStream(clientSession: ClientSession, filename: String): GridFSDownloadStream

Opens a Stream from which the application can read the contents of the latest version of the stored file specified by the filename.

clientSession: the client session with which to associate this operation
filename: the name of the file to be downloaded
returns: the stream

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openDownloadStream(clientSession: ClientSession, id: BsonValue): GridFSDownloadStream

Opens a AsyncInputStream from which the application can read the contents of the stored file specified by id.

clientSession: the client session with which to associate this operation
id: the custom id value of the file, to be put into a stream.
returns: the stream

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openDownloadStream(clientSession: ClientSession, id: ObjectId): GridFSDownloadStream

Opens a AsyncInputStream from which the application can read the contents of the stored file specified by id.

clientSession: the client session with which to associate this operation
id: the ObjectId of the file to be put into a stream.
returns: the stream

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openDownloadStream(filename: String, options: GridFSDownloadOptions): GridFSDownloadStream

Opens a Stream from which the application can read the contents of the stored file specified by filename and the revision in options.

filename: the name of the file to be downloaded
options: the download options
returns: the stream

def openDownloadStream(filename: String): GridFSDownloadStream

Opens a Stream from which the application can read the contents of the latest version of the stored file specified by the filename.

filename: the name of the file to be downloaded
returns: the stream

def openDownloadStream(id: BsonValue): GridFSDownloadStream

Opens a AsyncInputStream from which the application can read the contents of the stored file specified by id.

id: the custom id value of the file, to be put into a stream.
returns: the stream

def openDownloadStream(id: ObjectId): GridFSDownloadStream

Opens a AsyncInputStream from which the application can read the contents of the stored file specified by id.

id: the ObjectId of the file to be put into a stream.
returns: the stream

def openUploadStream(clientSession: ClientSession, id: BsonValue, filename: String, options: GridFSUploadOptions): GridFSUploadStream

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.

clientSession: the client session with which to associate this operation
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.

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openUploadStream(clientSession: ClientSession, id: BsonValue, filename: String): GridFSUploadStream

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.

clientSession: the client session with which to associate this operation
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.

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openUploadStream(clientSession: ClientSession, filename: String, options: GridFSUploadOptions): GridFSUploadStream

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.

clientSession: the client session with which to associate this operation
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.

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openUploadStream(clientSession: ClientSession, filename: String): GridFSUploadStream

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.

clientSession: the client session with which to associate this operation
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.

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def openUploadStream(id: BsonValue, filename: String, options: GridFSUploadOptions): GridFSUploadStream

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.

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.

def openUploadStream(id: BsonValue, filename: String): GridFSUploadStream

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.

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.

def openUploadStream(filename: String, options: GridFSUploadOptions): GridFSUploadStream

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.

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.

def openUploadStream(filename: String): GridFSUploadStream

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.

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.

lazy val readConcern: ReadConcern

Get the read concern for the GridFSBucket.

returns: the ReadConcern

Note: Requires MongoDB 3.2 or greater
See also: Read Concern

lazy val readPreference: ReadPreference

Get the read preference for the GridFSBucket.

returns: the ReadPreference

def rename(clientSession: ClientSession, id: BsonValue, newFilename: String): Observable[Completed]

Renames the stored file with the specified id.

clientSession: the client session with which to associate this operation
id: the id of the file in the files collection to rename
newFilename: the new filename for the file
returns: a Observable with a single element indicating when the operation has completed

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def rename(clientSession: ClientSession, id: ObjectId, newFilename: String): Observable[Completed]

Renames the stored file with the specified id.

clientSession: the client session with which to associate this operation
id: the id of the file in the files collection to rename
newFilename: the new filename for the file
returns: a Observable with a single element indicating when the operation has completed

Since: 2.2
Note: Requires MongoDB 3.6 or greater

def rename(id: BsonValue, newFilename: String): Observable[Completed]

Renames the stored file with the specified id.

id: the id of the file in the files collection to rename
newFilename: the new filename for the file
returns: a Observable with a single element indicating when the operation has completed

def rename(id: ObjectId, newFilename: String): Observable[Completed]

Renames the stored file with the specified id.

id: the id of the file in the files collection to rename
newFilename: the new filename for the file
returns: a Observable with a single element indicating when the operation has completed

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes: AnyRef

def uploadFromStream(clientSession: ClientSession, id: BsonValue, filename: String, source: AsyncInputStream, options: GridFSUploadOptions): Observable[Completed]

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