reactivemongo.api.gridfs

GridFS

class GridFS[Structure, Reader[_], Writer[_]] extends AnyRef

A GridFS store.

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GridFS
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    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.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (GridFS[Structure, Reader, Writer], B)

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to ArrowAssoc[GridFS[Structure, Reader, Writer]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def chunks[C <: Collection](implicit collProducer: CollectionProducer[C] = producer): C

    The chunks collection

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensureIndex()(implicit ctx: ExecutionContext): Future[Boolean]

    Creates the needed index on the chunks collection, if none.

    Creates the needed index on the chunks collection, if none.

    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[Structure, Reader, Writer]) ⇒ Boolean, msg: ⇒ Any): GridFS[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to Ensuring[GridFS[Structure, Reader, Writer]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (GridFS[Structure, Reader, Writer]) ⇒ Boolean): GridFS[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to Ensuring[GridFS[Structure, Reader, Writer]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): GridFS[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to Ensuring[GridFS[Structure, Reader, Writer]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): GridFS[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to Ensuring[GridFS[Structure, Reader, Writer]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def enumerate(file: ReadFile[_ <: BSONValue])(implicit ctx: ExecutionContext): Enumerator[Array[Byte]]

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

  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  19. def files[C <: Collection](implicit collProducer: CollectionProducer[C] = producer): C

    The files collection

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def find[S, T <: ReadFile[_]](selector: S)(implicit sWriter: Writer[S], readFileReader: Reader[T], ctx: ExecutionContext): Cursor[T]

    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

  22. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. def iteratee[Id <: BSONValue](file: FileToSave[Id], chunkSize: Int = 262144)(implicit readFileReader: Reader[ReadFile[Id]], ctx: ExecutionContext): Iteratee[Array[Byte], Future[ReadFile[Id]]]

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

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

    Id

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

    file

    Metadata of the file to store.

    chunkSize

    Size of the chunks. Defaults to 256kB.

    returns

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

  27. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  30. def readToOutputStream(file: ReadFile[_ <: BSONValue], out: OutputStream)(implicit ctx: ExecutionContext): Future[Unit]

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

  31. def remove(id: BSONValue)(implicit ctx: ExecutionContext): Future[LastError]

    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.

  32. def remove[Id <: BSONValue](file: BasicMetadata[Id])(implicit ctx: ExecutionContext): Future[LastError]

    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.

  33. def save[Id <: BSONValue](enumerator: Enumerator[Array[Byte]], file: FileToSave[Id], chunkSize: Int = 262144)(implicit readFileReader: Reader[ReadFile[Id]], ctx: ExecutionContext): 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].

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

    Definition Classes
    AnyRef
  35. def toString(): String

    Definition Classes
    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( ... )
  39. def writeFromInputStream[Id <: BSONValue](file: FileToSave[Id], input: InputStream, chunkSize: Int = 262144)(implicit readFileReader: Reader[ReadFile[Id]], ctx: ExecutionContext): Future[ReadFile[Id]]

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

  40. def [B](y: B): (GridFS[Structure, Reader, Writer], B)

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to ArrowAssoc[GridFS[Structure, Reader, Writer]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gridFS: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gridFS: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GridFS[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to ArrowAssoc[GridFS[Structure, Reader, Writer]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gridFS: ArrowAssoc[GridFS[Structure, Reader, Writer]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: GridFS[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to Ensuring[GridFS[Structure, Reader, Writer]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gridFS: Ensuring[GridFS[Structure, Reader, Writer]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GridFS[Structure, Reader, Writer] to StringAdd

Inherited by implicit conversion any2stringfmt from GridFS[Structure, Reader, Writer] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from GridFS[Structure, Reader, Writer] to ArrowAssoc[GridFS[Structure, Reader, Writer]]

Inherited by implicit conversion any2Ensuring from GridFS[Structure, Reader, Writer] to Ensuring[GridFS[Structure, Reader, Writer]]

Ungrouped