case class GridFSBucket(wrapped: com.mongodb.async.client.gridfs.GridFSBucket) extends Product with Serializable
Represents a GridFS Bucket
- Since
1.2
- Alphabetic
- By Inheritance
- GridFSBucket
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new GridFSBucket(wrapped: com.mongodb.async.client.gridfs.GridFSBucket)
Value Members
-
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.
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
- @throws( ... )
-
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
-
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
-
def
downloadToStream(filename: String, destination: AsyncOutputStream, options: GridFSDownloadOptions): Observable[Long]
Downloads the contents of the stored file specified by
filename
and by the revision inoptions
and writes the contents to thedestination
Stream.Downloads the contents of the stored file specified by
filename
and by the revision inoptions
and writes the contents to thedestination
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 thedestination
Stream.Downloads the contents of the latest version of the stored file specified by
filename
and writes the contents to thedestination
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 thedestination
AsyncOutputStream.Downloads the contents of the stored file specified by
id
and writes the contents to thedestination
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 thedestination
AsyncOutputStream.Downloads the contents of the stored file specified by
id
and writes the contents to thedestination
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(): 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
-
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(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
-
def
find(): GridFSFindObservable
Finds all documents in the files collection.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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 inoptions
.Opens a Stream from which the application can read the contents of the stored file specified by
filename
and the revision inoptions
.- 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
.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
.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
.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(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.
-
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.
-
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.
-
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.
-
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
-
lazy val
readPreference: ReadPreference
Get the read preference for the GridFSBucket.
Get the read preference for the GridFSBucket.
- returns
the ReadPreference
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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 forfilename
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
-
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 forfilename
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
-
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 forfilename
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.
-
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 forfilename
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.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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
-
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
-
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
-
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
-
lazy val
writeConcern: WriteConcern
Get the write concern for the GridFSBucket.
Get the write concern for the GridFSBucket.
- returns
the WriteConcern
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: