PHP Interface Doctrine\OrientDB\Binding\HttpBindingInterface

Inheritance: extends Doctrine\OrientDB\Binding\BindingInterface
Datei anzeigen Open project: doctrine/orientdb-odm

Public Methods

Method Description
cluster ( string $cluster, integer $limit = null, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Retrieves records from the given cluster in the database.
command ( string $query, string $language = BindingInterface::LANGUAGE_SQLPLUS, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Executes a raw command on the given database.
connect ( string $database ) : Doctrine\OrientDB\Binding\BindingResultInterface Connects to the specified database.
createDatabase ( string $database, string $storage = 'memory', string $type = 'document' ) : Doctrine\OrientDB\Binding\BindingResultInterface Creates a new database.
deleteClass ( string $class, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Deletes a class.
deleteDatabase ( string $database ) : Doctrine\OrientDB\Binding\BindingResultInterface Deletes an existing database.
deleteDocument ( string $rid, string $version = null, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Deletes a document from the database.
disconnect ( ) : Doctrine\OrientDB\Binding\BindingResultInterface Disconnect this instance from the server.
getAdapter ( ) : Doctrine\OrientDB\Binding\Adapter\HttpClientAdapterInterface Sets the underlying HTTP client adapter.
getClass ( string $class, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Retrieves a class and its records.
getDocument ( string $rid, string $database = null, string $fetchPlan = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Retrieves a record from the database. An optional fetch plan can be used to specify how to retrieve the graph and limit its depth.
getServer ( ) : Doctrine\OrientDB\Binding\BindingResultInterface Gets the current server.
listDatabases ( ) : Doctrine\OrientDB\Binding\BindingResultInterface Lists all the existing databases.
postClass ( string $class, string $body = null, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Creates a new class.
postDocument ( string $document, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Stores a new document in the database.
putDocument ( string $rid, string $document, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Updates an existing document in the database.
query ( string $query, integer $limit = null, string $fetchPlan = null, string $language = BindingInterface::LANGUAGE_SQLPLUS, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface Executes a raw query on the given database.
setAdapter ( Doctrine\OrientDB\Binding\Adapter\HttpClientAdapterInterface $adapter ) Sets the underlying HTTP client adapter.
setAuthentication ( string $username = null, string $password = null ) Sets the username and password used to authenticate to the server.

Method Details

cluster() public method

Retrieves records from the given cluster in the database.
public cluster ( string $cluster, integer $limit = null, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$cluster string
$limit integer
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

command() public method

Executes a raw command on the given database.
public command ( string $query, string $language = BindingInterface::LANGUAGE_SQLPLUS, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$query string
$language string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

connect() public method

Connects to the specified database.
public connect ( string $database ) : Doctrine\OrientDB\Binding\BindingResultInterface
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

createDatabase() public method

Creates a new database.
public createDatabase ( string $database, string $storage = 'memory', string $type = 'document' ) : Doctrine\OrientDB\Binding\BindingResultInterface
$database string
$storage string
$type string
return Doctrine\OrientDB\Binding\BindingResultInterface

deleteClass() public method

Deletes a class.
public deleteClass ( string $class, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$class string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

deleteDatabase() public method

Deletes an existing database.
public deleteDatabase ( string $database ) : Doctrine\OrientDB\Binding\BindingResultInterface
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

deleteDocument() public method

Deletes a document from the database.
public deleteDocument ( string $rid, string $version = null, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$rid string
$version string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

disconnect() public method

Disconnect this instance from the server.
public disconnect ( ) : Doctrine\OrientDB\Binding\BindingResultInterface
return Doctrine\OrientDB\Binding\BindingResultInterface

getAdapter() public method

Sets the underlying HTTP client adapter.
public getAdapter ( ) : Doctrine\OrientDB\Binding\Adapter\HttpClientAdapterInterface
return Doctrine\OrientDB\Binding\Adapter\HttpClientAdapterInterface

getClass() public method

Retrieves a class and its records.
public getClass ( string $class, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$class string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

getDocument() public method

Retrieves a record from the database. An optional fetch plan can be used to specify how to retrieve the graph and limit its depth.
public getDocument ( string $rid, string $database = null, string $fetchPlan = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$rid string
$database string
$fetchPlan string
return Doctrine\OrientDB\Binding\BindingResultInterface

getServer() public method

Gets the current server.
public getServer ( ) : Doctrine\OrientDB\Binding\BindingResultInterface
return Doctrine\OrientDB\Binding\BindingResultInterface

listDatabases() public method

Lists all the existing databases.
public listDatabases ( ) : Doctrine\OrientDB\Binding\BindingResultInterface
return Doctrine\OrientDB\Binding\BindingResultInterface

postClass() public method

Creates a new class.
public postClass ( string $class, string $body = null, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$class string
$body string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

postDocument() public method

Stores a new document in the database.
public postDocument ( string $document, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$document string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

putDocument() public method

Updates an existing document in the database.
public putDocument ( string $rid, string $document, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$rid string
$document string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

query() public method

Results can be limited with the $limit parameter and a fetch plan can be used to specify how to retrieve the graph and limit its depth. It differs from the command because OrientDB defines a query as a SELECT only.
public query ( string $query, integer $limit = null, string $fetchPlan = null, string $language = BindingInterface::LANGUAGE_SQLPLUS, string $database = null ) : Doctrine\OrientDB\Binding\BindingResultInterface
$query string SQL or Gremlin query.
$limit integer Maximum number of records (default is 20).
$fetchPlan string
$language string
$database string
return Doctrine\OrientDB\Binding\BindingResultInterface

setAdapter() public method

Sets the underlying HTTP client adapter.
public setAdapter ( Doctrine\OrientDB\Binding\Adapter\HttpClientAdapterInterface $adapter )
$adapter Doctrine\OrientDB\Binding\Adapter\HttpClientAdapterInterface

setAuthentication() public method

Sets the username and password used to authenticate to the server.
public setAuthentication ( string $username = null, string $password = null )
$username string
$password string