Packages

case class GridFSBucket(wrapped: com.mongodb.reactivestreams.client.gridfs.GridFSBucket) extends Product with Serializable

Represents a GridFS Bucket

Since

1.2

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GridFSBucket
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GridFSBucket(wrapped: com.mongodb.reactivestreams.client.gridfs.GridFSBucket)

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def delete(clientSession: ClientSession, id: BsonValue): SingleObservable[Void]

    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.

    clientSession

    the client session with which to associate this operation

    id

    the ObjectId of the file to be deleted

    returns

    an empty Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  9. def delete(clientSession: ClientSession, id: ObjectId): SingleObservable[Void]

    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.

    clientSession

    the client session with which to associate this operation

    id

    the ObjectId of the file to be deleted

    returns

    an empty Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  10. def delete(id: BsonValue): SingleObservable[Void]

    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

    an empty Observable that indicates when the operation has completed

  11. def delete(id: ObjectId): SingleObservable[Void]

    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

    an empty Observable that indicates when the operation has completed

  12. def downloadToObservable(clientSession: ClientSession, filename: String, options: GridFSDownloadOptions): GridFSDownloadObservable

    Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.

    Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.

    clientSession

    the client session with which to associate this operation

    filename

    the name of the file to be downloaded

    options

    the download options

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  13. def downloadToObservable(clientSession: ClientSession, filename: String): GridFSDownloadObservable

    Downloads the contents of the latest version of the stored file specified by filename into the Publisher.

    Downloads the contents of the latest version of the stored file specified by filename into the Publisher.

    clientSession

    the client session with which to associate this operation

    filename

    the name of the file to be downloaded

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  14. def downloadToObservable(clientSession: ClientSession, id: BsonValue): GridFSDownloadObservable

    Downloads the contents of the stored file specified by id into the Publisher.

    Downloads the contents of the stored file specified by id into the Publisher.

    clientSession

    the client session with which to associate this operation

    id

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

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  15. def downloadToObservable(clientSession: ClientSession, id: ObjectId): GridFSDownloadObservable

    Downloads the contents of the stored file specified by id into the Publisher.

    Downloads the contents of the stored file specified by id into the Publisher.

    clientSession

    the client session with which to associate this operation

    id

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

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  16. def downloadToObservable(filename: String, options: GridFSDownloadOptions): GridFSDownloadObservable

    Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.

    Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.

    filename

    the name of the file to be downloaded

    options

    the download options

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

  17. def downloadToObservable(filename: String): GridFSDownloadObservable

    Downloads the contents of the stored file specified by filename into the Publisher.

    Downloads the contents of the stored file specified by filename into the Publisher.

    filename

    the name of the file to be downloaded

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

  18. def downloadToObservable(id: BsonValue): GridFSDownloadObservable

    Downloads the contents of the stored file specified by id into the Publisher.

    Downloads the contents of the stored file specified by id into the Publisher.

    id

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

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

  19. def downloadToObservable(id: ObjectId): GridFSDownloadObservable

    Downloads the contents of the stored file specified by id into the Publisher.

    Downloads the contents of the stored file specified by id into the Publisher.

    id

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

    returns

    an Observable with a single element, representing the amount of data written

    Since

    2.8

  20. def drop(clientSession: ClientSession): SingleObservable[Void]

    Drops the data associated with this bucket from the database.

    Drops the data associated with this bucket from the database.

    clientSession

    the client session with which to associate this operation

    returns

    an empty Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  21. def drop(): SingleObservable[Void]

    Drops the data associated with this bucket from the database.

    Drops the data associated with this bucket from the database.

    returns

    an empty Observable that indicates when the operation has completed

  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def find(clientSession: ClientSession, 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"));

    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

  24. def find(clientSession: ClientSession): GridFSFindObservable

    Finds all documents in the files collection.

    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

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

  26. 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

  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. 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

  34. lazy val readPreference: ReadPreference

    Get the read preference for the GridFSBucket.

    Get the read preference for the GridFSBucket.

    returns

    the ReadPreference

  35. def rename(clientSession: ClientSession, id: BsonValue, newFilename: String): SingleObservable[Void]

    Renames the stored file with the specified id.

    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

    an empty Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  36. def rename(clientSession: ClientSession, id: ObjectId, newFilename: String): SingleObservable[Void]

    Renames the stored file with the specified id.

    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

    an empty Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  37. def rename(id: BsonValue, newFilename: String): SingleObservable[Void]

    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

    an empty Observable that indicates when the operation has completed

  38. def rename(id: ObjectId, newFilename: String): SingleObservable[Void]

    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

    an empty Observable that indicates when the operation has completed

  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def uploadFromObservable(clientSession: ClientSession, id: BsonValue, filename: String, source: Observable[ByteBuffer], options: GridFSUploadOptions): GridFSUploadObservable[Void]

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

    Uploads the contents of the given Observable 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.

    clientSession

    the client session with which to associate this operation

    id

    the custom id value of the file

    filename

    the filename for the stream

    source

    the Publisher providing the file data

    options

    the GridFSUploadOptions

    returns

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

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  41. def uploadFromObservable(clientSession: ClientSession, id: BsonValue, filename: String, source: Observable[ByteBuffer]): GridFSUploadObservable[Void]

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

    Uploads the contents of the given Observable 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.

    clientSession

    the client session with which to associate this operation

    id

    the custom id value of the file

    filename

    the filename for the stream

    source

    the Publisher providing the file data

    returns

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

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  42. def uploadFromObservable(clientSession: ClientSession, filename: String, source: Observable[ByteBuffer], options: GridFSUploadOptions): GridFSUploadObservable[ObjectId]

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

    Uploads the contents of the given Observable 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.

    clientSession

    the client session with which to associate this operation

    filename

    the filename for the stream

    source

    the Publisher providing the file data

    options

    the GridFSUploadOptions

    returns

    an Observable with a single element, the ObjectId of the uploaded file.

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  43. def uploadFromObservable(clientSession: ClientSession, filename: String, source: Observable[ByteBuffer]): GridFSUploadObservable[ObjectId]

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

    Uploads the contents of the given Observable 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.

    clientSession

    the client session with which to associate this operation

    filename

    the filename for the stream

    source

    the Publisher providing the file data

    returns

    an Observable with a single element, the ObjectId of the uploaded file.

    Since

    2.8

    Note

    Requires MongoDB 3.6 or greater

  44. def uploadFromObservable(id: BsonValue, filename: String, source: Observable[ByteBuffer], options: GridFSUploadOptions): GridFSUploadObservable[Void]

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

    Uploads the contents of the given Observable 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 Publisher providing the file data

    options

    the GridFSUploadOptions

    returns

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

    Since

    2.8

  45. def uploadFromObservable(id: BsonValue, filename: String, source: Observable[ByteBuffer]): GridFSUploadObservable[Void]

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

    Uploads the contents of the given Observable 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 Publisher providing the file data

    returns

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

    Since

    2.8

  46. def uploadFromObservable(filename: String, source: Observable[ByteBuffer], options: GridFSUploadOptions): GridFSUploadObservable[ObjectId]

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

    Uploads the contents of the given Observable 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 Publisher providing the file data

    options

    the GridFSUploadOptions

    returns

    an Observable with a single element, the ObjectId of the uploaded file.

    Since

    2.8

  47. def uploadFromObservable(filename: String, source: Observable[ByteBuffer]): GridFSUploadObservable[ObjectId]

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

    Uploads the contents of the given Observable 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 Publisher providing the file data

    returns

    an Observable with a single element, the ObjectId of the uploaded file.

    Since

    2.8

  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. 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

  52. 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

  53. 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

  54. 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

  55. lazy val writeConcern: WriteConcern

    Get the write concern for the GridFSBucket.

    Get the write concern for the GridFSBucket.

    returns

    the WriteConcern

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped