sequoiadb.h

Go to the documentation of this file.

/*******************************************************************************
   Copyright (C) 2012-2014 SequoiaDB Ltd.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*******************************************************************************/

class SequoiaDB
{
public:
   __construct ( string $hostName = NULL,
                 string $userName = NULL,
                 string $password = NULL ) ;

   void install ( array|string $install ) ;

   array|string getError ( void ) ;

   array|string connect ( string $hostName,
                          string $userName = NULL,
                          string $password = NULL ) ;
   
   void close ( void ) ;

   SequoiaCursor execSQL ( string $sql ) ;
   
   array|string execUpdateSQL ( string $sql ) ;

   SequoiaCursor getSnapshot ( int $snapType,
                               array|string $condition = NULL,
                               array|string $select = NULL,
                               array|string $orderBy = NULL ) ;
   
   SequoiaCursor getList ( int $listType,
                           array|string $condition = NULL,
                           array|string $select = NULL,
                           array|string $orderBy = NULL ) ;

   SequoiaGroup selectGroup ( string $name ) ;

   array|string resetSnapshot ( void ) ;
   
   SequoiadbCS selectCS ( string $name, int $pageSize = 4096 ) ;

   SequoiaCursor listCSs ( void ) ;

   SequoiaCursor listCollections ( void ) ;

   array|string createCataGroup ( string $hostname,
                                  string $serviceName,
                                  string $databasePath,
                                  array|string $config ) ;

   array|string dropCollectionSpace ( string $name ) ;

} ;

class SecureSdb: public SequoiaDB
{
} ;

class SequoiaCS
{
public:

   SequoiaCL selectCollection ( string $name, array|string $options ) ;
   
   array|string drop ( void ) ;

   array|string dropCollection ( string $name ) ;

   string getName ( void ) ;
} ;

class SequoiaCL
{
public:
   
   array|string insert ( array|string $record ) ;
   
   array|string update ( array|string $rule,
                         array|string $condition = NULL,
                         array|string $hint = NULL ) ;
   
   array|string remove ( array|string $condition = NULL,
                         array|string $hint = NULL ) ;

   SequoiaCursor find ( array|string $condition = NULL,
                        array|string $select = NULL,
                        array|string $orderBy = NULL,
                        array|string $hint = NULL,
                        int $numToSkip = 0,
                        int $numToReturn = -1 ) ;

   SequoiaCursor findAndUpdate ( array|string $update,
                                 array|string $condition = NULL,
                                 array|string $select = NULL,
                                 array|string $orderBy = NULL,
                                 array|string $hint = NULL,
                                 int $numToSkip = 0,
                                 int $numToReturn = -1,
                                 bool $returnNew = FALSE ) ;

   SequoiaCursor findAndRemove ( array|string $condition = NULL,
                                 array|string $select = NULL,
                                 array|string $orderBy = NULL,
                                 array|string $hint = NULL,
                                 int $numToSkip = 0,
                                 int $numToReturn = -1 ) ;

   array|string split ( string $sourceName, string $destName, array|string $condition, array|string $endCondition = NULL ) ;

   array|string split ( string $sourceName, string $destName, double $percent ) ;

   array|string drop ( void ) ;

   SequoiaCursor aggregate ( array|string $aggrObj ) ;

   array|string createIndex ( array|string $indexDef,
                              string $pIndexName,
                              bool   $isUnique = false,
                              bool   $isEnforced = false,
                              int    $sortBufferSize = 64 ) ;

   array|string deleteIndex ( string $pIndexName ) ;

   SequoiaCursor getIndex ( string $pIndexName = "" ) ;
   
   string getCSName ( void ) ;
   
   string getCollectionName ( void ) ;
   
   string getFullName ( void ) ;
   
   int count ( array|string $condition = NULL ) ;

   int truncate ( void ) ;

   int createIdIndex ( void ) ;

   int dropIdIndex ( void ) ;
} ;

class SequoiaCursor
{
public:
   
   array|string getNext ( void ) ;
   
   array|string current ( void ) ;
   
   /*array|string updateCurrent ( array|string $rule ) ;*/
   
   /*array|string deleteCurrent ( void ) ;*/
} ;

class SequoiaGroup
{
public:

   int getNodeNum ( int $status ) ;

   array|string getDetail ( void ) ;

   SequoiaNode getMaster ( void ) ;

   SequoiaNode getSlave ( void ) ;

   SequoiaNode getNode ( string $nodeName ) ;

   array|string createNode ( string $hostName, string $serviceName, string $databasePath, array|string $config ) ;

   array|string start ( void ) ;

   array|string stop ( void ) ;

   bool isCatalog ( void ) ;
};

class SequoiaNode
{
public:

   array|string stop ( void ) ;

   array|string start ( void ) ;

   string getNodeName ( void ) ;

   string getServiceName ( void ) ;

   string getHostName ( void ) ;

   int getStatus ( void ) ;

   SequoiaDB connect ( void ) ;
};


class SequoiaID
{
public:
   __construct ( string $oid ) ;

   string __toString ( void ) ;
} ;


class SequoiaDate
{
public:
   __construct ( string $date ) ;
   
   string __toString ( void ) ;
} ;

class SequoiaTimestamp
{
public:
   __construct ( string $timestamp ) ;
   
   string __toString ( void ) ;
} ;

class SequoiaRegex
{
public:
   __construct ( string $regex ) ;
   
   string __toString ( void ) ;
} ;