GridFS

Instance Constructors

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.

Type Members

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

Value Members

final def !=(arg0: Any): Boolean

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

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

Implicit information
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
def ->[B](y: B): (GridFS[P], B)

Implicit information
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val chunks: GenericCollection[P]

The chunks collection
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def defaultReadPreference: ReadPreference

Annotations
@inline()
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.
def ensuring(cond: (GridFS[P]) ⇒ Boolean, msg: ⇒ Any): GridFS[P]

Implicit information
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
def ensuring(cond: (GridFS[P]) ⇒ Boolean): GridFS[P]

Implicit information
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
def ensuring(cond: Boolean, msg: ⇒ Any): GridFS[P]

Implicit information
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
def ensuring(cond: Boolean): GridFS[P]

Implicit information
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
def enumerate[Id <: P.Value](file: ReadFile[Id])(implicit ctx: 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
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
val files: GenericCollection[P]

The files collection
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def find[S, T <: ReadFile[_]](selector: S)(implicit sWriter: P.Writer[S], readFileReader: P.Reader[T], ctx: 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
def formatted(fmtstr: String): String

Implicit information
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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
val pack: collections.GenericCollection.pack.type
def readToOutputStream[Id <: P.Value](file: ReadFile[Id], out: OutputStream)(implicit ctx: ExecutionContext, idProducer: IdProducer[Id]): Future[Unit]

Reads the given file and writes its contents to the given OutputStream
def remove[Id <: P.Value](id: Id)(implicit ctx: 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.
id
The file id to remove from this store.
def remove[Id <: P.Value](file: BasicMetadata[Id])(implicit ctx: 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.
def save[Id <: P.Value](enumerator: Enumerator[Array[Byte]], file: FileToSave[pack.type, Id], chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ctx: 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].
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 writeFromInputStream[Id <: P.Value](file: FileToSave[pack.type, Id], input: InputStream, chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ctx: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): Future[ReadFile[Id]]

Writes the data provided by the given InputStream to the given file.
def →[B](y: B): (GridFS[P], B)

Implicit information
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

def iteratee[Id <: P.Value](file: FileToSave[pack.type, Id], chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ctx: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): 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.

Annotations
@deprecated
Deprecated
(Since version 0.12.0) Will be moved to the separate iteratee module

Related Docs: object GridFS | package gridfs

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

Instance Constructors

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

Type Members

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (GridFS[P], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val chunks: GenericCollection[P]

def clone(): AnyRef

def defaultReadPreference: ReadPreference

def ensureIndex()(implicit ctx: ExecutionContext): Future[Boolean]

def ensuring(cond: (GridFS[P]) ⇒ Boolean, msg: ⇒ Any): GridFS[P]

def ensuring(cond: (GridFS[P]) ⇒ Boolean): GridFS[P]

def ensuring(cond: Boolean, msg: ⇒ Any): GridFS[P]

def ensuring(cond: Boolean): GridFS[P]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val files: GenericCollection[P]

def finalize(): Unit

def find[S, T <: ReadFile[_]](selector: S)(implicit sWriter: P.Writer[S], readFileReader: P.Reader[T], ctx: ExecutionContext, cp: CursorProducer[T]): ProducedCursor

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val pack: collections.GenericCollection.pack.type

def readToOutputStream[Id <: P.Value](file: ReadFile[Id], out: OutputStream)(implicit ctx: ExecutionContext, idProducer: IdProducer[Id]): Future[Unit]

def remove[Id <: P.Value](id: Id)(implicit ctx: ExecutionContext, idProducer: IdProducer[Id]): Future[WriteResult]

def remove[Id <: P.Value](file: BasicMetadata[Id])(implicit ctx: ExecutionContext, idProducer: IdProducer[Id]): Future[WriteResult]

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

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def writeFromInputStream[Id <: P.Value](file: FileToSave[pack.type, Id], input: InputStream, chunkSize: Int = 262144)(implicit readFileReader: P.Reader[ReadFile[Id]], ctx: ExecutionContext, idProducer: IdProducer[Id], docWriter: BSONDocumentWriter[P.Document]): Future[ReadFile[Id]]

def →[B](y: B): (GridFS[P], B)

Deprecated Value Members

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

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