SequoiaCL Class Reference

Public Member Functions
	drop ()
	alter (array|string $options)
	split (string $sourceGroup, string $targetGroup, integer|double $percent)
	split (string $sourceGroup, string $targetGroup, array|string $condition, array|string $endCondition=null)
	splitAsync (string $sourceGroup, string $targetGroup, integer|double $percent)
	splitAsync (string $sourceGroup, string $targetGroup, array|string $condition, array|string $endCondition=null)
	getFullName ()
	getCSName ()
	getName ()
	attachCL (string $subClFullName, array|string $options)
	detachCL (string $subClFullName)
	insert (array|string $record)
	bulkInsert (array|string $records, integer $flags=0)
	remove (array|string $condition=null, array|string $hint=null)
	update (array|string $rule, array|string $condition=null, array|string $hint=null)
	upsert (array|string $rule, array|string $condition=null, array|string $hint=null)
	find (array|string $condition=null, array|string $selector=null, array|string $orderBy=null, array|string $hint=null, integer $numToSkip=0, integer $numToReturn=-1, integer $flag=0)
	findAndUpdate (array|string $rule, array|string $condition=null, array|string $selector=null, array|string $orderBy=null, array|string $hint=null, integer $numToSkip=0, integer $numToReturn=-1, integer $flag=0, boolean $returnNew=false)
	findAndRemove (array|string $condition=null, array|string $selector=null, array|string $orderBy=null, array|string $hint=null, integer $numToSkip=0, integer $numToReturn=-1, integer $flag=0)
	explain (array|string $condition=null, array|string $selector=null, array|string $orderBy=null, array|string $hint=null, integer $numToSkip=0, integer $numToReturn=-1, integer $flag=0, array|string $options=null)
	count (array|string $condition=null, array|string $hint=null)
	aggregate (array|string $aggrObj)
	createIndex (array|string $indexDef, string $indexName, boolean $isUnique=false, boolean $isEnforced=false, integer $sortBufferSize=64)
	dropIndex (string $indexName)
	getIndex (string $indexName="")
	createIdIndex (array|string $args=null)
	dropIdIndex ()
	openLob (string $oid, integer $mode)
	removeLob (string $oid)
	listLob (array|string $condition=null, array|string $selector=null, array|string $orderBy=null, array|string $hint=null)
	listLobPieces (array|string $condition=null, array|string $selector=null, array|string $orderBy=null, array|string $hint=null)
	getCollectionName ()
	deleteIndex ()

Public Attributes
const	SDB_FLG_INSERT_CONTONDUP 0x00000001
const	SDB_FLG_FIND_FORCE_HINT 0x00000080
const	SDB_FLG_FIND_PARALLED 0x00000100
const	SDB_FLG_FIND_WITH_RETURNDATA 0x00000200
const	SDB_FLG_QUERY_FORCE_HINT 0x00000080
const	SDB_FLG_QUERY_PARALLED 0x00000100
const	SDB_FLG_QUERY_WITH_RETURNDATA 0x00000200
const	SDB_LOB_CREATEONLY 0x00000001
const	SDB_LOB_READ 0x00000004

Detailed Description

SequoiaCL Class. To get this Class object must be call SequoiaDB::getCL or SequoiaCS::selectCL or SequoiaCS::getCL.

Class for create an object of the collection

Member Function Documentation

SequoiaCL::aggregate

(

array|string

$aggrObj

)

Execute aggregate operation in specified collection.

Parameters

$aggrObj

an array or the string argument. Aggregation parameter, if the input string or an array, you can enter only one parameter, such as the string: '{ "$project": { "field": 1 } }' an associative array: array( '$project' => array ( 'field' => 1 ) ) if the input array, you can enter multiple parameters, such as: array ( '{ "$project": { "field1": 1, "field2": 2 } }', '{ "$project": { "field1": 1 } }' ) or array ( array ( '$project' => array ( 'field1' => 1, 'field2' => 2 ) ), array ( '$project' => array ( 'field1' => 1 ) ) )

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> aggregate( array ( array ( '$project' => array ( 'field1' => 1, 'field2' => 2 ) ), array ( '$project' => array ( 'field1' => 1 ) ) ) ) ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to call aggregate, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
}

SequoiaCL::alter

(

array|string

$options

)

Alter collection options.

Parameters

$options

an array or the string argument. New collection options.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example: Alter collection option ReplSize

$err = $cl -> alter( array( 'ReplSize' => -1 ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to alter collection options, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::attachCL	(	string	$subClFullName,
		array|string	$options
	)

Attach the specified collection.

Parameters

$subClFullName	the string argument. The name of the subcollection.
$options	an array or the string argument. The low boudary and up boudary eg: array( 'LowBound' => array( '<key>' => <value> ), 'UpBound' => array( '<key>' => <value> ) )

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example: 2 collections have been created, one of which is a vertival partition.

$err = $veticalCL -> attachCL( 'cs.normalCL', array( 'LowBound' => array( 'id' => 0 ), 'UpBound' => array( 'id' => 100 ) ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to attach collection, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::bulkInsert	(	array|string	$records,
		integer	$flags = 0
	)

Insert records into current collection.

Parameters

$records	an array or the string argument. The inserted record, cannot be empty.
$flags	an integer argument. While SDB_FLG_INSERT_CONTONDUP is set, if some records hit index key duplicate error, database will skip them and go on inserting. However, while 0 is set, database will stop inserting in that case, and return errno code.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example: Insert an array record

$err = $cl -> bulkInsert( array( 'a' => 1 ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to insert records, error code: ".$err['errno'] ;
   return ;
}

Example: Insert the json string

$err = $cl -> bulkInsert( '{ "a": 2 }' ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to insert records, error code: ".$err['errno'] ;
   return ;
}

Example: Insert multiple records

$records = array(
   array( 'a' => 3 ),
   array( 'a' => 4 ),
   array( 'a' => 5 ),
   array( 'a' => 6 ),
   array( 'a' => 7 ),
   '{ "a": 8 }',
   '{ "a": 9 }',
   '{ "a": 10 }',
   '{ "a": 11 }',
   '{ "a": 12 }'
) ;
$err = $cl -> bulkInsert( $records ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to insert records, error code: ".$err['errno'] ;
   return ;
}

Example: Set $flags SDB_FLG_INSERT_CONTONDUP

$records = array(
   array( 'a' => 3 ),
   array( 'a' => 4 ),
   array( 'a' => 5 ),
   array( 'a' => 6 ),
   array( 'a' => 7 ),
   '{ "a": 8 }',
   '{ "a": 9 }',
   '{ "a": 10 }',
   '{ "a": 11 }',
   '{ "a": 12 }'
) ;
$err = $cl -> bulkInsert( $records, SDB_FLG_INSERT_CONTONDUP ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to insert records, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::count	(	array|string	$condition = null,
		array|string	$hint = null
	)

Get the count of records in specified collection.

Parameters

$condition	an array or the string argument. The matching rule, return the count of all records if this parameter is null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.

Returns

Returns the number of records matching the query.

Return values

integer|SequoiaINT64

Records number

Example:

$recordNum = $cl -> count() ;
if( $recordNum < 0 ) {
   $err = $db -> getError() ;
   echo "Failed to call count, error code: ".$err['errno'] ;
   return ;
}
echo "Collection records number: ".$recordNum ;

SequoiaCL::createIdIndex

(

array|string

$args = null

)

Create $id index in collection.

Parameters

$args

an array or the string argument. The arguments of creating id index. set it as null if no args. e.g. array( 'SortBufferSize' => 64 ) SortBufferSize : The size of sort buffer used when creating index, the unit is MB, zero means don't use sort buffer

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> createIdIndex( array( 'SortBufferSize' => 64 ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to create id index, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::createIndex	(	array|string	$indexDef,
		string	$indexName,
		boolean	$isUnique = false,
		boolean	$isEnforced = false,
		integer	$sortBufferSize = 64
	)

Create the index in current collection.

Parameters

$indexDef	an array or the string argument. The index element. e.g. array( 'name' => 1, 'age' => -1 )
$indexName	the string argument. The index name.
$isUnique	a boolean argument. Whether the index elements are unique or not,default is false.
$isEnforced	a boolean argument. Whether the index is enforced unique This element is meaningful when isUnique is set to true.
$sortBufferSize	an integer argument. The size of sort buffer used when creating index, the unit is MB, zero means don't use sort buffer.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> createIndex( array( 'name' => 1, 'age' => -1 ), "myIndex" ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to create index, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::deleteIndex

(

)

Delete $id index in collection.

See Also

dropIndex().

Deprecated:

This function is deprecated, use the function dropIndex() instead.

SequoiaCL::detachCL

(

string

$subClFullName

)

Detach the specified collection.

Parameters

$subClFullName

the string argument. The name of the subcollection.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example: 2 collections have been created, one of which is a vertival partition and attach collection.

$err = $veticalCL -> detachCL( 'cs.normalCL' ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to detach collection, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::drop

(

)

Drop collection.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example: Drop collection

$err = $cl -> drop() ;
if( $err['errno'] != 0 ) {
   echo "Failed to drop collection, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::dropIdIndex

(

)

Drop $id index in collection.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> dropIdIndex() ;
if( $err['errno'] != 0 ) {
   echo "Failed to drop id index, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::dropIndex

(

string

$indexName

)

Drop the index in current collection.

Parameters

$indexName

the string argument. The index name.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> dropIndex( "myIndex" ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to drop index, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::explain	(	array|string	$condition = null,
		array|string	$selector = null,
		array|string	$orderBy = null,
		array|string	$hint = null,
		integer	$numToSkip = 0,
		integer	$numToReturn = -1,
		integer	$flag = 0,
		array|string	$options = null
	)

Get access plan of query

Parameters

$condition	an array or the string argument. The matching rule, return all the record if null.
$selector	an array or the string argument. The selective rule, return the whole record if null.
$orderBy	an array or the string argument. The ordered rule, never sort if null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.
$numToSkip	an integer argument. Skip the first numToSkip records, never skip if this parameter is 0.
$numToReturn	an integer argument. Only return numToReturn records, return all if this parameter is -1.
$flag	an integer argument. The query flag, default to be 0. SDB_FLG_QUERY_FORCE_HINT(0x00000080) : Force to use specified hint to query, if database have no index assigned by the hint, fail to query SDB_FLG_QUERY_PARALLED(0x00000100) : Enable paralled sub query SDB_FLG_QUERY_WITH_RETURNDATA(0x00000200) : In general, query won't return data until cursor get from database, when add this flag, return data in query response, it will be more high-performance
$options	an array or the string argument. The rules of explain, the options are as below: Run: Whether execute query explain or not, true for excuting query explain then get the data and time information; false for not excuting query explain but get the query explain information only. e.g. array( 'run' => true )

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> explain( array( 'Run' => true ) ) ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to call explain, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
}

SequoiaCL::find	(	array|string	$condition = null,
		array|string	$selector = null,
		array|string	$orderBy = null,
		array|string	$hint = null,
		integer	$numToSkip = 0,
		integer	$numToReturn = -1,
		integer	$flag = 0
	)

Get the matching records in current collection.

Parameters

$condition	an array or the string argument. The matching rule, return all the record if null.
$selector	an array or the string argument. The selective rule, return the whole record if null.
$orderBy	an array or the string argument. The The ordered rule, never sort if null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.
$numToSkip	an integer argument. Skip the first numToSkip records, never skip if this parameter is 0.
$numToReturn	an integer argument. Only return numToReturn records, return all if this parameter is -1.
$flag	an integer argument. The query flag, default to be 0. SDB_FLG_QUERY_FORCE_HINT(0x00000080) : Force to use specified hint to query, if database have no index assigned by the hint, fail to query SDB_FLG_QUERY_PARALLED(0x00000100) : Enable paralled sub query SDB_FLG_QUERY_WITH_RETURNDATA(0x00000200) : In general, query won't return data until cursor get from database, when add this flag, return data in query response, it will be more high-performance

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> find( array( 'a' => array( '$lte' => 50 ) ) ) ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to find, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
}

SequoiaCL::findAndRemove	(	array|string	$condition = null,
		array|string	$selector = null,
		array|string	$orderBy = null,
		array|string	$hint = null,
		integer	$numToSkip = 0,
		integer	$numToReturn = -1,
		integer	$flag = 0
	)

Get the matching documents in current collection and remove.

Parameters

$condition	an array or the string argument. The matching rule, return all the record if null.
$selector	an array or the string argument. The selective rule, return the whole record if null.
$orderBy	an array or the string argument. The The ordered rule, never sort if null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.
$numToSkip	an integer argument. Skip the first numToSkip records, never skip if this parameter is 0.
$numToReturn	an integer argument. Only return numToReturn records, return all if this parameter is -1.
$flag	an integer argument. The query flag, default to be 0. SDB_FLG_QUERY_FORCE_HINT(0x00000080) : Force to use specified hint to query, if database have no index assigned by the hint, fail to query SDB_FLG_QUERY_PARALLED(0x00000100) : Enable paralled sub query SDB_FLG_QUERY_WITH_RETURNDATA(0x00000200) : In general, query won't return data until cursor get from database, when add this flag, return data in query response, it will be more high-performance

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> findAndRemove( array( 'a' => array( '$gt' => 0 ) ) ) ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to call findAndRemove, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
}

SequoiaCL::findAndUpdate	(	array|string	$rule,
		array|string	$condition = null,
		array|string	$selector = null,
		array|string	$orderBy = null,
		array|string	$hint = null,
		integer	$numToSkip = 0,
		integer	$numToReturn = -1,
		integer	$flag = 0,
		boolean	$returnNew = false
	)

Get the matching records in current collection and update.

Parameters

$rule	an array or the string argument. The update rule, can't be null.
$condition	an array or the string argument. The matching rule, return all the record if null.
$selector	an array or the string argument. The selective rule, return the whole record if null.
$orderBy	an array or the string argument. The The ordered rule, never sort if null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.
$numToSkip	an integer argument. Skip the first numToSkip records, never skip if this parameter is 0.
$numToReturn	an integer argument. Only return numToReturn records, return all if this parameter is -1.
$flag	an integer argument. The query flag, default to be 0. SDB_FLG_QUERY_FORCE_HINT(0x00000080) : Force to use specified hint to query, if database have no index assigned by the hint, fail to query SDB_FLG_QUERY_PARALLED(0x00000100) : Enable paralled sub query SDB_FLG_QUERY_WITH_RETURNDATA(0x00000200) : In general, query won't return data until cursor get from database, when add this flag, return data in query response, it will be more high-performance
$returnNew	a boolean argument. When TRUE, returns the updated record rather than the original.

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> findAndUpdate( array( '$set' => array( 'a' => 0 ) ), false, array( 'a' => array( '$gt' => 0 ) ) ) ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to call findAndUpdate, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
} 

SequoiaCL::getCollectionName

(

)

Get the specified collection name.

See Also

getName().

Deprecated:

This function is deprecated, use the function getName() instead.

SequoiaCL::getCSName

(

)

Get the specified collection space name.

Returns

Returns the collection space name.

Return values

string

<cs_name>

Example:

$csName = $cl -> getCSName() ;
$err = $db -> getError() ;
if( $err['errno'] != 0 ) {
   echo "Failed to get collection space name, error code: ".$err['errno'] ;
   return ;
}
echo "Collection space name is: ".$csName ;

SequoiaCL::getFullName

(

)

Get the specified collection full name.

Returns

Returns the collection full name.

Return values

string

<cs_name.cl_name>

Example:

$fullName = $cl -> getFullName() ;
$err = $db -> getError() ;
if( $err['errno'] != 0 ) {
   echo "Failed to get collection full name, error code: ".$err['errno'] ;
   return ;
}
echo "Collection full name is: ".$fullName ;

SequoiaCL::getIndex

(

string

$indexName = ""

)

Get all of or one of the indexes in current collection.

Parameters

$indexName

the string argument. The index name, returns all of the indexes if this parameter is empty string.

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> getIndex() ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to get indexes, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
}

SequoiaCL::getName

(

)

Get the specified collection name.

Returns

Returns the collection name.

Return values

string

<cl_name>

Example:

$clName = $cl -> getName() ;
$err = $db -> getError() ;
if( $err['errno'] != 0 ) {
   echo "Failed to get collection name, error code: ".$err['errno'] ;
   return ;
}
echo "Collection name is: ".$clName ;

SequoiaCL::insert

(

array|string

$record

)

Insert a record into current collection.

Parameters

$record

an array or the string argument. The inserted record, cannot be empty.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0, '_id' => <24 hexadecimal characters> )
string	{ "errno": 0, "_id": <24 hexadecimal characters> }

Example: Record type is php array

$err = $cl -> insert( array( 'time' => '2012-12-12' ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to insert record, error code: ".$err['errno'] ;
   return ;
}
echo "Insert record id is: ".$err['_id'] ;

Example: Record type is json string

$err = $cl -> insert( '{ "time": "2012-12-12" }' ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to insert record, error code: ".$err['errno'] ;
   return ;
}
echo "Insert record id is: ".$err['_id'] ;

SequoiaCL::listLob	(	array|string	$condition = null,
		array|string	$selector = null,
		array|string	$orderBy = null,
		array|string	$hint = null
	)

List all the lobs' meta data in current collection.

Parameters

$condition	an array or the string argument. This parameter is reserved and must be null.
$selector	an array or the string argument. This parameter is reserved and must be null.
$orderBy	an array or the string argument. This parameter is reserved and must be null.
$hint	an array or the string argument. This parameter is reserved and must be null.

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> listLob() ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to call listLob, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
}

SequoiaCL::listLobPieces	(	array|string	$condition = null,
		array|string	$selector = null,
		array|string	$orderBy = null,
		array|string	$hint = null
	)

List all the pieces in the lob.

Parameters

$condition	an array or the string argument. This parameter is reserved and must be null.
$selector	an array or the string argument. This parameter is reserved and must be null.
$orderBy	an array or the string argument. This parameter is reserved and must be null.
$hint	an array or the string argument. This parameter is reserved and must be null.

Returns

Returns a new SequoiaCursor object.

Return values

SequoiaCursor

Object

Example:

$cursor = $cl -> listLobPieces() ;
if( empty( $cursor ) ) {
   $err = $db -> getError() ;
   echo "Failed to call listLobPieces, error code: ".$err['errno'] ;
   return ;
}
while( $record = $cursor -> next() ) {
   var_dump( $record ) ;
}

SequoiaCL::openLob	(	string	$oid,
		integer	$mode
	)

Create a large object.

Parameters

$oid	the string argument. The object id.
$mode	an integer argument. The open mode: SDB_LOB_CREATEONLY SDB_LOB_READ

Returns

Returns a new SequoiaLob object.

Return values

SequoiaLob

Object

Example:

$lobObj = $cl -> openLob( "123456789012345678901234", SDB_LOB_CREATEONLY ) ;
if( empty( $lobObj ) ) {
   $err = $db -> getError() ;
   echo "Failed to open lob, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::remove	(	array|string	$condition = null,
		array|string	$hint = null
	)

Delete the matching documents in current collection, never rollback if failed.

Parameters

$condition	an array or the string argument. The matching rule, delete all the documents if null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example: Remove all records

$err = $cl -> remove() ;
if( $err['errno'] != 0 ) {
   echo "Failed to remove, error code: ".$err['errno'] ;
   return ;
}

Example: Remove match condition records

$err = $cl -> remove( array( 'age' => array( '$lte' => 50 ) ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to remove, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::removeLob

(

string

$oid

)

Remove lob

Parameters

$oid	the string argument. The object id.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> removeLob( "123456789012345678901234" ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to remove lob, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::split	(	string	$sourceGroup,
		string	$targetGroup,
		integer|double	$percent
	)

Split the specified collection from source replica group to target by percent.

Parameters

$sourceGroup	the string argument. The source replica group name.
$targetGroup	the string argument. The target replica group name.
$percent	an integer or a double argument. The split percent, Range:(0.0, 100.0].

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> split( 'group1', 'group2', 50 ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to split collection, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::split	(	string	$sourceGroup,
		string	$targetGroup,
		array|string	$condition,
		array|string	$endCondition = null
	)

Split the specified collection from source replica group to target by range.

Parameters

$sourceGroup	the string argument. The source replica group name.
$targetGroup	the string argument. The target replica group name.
$condition	an array or the string argument. The split condition.
$endCondition	an array or the string argument. The split end condition.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> split( 'group1', 'group2', array( 'a' => 1 ), array( 'a' => 100 ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to split collection, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::splitAsync	(	string	$sourceGroup,
		string	$targetGroup,
		integer|double	$percent
	)

Split the specified collection from source replica group to target by range.

Parameters

$sourceGroup	the string argument. The source replica group name.
$targetGroup	the string argument. The target replica group name.
$percent	an integer or a double argument. The split percent, Range:(0.0, 100.0].

Returns

Returns the result and task id, default return array.

Return values

array	array( 'errno' => 0, 'taskID' => 1 )
string	{ "errno": 0, "taskID": 1 }

Example:

$err = $cl -> splitAsync( 'group1', 'group2', 50 ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to split collection, error code: ".$err['errno'] ;
   return ;
}
echo "Task id is: ".$err['taskID'] ;

SequoiaCL::splitAsync	(	string	$sourceGroup,
		string	$targetGroup,
		array|string	$condition,
		array|string	$endCondition = null
	)

Split the specified collection from source replica group to target by range.

Parameters

$sourceGroup	the string argument. The source replica group name.
$targetGroup	the string argument. The target replica group name.
$condition	an array or the string argument. The split condition.
$endCondition	an array or the string argument. The split end condition.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0, 'taskID' => 1 )
string	{ "errno": 0, "taskID": 1

Example:

$err = $cl -> splitAsync( 'group1', 'group2', array( 'a' => 1 ), array( 'a' => 100 ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to split collection, error code: ".$err['errno'] ;
   return ;
}
echo "Task id is: ".$err['taskID'] ;

SequoiaCL::update	(	array|string	$rule,
		array|string	$condition = null,
		array|string	$hint = null
	)

Update the matching documents in current collection.

Parameters

$rule	an array or the string argument. The updating rule, cannot be null.
$condition	an array or the string argument. The matching rule, update all the documents if null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> update( '{ "$set": { "phone" : "" } }', array( 'age' => array( '$lt' => 10 ) ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to update, error code: ".$err['errno'] ;
   return ;
}

SequoiaCL::upsert	(	array|string	$rule,
		array|string	$condition = null,
		array|string	$hint = null
	)

Update the matching documents in current collection, insert if no matching.

Parameters

$rule	an array or the string argument. The updating rule, cannot be null.
$condition	an array or the string argument. The matching rule, update all the documents if null.
$hint	an array or the string argument. The hint, automatically match the optimal hint if null.

Returns

Returns the result, default return array.

Return values

array	array( 'errno' => 0 )
string	{ "errno": 0 }

Example:

$err = $cl -> upsert( '{ "$set": { "b" : 1 } }', array( 'a' => array( '$gt' => 100 ) ) ) ;
if( $err['errno'] != 0 ) {
   echo "Failed to upsert, error code: ".$err['errno'] ;
   return ;
}

Member Data Documentation

const SequoiaCL::SDB_FLG_FIND_FORCE_HINT 0x00000080

Force to use specified hint to query, if database have no index assigned by the hint, fail to query.

const SequoiaCL::SDB_FLG_FIND_PARALLED 0x00000100

Enable paralled sub query.

const SequoiaCL::SDB_FLG_FIND_WITH_RETURNDATA 0x00000200

In general, query won't return data until cursor get from database, when add this flag, return data in query response, it will be more high-performance.

const SequoiaCL::SDB_FLG_INSERT_CONTONDUP 0x00000001

The flags represent whether bulk insert continue when hitting index key duplicate error.

const SequoiaCL::SDB_FLG_QUERY_FORCE_HINT 0x00000080

Force to use specified hint to query, if database have no index assigned by the hint, fail to query

const SequoiaCL::SDB_FLG_QUERY_PARALLED 0x00000100

Enable paralled sub query

const SequoiaCL::SDB_FLG_QUERY_WITH_RETURNDATA 0x00000200

In general, query won't return data until cursor get from database, when add this flag, return data in query response, it will be more high-performance

const SequoiaCL::SDB_LOB_CREATEONLY 0x00000001

Open a new lob only.

const SequoiaCL::SDB_LOB_READ 0x00000004

Open an existing lob to read.

---

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

• class_cl.php
• deprecated_function.php