reactivemongo.api.gridfs

GridFS

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

A GridFS store.

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
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: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Implicit information
    This member is added by an implicit conversion from GridFS[Structure, Reader, Writer] to any2stringadd[GridFS[Structure, Reader, Writer]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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 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[C <: Collection](implicit collProducer: CollectionProducer[C] = producer): C

    The chunks collection

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. 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.

  10. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. 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.

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

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

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

    The files collection

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. 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

  20. def formatted(fmtstr: String): String

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

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

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

    Definition Classes
    Any
  24. 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.

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

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

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

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

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

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

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

  31. 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].

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

    Definition Classes
    AnyRef
  33. def toString(): String

    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. 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.

  38. 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 ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped