Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  lazy val bucketName: String

   The bucket name.

   The bucket name.

   returns

   the bucket name

6.  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.

7.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8.  def delete(id: BsonValue): Observable[Completed]

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

   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

9.  def delete(id: ObjectId): Observable[Completed]

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

   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

10.  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.

    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

11.  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.

    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

12.  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.

    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

13.  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.

    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

14.  def drop(): Observable[Completed]

    Drops the data associated with this bucket from the database.

    Drops the data associated with this bucket from the database.

    returns

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

15.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

16.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

17.  def find(filter: Bson): GridFSFindObservable

    Finds all documents in the collection that match the 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"));

    filter

    the query filter

    returns

    the GridFS find iterable interface

    See also

    com.mongodb.client.model.Filters

18.  def find(): GridFSFindObservable

    Finds all documents in the files collection.

    Finds all documents in the files collection.

    returns

    the GridFS find iterable interface

    See also

    Find

19.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

20.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

21.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

22.  final def notify(): Unit

    Definition Classes

    AnyRef

23.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

24.  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.

    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

25.  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.

    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

26.  def openDownloadStream(id: BsonValue): GridFSDownloadStream

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

    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

27.  def openDownloadStream(id: ObjectId): GridFSDownloadStream

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

    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

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

    Opens a AsyncOutputStream that the application can write the contents of the file to.

    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.

29.  def openUploadStream(id: BsonValue, filename: String): GridFSUploadStream

    Opens a AsyncOutputStream that the application can write the contents of the file to.

    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.

30.  def openUploadStream(filename: String, options: GridFSUploadOptions): GridFSUploadStream

    Opens a AsyncOutputStream that the application can write the contents of the file to.

    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.

31.  def openUploadStream(filename: String): GridFSUploadStream

    Opens a AsyncOutputStream that the application can write the contents of the file to.

    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.

32.  lazy val readConcern: ReadConcern

    Get the read concern for the GridFSBucket.

    Get the read concern for the GridFSBucket.

    returns

    the ReadConcern

    Note

    Requires MongoDB 3.2 or greater

    See also

    Read Concern

33.  lazy val readPreference: ReadPreference

    Get the read preference for the GridFSBucket.

    Get the read preference for the GridFSBucket.

    returns

    the ReadPreference

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

    Renames the stored file with the specified id.

    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

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

    Renames the stored file with the specified id.

    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

36.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

37.  def uploadFromStream(id: BsonValue, filename: String, source: AsyncInputStream, options: GridFSUploadOptions): Observable[Completed]

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

    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.

    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 Observable with a single element indicating when the operation has completed

38.  def uploadFromStream(id: BsonValue, filename: String, source: AsyncInputStream): Observable[Completed]

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

    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.

    id

    the custom id value of the file

    filename

    the filename for the stream

    source

    the Stream providing the file data

    returns

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

39.  def uploadFromStream(filename: String, source: AsyncInputStream, options: GridFSUploadOptions): Observable[ObjectId]

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

    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.

    filename

    the filename for the stream

    source

    the Stream providing the file data

    options

    the GridFSUploadOptions

    returns

    a Observable returning a single element containing the ObjectId of the uploaded file.

40.  def uploadFromStream(filename: String, source: AsyncInputStream): Observable[ObjectId]

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

    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.

    filename

    the filename for the stream

    source

    the Stream providing the file data

    returns

    a Observable returning a single element containing the ObjectId of the uploaded file.

41.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

42.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

43.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

44.  def withChunkSizeBytes(chunkSizeBytes: Int): GridFSBucket

    Create a new GridFSBucket instance with a new chunk size in bytes.

    Create a new GridFSBucket instance with a new chunk size in bytes.

    chunkSizeBytes

    the new chunk size in bytes.

    returns

    a new GridFSBucket instance with the different chunk size in bytes

45.  def withReadConcern(readConcern: ReadConcern): GridFSBucket

    Create a new MongoDatabase instance with a different read concern.

    Create a new MongoDatabase instance with a different read concern.

    readConcern

    the new ReadConcern for the database

    returns

    a new GridFSBucket instance with the different ReadConcern

    Note

    Requires MongoDB 3.2 or greater

    See also

    Read Concern

46.  def withReadPreference(readPreference: ReadPreference): GridFSBucket

    Create a new GridFSBucket instance with a different read preference.

    Create a new GridFSBucket instance with a different read preference.

    readPreference

    the new ReadPreference for the database

    returns

    a new GridFSBucket instance with the different readPreference

47.  def withWriteConcern(writeConcern: WriteConcern): GridFSBucket

    Create a new GridFSBucket instance with a different write concern.

    Create a new GridFSBucket instance with a different write concern.

    writeConcern

    the new WriteConcern for the database

    returns

    a new GridFSBucket instance with the different writeConcern

48.  lazy val writeConcern: WriteConcern

    Get the write concern for the GridFSBucket.

    Get the write concern for the GridFSBucket.

    returns

    the WriteConcern