mongo::GridFS Class Reference

#include <gridfs.h>

Public Member Functions
GridFile	findFile (const string &fileName)
GridFile	findFile (BSONObj query)
	GridFS (DBClientBase &client, const string &dbName, const string &prefix="fs")
auto_ptr< DBClientCursor >	list (BSONObj query)
auto_ptr< DBClientCursor >	list ()
void	removeFile (const string &fileName)
void	setChunkSize (unsigned int size)
BSONObj	storeFile (const char *data, size_t length, const string &remoteName, const string &contentType="")
BSONObj	storeFile (const string &fileName, const string &remoteName="", const string &contentType="")
	~GridFS ()
Private Member Functions
BSONObj	insertFile (const string &name, const OID &id, gridfs_offset length, const string &contentType)
Private Attributes
unsigned int	_chunkSize
string	_chunksNS
DBClientBase &	_client
string	_dbName
string	_filesNS
string	_prefix
Friends
class	GridFile

Detailed Description

GridFS is for storing large file-style objects in MongoDB.

Definition at line 55 of file gridfs.h.

Parameters:

	client	- db connection
	dbName	- root database name
	prefix	- if you want your data somewhere besides <dbname>.fs

mongo::GridFS::~GridFS ( )

GridFile mongo::GridFS::findFile ( const string & fileName )

equiv to findFile( { filename : filename } )

GridFile mongo::GridFS::findFile ( BSONObj query )

returns a file object matching the query

BSONObj mongo::GridFS::insertFile	(	const string &	name,
		const OID &	id,
		gridfs_offset	length,
		const string &	contentType
	)			`[private]`

auto_ptr<DBClientCursor> mongo::GridFS::list ( BSONObj query )

convenience method to get all the files with a filter

auto_ptr<DBClientCursor> mongo::GridFS::list ( )

convenience method to get all the files

void mongo::GridFS::removeFile ( const string & fileName )

removes file referenced by fileName from the db

Parameters:

fileName

filename (in GridFS) of the file to remove

void mongo::GridFS::setChunkSize ( unsigned int size )

Parameters:

BSONObj mongo::GridFS::storeFile	(	const char *	data,
		size_t	length,
		const string &	remoteName,
		const string &	contentType = `""`
	)

puts the file represented by data into the db

Parameters:

	data	pointer to buffer to store in GridFS
	length	length of buffer
	remoteName	optional filename to use for file stored in GridFS (default is to use fileName parameter)
	contentType	optional MIME type for this object. (default is to omit)

BSONObj mongo::GridFS::storeFile	(	const string &	fileName,
		const string &	remoteName = `""`,
		const string &	contentType = `""`
	)

puts the file reference by fileName into the db

Parameters:

	fileName	local filename relative to process
	remoteName	optional filename to use for file stored in GridFS (default is to use fileName parameter)
	contentType	optional MIME type for this object. (default is to omit)