sdbclient::sdbCollectionSpace Class Reference

Database operation interfaces of collection space. More...

#include <client.hpp>

Public Member Functions
	sdbCollectionSpace ()
	Default constructor.
	~sdbCollectionSpace ()
	Destructor.
INT32	getCollection (const CHAR *pCollectionName, _sdbCollection **collection)
INT32	getCollection (const CHAR *pCollectionName, sdbCollection &collection)
	Get the named collection.
INT32	createCollection (const CHAR *pCollection, const bson::BSONObj &options, _sdbCollection **collection)
INT32	createCollection (const CHAR *pCollection, const bson::BSONObj &options, sdbCollection &collection)
	Create the specified collection in current collection space with options.
INT32	createCollection (const CHAR *pCollection, _sdbCollection **collection)
INT32	createCollection (const CHAR *pCollection, sdbCollection &collection)
	Create the specified collection in current collection space without sharding key and default ReplSize.
INT32	dropCollection (const CHAR *pCollection)
	Drop the specified collection in current collection space.
INT32	create ()
	Create a new collection space.
INT32	drop ()
	Drop current collection space.
const CHAR *	getCSName ()
	Get the current collection space name.

Public Attributes
_sdbCollectionSpace *	pCollectionSpace

Detailed Description

Database operation interfaces of collection space.

Member Function Documentation

INT32 sdbclient::sdbCollectionSpace::create ( )

inline

Create a new collection space.

Deprecated:

This function will be deprecated in SequoiaDB2.x, use sdb::createCollectionSpace instead of it.

Return values

SDB_OK	Operation Success.
Others	Operation Fail

INT32 sdbclient::sdbCollectionSpace::createCollection ( const CHAR *  pCollection, const bson::BSONObj &  options, sdbCollection &  collection  )

inline

Create the specified collection in current collection space with options.

Parameters

[in]	pCollection	The collection name
[in]	options	The options for creating collection, including "ShardingKey", "ReplSize", "IsMainCL" and "Compressed" informations, no options, if null
[out]	collection	The return collection object .

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbCollectionSpace::createCollection ( const CHAR *  pCollection, sdbCollection &  collection  )

inline

Create the specified collection in current collection space without sharding key and default ReplSize.

Parameters

[in]	pCollection	The collection name.
[out]	collection	The return collection object.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbCollectionSpace::drop ( )

inline

Drop current collection space.

Deprecated:

This function will be deprecated in SequoiaDB2.x, use sdb::dropCollectionSpace instead of it.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbCollectionSpace::dropCollection ( const CHAR *  pCollection )

inline

Drop the specified collection in current collection space.

Parameters

[in]

pCollection

The collection name.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbCollectionSpace::getCollection ( const CHAR *  pCollectionName, sdbCollection &  collection  )

inline

Get the named collection.

Parameters

[in]	pCollectionName	The full name of the collection.
[out]	collection	The return collection object.

Return values

SDB_OK	Operation Success
Others	Operation Fail

const CHAR * sdbclient::sdbCollectionSpace::getCSName ( )

inline

Get the current collection space name.

Returns

The name of current collection space.

Member Data Documentation

sdbclient::sdbCollectionSpace::pCollectionSpace

A pointer of virtual base class _sdbCollectionSpace

Class sdbCollectionSpace is a shell for _sdbCollectionSpace. We use pCollectionSpace to call the methods in class _sdbCollectionSpace.

---

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

• client.hpp