Packages

abstract class GridFS[P <: SerializationPack with Singleton] extends AnyRef

A GridFS store.

Self Type
GridFS[P]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GridFS
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GridFS(db: DB with DBMetaCommands, prefix: String = "fs")(implicit producer: GenericCollectionProducer[P, GenericCollection[P]] = BSONCollectionProducer)

    db

    The database where this store is located.

    prefix

    The prefix of this store. The files and chunks collections will be actually named ${prefix}.files and ${prefix}.chunks.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Internal: will be made private

Type Members

  1. type ReadFile[Id <: P.Value] = gridfs.ReadFile[P, Id]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from GridFS[P] to any2stringadd[GridFS[P]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GridFS[P], B)
    Implicit
    This member is added by an implicit conversion from GridFS[P] to ArrowAssoc[GridFS[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def chunks(file: ReadFile[P.Value], readPreference: ReadPreference = defaultReadPreference)(implicit ec: ExecutionContext, cp: CursorProducer[Array[Byte]]): ProducedCursor

    Returns a cursor for the chunks of the specified file.

    Returns a cursor for the chunks of the specified file. The cursor walks the chunks orderly.

    Annotations
    @silent( ... )
  8. lazy val chunks: GenericCollection[pack.type]

    The chunks collection

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def defaultReadPreference: ReadPreference
    Annotations
    @inline()
  11. def ensureIndex()(implicit ec: ExecutionContext): Future[Boolean]

    Creates the needed indexes on the GridFS collections (chunks and files).

    Creates the needed indexes on the GridFS collections (chunks and files).

    Please note that you should really consider reading http://www.mongodb.org/display/DOCS/Indexes before doing this, especially in production.

    returns

    A future containing true if the index was created, false if it already exists.

  12. def ensuring(cond: (GridFS[P]) ⇒ Boolean, msg: ⇒ Any): GridFS[P]
    Implicit
    This member is added by an implicit conversion from GridFS[P] to Ensuring[GridFS[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (GridFS[P]) ⇒ Boolean): GridFS[P]
    Implicit
    This member is added by an implicit conversion from GridFS[P] to Ensuring[GridFS[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): GridFS[P]
    Implicit
    This member is added by an implicit conversion from GridFS[P] to Ensuring[GridFS[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): GridFS[P]
    Implicit
    This member is added by an implicit conversion from GridFS[P] to Ensuring[GridFS[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def exists(implicit ec: ExecutionContext): Future[Boolean]

    Returns whether the data related to this GridFS instance exists on the database.

  19. def fileToSave(_filename: Option[String] = None, _contentType: Option[String] = None, _uploadDate: Option[Long] = None, _metadata: P.Document = document(Seq.empty)): FileToSave[pack.type, P.Value]

    Prepare the information to save a file.

    Prepare the information to save a file. The unique ID is automatically generated.

  20. lazy val files: GenericCollection[pack.type]

    The files collection

  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def find(selector: P.Document)(implicit ec: ExecutionContext, cp: CursorProducer[ReadFile[P.Value]]): ProducedCursor
    Annotations
    @silent( ".*ec\\ .*is\\ never\\ used.*" ) @inline()
  23. def find[S, T <: ReadFile[_]](selector: S)(implicit sWriter: P.Writer[S], readFileReader: P.Reader[T], ec: ExecutionContext, cp: CursorProducer[T]): ProducedCursor

    Finds the files matching the given selector.

    Finds the files matching the given selector.

    S

    The type of the selector document. An implicit Writer[S] must be in the scope.

    selector

    The document to select the files to return

    Annotations
    @silent( ".*ec\\ .*is\\ never\\ used.*" )
  24. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GridFS[P] to StringFormat[GridFS[P]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def readToOutputStream[Id <: P.Value](file: ReadFile[Id], out: OutputStream)(implicit ec: ExecutionContext): Future[Unit]

    Reads the given file and writes its contents to the given OutputStream

    Reads the given file and writes its contents to the given OutputStream

    Annotations
    @silent( ".*(IdProducer|enumerate).*" )
  32. def remove(id: P.Value)(implicit ec: ExecutionContext): Future[WriteResult]

    Removes a file from this store.

    Removes a file from this store. Note that if the file does not actually exist, the returned future will not be hold an error.

    id

    the file id to remove from this store

    Annotations
    @inline()
  33. def remove[Id <: P.Value](file: BasicMetadata[Id])(implicit ec: ExecutionContext, idProducer: IdProducer[Id]): Future[WriteResult]

    Removes a file from this store.

    Removes a file from this store. Note that if the file does not actually exist, the returned future will not be hold an error.

    file

    the file entry to remove from this store

  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    GridFS → AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  39. def writeFromInputStream[Id <: P.Value](file: FileToSave[pack.type, Id], input: InputStream, chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ec: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): Future[ReadFile[Id]]

    Writes the data provided by the given InputStream to the given file.

    Writes the data provided by the given InputStream to the given file.

    Annotations
    @silent( ".*(idProducer|save).*" )
  40. def →[B](y: B): (GridFS[P], B)
    Implicit
    This member is added by an implicit conversion from GridFS[P] to ArrowAssoc[GridFS[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def enumerate[Id <: P.Value](file: ReadFile[Id])(implicit ec: ExecutionContext, idProducer: IdProducer[Id]): Enumerator[Array[Byte]]

    Produces an enumerator of chunks of bytes from the chunks collection matching the given file metadata.

    Produces an enumerator of chunks of bytes from the chunks collection matching the given file metadata.

    file

    the file to be read

    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0) Will be moved to reactivemongo.play.iteratees.GridFS

  2. def iteratee[Id <: P.Value](file: FileToSave[pack.type, Id], chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ec: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): Iteratee[Array[Byte], Future[ReadFile[Id]]]

    Returns an Iteratee that will consume data to put into a GridFS store.

    Returns an Iteratee that will consume data to put into a GridFS store.

    Id

    the type of the id of this file (generally BSONObjectID or BSONValue).

    file

    the metadata of the file to store.

    chunkSize

    Size of the chunks. Defaults to 256kB.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use iterateeWithMD5

  3. def iterateeWithMD5[Id <: P.Value](file: FileToSave[pack.type, Id], chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ec: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): Iteratee[Array[Byte], Future[ReadFile[Id]]]

    Returns an Iteratee that will consume data to put into a GridFS store, computing the MD5.

    Returns an Iteratee that will consume data to put into a GridFS store, computing the MD5.

    Id

    the type of the id of this file (generally BSONObjectID or BSONValue).

    file

    the metadata of the file to store.

    chunkSize

    Size of the chunks. Defaults to 256kB.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Will be moved to reactivemongo.play.iteratees.GridFS

  4. lazy val pack: P
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Internal: will be made private

  5. def save[Id <: P.Value](enumerator: Enumerator[Array[Byte]], file: FileToSave[pack.type, Id], chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ec: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): Future[ReadFile[Id]]

    Saves the content provided by the given enumerator with the given metadata.

    Saves the content provided by the given enumerator with the given metadata.

    enumerator

    Producer of content.

    file

    Metadata of the file to store.

    chunkSize

    Size of the chunks. Defaults to 256kB.

    returns

    A future of a ReadFile[Id].

    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0) Will be moved to reactivemongo.play.iteratees.GridFS

  6. def saveWithMD5[Id <: P.Value](enumerator: Enumerator[Array[Byte]], file: FileToSave[pack.type, Id], chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ec: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): Future[ReadFile[Id]]

    Saves the content provided by the given enumerator with the given metadata, with the MD5 computed.

    Saves the content provided by the given enumerator with the given metadata, with the MD5 computed.

    enumerator

    Producer of content.

    file

    Metadata of the file to store.

    chunkSize

    Size of the chunks. Defaults to 256kB.

    returns

    A future of a ReadFile[Id].

    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0) Will be moved to reactivemongo.play.iteratees.GridFS

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GridFS[P] to any2stringadd[GridFS[P]]

Inherited by implicit conversion StringFormat from GridFS[P] to StringFormat[GridFS[P]]

Inherited by implicit conversion Ensuring from GridFS[P] to Ensuring[GridFS[P]]

Inherited by implicit conversion ArrowAssoc from GridFS[P] to ArrowAssoc[GridFS[P]]

Ungrouped