MONGOGRIDFS.STOREBYTES(3) 1 MONGOGRIDFS.STOREBYTES(3)MongoGridFS::storeBytes - Stores a string of bytes in the database
SYNOPSIS
public mixed MongoGridFS::storeBytes (string $bytes, [array $metadata = array()], [array $options = array()])
DESCRIPTION PARAMETERS
o $bytes
- String of bytes to store.
o $metadata
- Other metadata fields to include in the file document.
Note
These fields may also overwrite those that would be created automatically by the driver, as described in the MongoDB core
documentation for the files collection. Some practical use cases for this behavior would be to specify a custom chunkSize or
_id for the file.
o $options
- An array of options for the insert operations executed against the chunks and files collections. See MongoCollection.insert(3)
for documentation on these these options.
RETURN VALUES
Returns the _id of the saved file document. This will be a generated MongoId unless an _id was explicitly specified in the $metadata param-
eter.
ERRORS /EXCEPTIONS
Throws MongoGridFSException if there is an error inserting into the chunks or files collections.
EXAMPLES
Example #1
MongoGridFS.storeBytes(3) with additional metadata
<?php
$m = new MongoClient();
$gridfs = $m->selectDB('test')->getGridFS();
$bytes = 'abcdefghijklmnopqrstuvwxyz';
$id = $gridfs->storeBytes($bytes, array('_id' => 'alphabet'));
$gridfsFile = $gridfs->get($id);
var_dump($gridfsFile->file);
?>
The above example will output something similar to:
array(7) {
["_id"]=>
string(8) "alphabet"
["uploadDate"]=>
object(MongoDate)#7(0) {
}
["length"]=>
int(26)
["chunkSize"]=>
int(262144)
["md5"]=>
string(32) "c3fcd3d76192e4007dfb496cca67e13b"
}
SEE ALSO MongoGridFS.put(3), MongoGridFS.storeFile(3), MongoGridFS.storeUpload(3), MongoDB core docs on GridFS.
PHP Documentation Group MONGOGRIDFS.STOREBYTES(3)
Check Out this Related Man Page
MONGODB(3) 1 MONGODB(3)The MongoDB classINTRODUCTION
Instances of this class are used to interact with a database. To get a database:
Example #1
Selecting a database
<?php
$m = new MongoClient(); // connect
$db = $m->selectDB("example");
?>
Database names can use almost any character in the ASCII range. However, they cannot contain " ", "." or be the empty string. The name
"system" is also reserved.
A few unusual, but valid, database names: "null", "[x,y]", "3", """, "/".
Unlike collection names, database names may contain "$".
CLASS SYNOPSIS
MongoDB
MongoDB
Constants
o const int$MongoDB::PROFILING_OFF0
o const int$MongoDB::PROFILING_SLOW1
o const int$MongoDB::PROFILING_ON2
Fields
o public integer$w1
o public integer$wtimeout10000
Methods
o public array MongoDB::authenticate (string $username, string $password)
o public array MongoDB::command (array $command, [array $options = array()], [string &$hash])
o public MongoDB::__construct (MongoClient $conn, string $name)
o public MongoCollection MongoDB::createCollection (string $name, [array $options])
o public array MongoDB::createDBRef (string $collection, mixed $document_or_id)
o public array MongoDB::drop (void )
o public array MongoDB::dropCollection (mixed $coll)
o public array MongoDB::execute (mixed $code, [array $args = array()])
o public bool MongoDB::forceError (void )
o public MongoCollection MongoDB::__get (string $name)
o public array MongoDB::getCollectionInfo ([array $options = array()])
o public array MongoDB::getCollectionNames ([array $options = array()])
o public array MongoDB::getDBRef (array $ref)
o public MongoGridFS MongoDB::getGridFS ([string $prefix = "fs"])
o public int MongoDB::getProfilingLevel (void )
o public array MongoDB::getReadPreference (void )
o public bool MongoDB::getSlaveOkay (void )
o public array MongoDB::getWriteConcern (void )
o public array MongoDB::lastError (void )
o public array MongoDB::listCollections ([array $options = array()])
o public array MongoDB::prevError (void )
o public array MongoDB::repair FALSE FALSE ([bool $preserve_cloned_files], [bool $backup_original_files])
o public array MongoDB::resetError (void )
o public MongoCollection MongoDB::selectCollection (string $name)
o public int MongoDB::setProfilingLevel (int $level)
o public bool MongoDB::setReadPreference (string $read_preference, [array $tags])
o public bool MongoDB::setSlaveOkay ([bool $ok = true])
o public bool MongoDB::setWriteConcern (mixed $w, [int $wtimeout])
o public string MongoDB::__toString (void )
PREDEFINED CONSTANTS MONGODB LOG LEVELS
o MongoDB::PROFILING_OFF - 0 - Profiling is off.
o MongoDB::PROFILING_SLOW - 1 - Profiling is on for slow operations (>100 ms).
o MongoDB::PROFILING_ON - 2 - Profiling is on for all operations.
FIELDS
o $w
-1 - The number of servers to replicate a change to before returning success. Inherited by instances of MongoCollection derived
from this. w functionality is only available in version 1.5.1+ of the MongoDB server and 1.0.8+ of the driver. w is used when-
ever you need to adjust the acknowledgement level (MongoCollection.insert(3), MongoCollection.update(3), MongoCollec-
tion.remove(3), MongoCollection.save(3), and MongoCollection.ensureIndex(3) all support this option). With the default value (1),
an acknowledged operation will return once the database server has the operation. If the server goes down before the operation has
been replicated to a secondary, it is possible to lose the operation forever. Thus, you can specify w to be higher than one and
guarantee that at least one secondary has the operation before it is considered successful. For example, if w is 2, the primary
and one secondary must have a record of the operation or the driver will throw a MongoCursorException. It is tempting to set w to
the total number of secondaries + primary, but then if one secondary is down the operation will fail and an exception will be
thrown, so usually w=2 is safest (primary and one secondary).
o $wtimeout
-10000 - The number of milliseconds to wait for MongoDB::$w replications to take place. Inherited by instances of MongoCollection
derived from this. w functionality is only available in version 1.5.1+ of the MongoDB server and 1.0.8+ of the driver. Unless
wtimeout is set, the server waits forever for replicating to w servers to finish. The driver defaults to waiting for 10 seconds,
you can change this value to alter its behavior.
SEE ALSO
MongoDB core docs on databases.
PHP Documentation Group MONGODB(3)