mongocxx::options::gridfs::bucket Class Reference

Class representing the optional arguments to a MongoDB GridFS bucket creation operation. More...

#include <bucket.hpp>

Public Member Functions
bucket &	bucket_name (std::string bucket_name)
	Sets the name of the bucket. More...
const stdx::optional< std::string > &	bucket_name () const
	Gets the name of the bucket. More...
bucket &	chunk_size_bytes (std::int32_t chunk_size_bytes)
	Sets the size of the chunks in the bucket. More...
const stdx::optional< std::int32_t > &	chunk_size_bytes () const
	Gets the size of the chunks in the bucket. More...
bucket &	read_concern (class read_concern read_concern)
	Sets the read concern to be used when reading from the bucket. More...
const stdx::optional< class read_concern > &	read_concern () const
	Gets the read concern of the bucket. More...
bucket &	read_preference (class read_preference read_preference)
	Sets the read preference to be used when reading from the GridFS bucket. More...
const stdx::optional< class read_preference > &	read_preference () const
	Gets the read preference of the bucket. More...
bucket &	write_concern (class write_concern write_concern)
	Sets the write concern to be used when writing to the GridFS bucket. More...
const stdx::optional< class write_concern > &	write_concern () const
	Gets the write concern of the bucket. More...

Detailed Description

Class representing the optional arguments to a MongoDB GridFS bucket creation operation.

Member Function Documentation

bucket_name() [1/2]

const stdx::optional<std::string>& mongocxx::options::gridfs::bucket::bucket_name

(

)

const

Gets the name of the bucket.

Returns

The name of the bucket.

bucket_name() [2/2]

bucket& mongocxx::options::gridfs::bucket::bucket_name

(

std::string

bucket_name

)

Sets the name of the bucket.

Defaults to 'fs'.

Parameters

bucket_name

The name of the bucket.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

chunk_size_bytes() [1/2]

const stdx::optional<std::int32_t>& mongocxx::options::gridfs::bucket::chunk_size_bytes

(

)

const

Gets the size of the chunks in the bucket.

Returns

The size of the chunks in the bucket in bytes.

chunk_size_bytes() [2/2]

bucket& mongocxx::options::gridfs::bucket::chunk_size_bytes

(

std::int32_t

chunk_size_bytes

)

Sets the size of the chunks in the bucket.

This will be used as the chunk size for files uploaded through the bucket without a custom size specified. Defaults to 255KB (255 * 1024).

Parameters

chunk_size_bytes

The size of the chunks in bytes.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

read_concern() [1/2]

const stdx::optional<class read_concern>& mongocxx::options::gridfs::bucket::read_concern

(

)

const

Gets the read concern of the bucket.

Returns

The read concern of the bucket.

read_concern() [2/2]

bucket& mongocxx::options::gridfs::bucket::read_concern

(

class read_concern

read_concern

)

Sets the read concern to be used when reading from the bucket.

Defaults to the read concern of the database containing the bucket's collections.

Parameters

read_concern

The read concern of the bucket.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

read_preference() [1/2]

const stdx::optional<class read_preference>& mongocxx::options::gridfs::bucket::read_preference

(

)

const

Gets the read preference of the bucket.

Returns

The read preference of the bucket.

read_preference() [2/2]

bucket& mongocxx::options::gridfs::bucket::read_preference

(

class read_preference

read_preference

)

Sets the read preference to be used when reading from the GridFS bucket.

Defaults to the read preference of the database containing the bucket's collections.

Note

Because many GridFS operations require multiple independent reads from separate collections, use with secondaries is strongly discouraged because reads could go to different secondaries, resulting in inconsistent data if all file and chunk documents have not replicated to all secondaries.

Parameters

read_preference

The read preference of the GridFS bucket.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

write_concern() [1/2]

const stdx::optional<class write_concern>& mongocxx::options::gridfs::bucket::write_concern

(

)

const

Gets the write concern of the bucket.

Returns

The write concern of the bucket.

write_concern() [2/2]

bucket& mongocxx::options::gridfs::bucket::write_concern

(

class write_concern

write_concern

)

Sets the write concern to be used when writing to the GridFS bucket.

Defaults to the write concern of the database containing the bucket's collections.

Parameters

write_concern

The write concern of the GridFS bucket.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

---

The documentation for this class was generated from the following file:

• src/mongocxx/options/gridfs/bucket.hpp