PHP Interface AppserverIo\Appserver\Core\Api\Node\DatabaseNodeInterface

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: extends AppserverIo\Configuration\Interfaces\NodeInterface
Show file Open project: appserver-io/appserver Interface Usage Examples

Public Methods

Method Description
getCharset ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode Returns the database charset to use.
getDatabaseHost ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode Returns the database host information.
getDatabaseName ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode Returns the database name information.
getDatabasePort ( ) : AppserverIo\Appserver\Core\Api\Node\DatabasePortNode Returns the database port information.
getDriver ( ) : AppserverIo\Appserver\Core\Api\Node\DriverNode Returns the database driver information.
getDriverOptions ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode Returns the database driver options.
getMemory ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode Returns the flag to run Sqlite in memory (mutually exclusive with the path option).
getPassword ( ) : AppserverIo\Appserver\Core\Api\Node\PasswordNode Returns the database password information.
getPath ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode Returns the database path information (when using sqlite for example).
getPlatform ( ) : AppserverIo\Appserver\Core\Api\Node\PlatformNode Returns the DB platform.
getServerVersion ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode Returns the server version we want to connect to.
getUnixSocket ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode Returns the name of the socket used to connect to the database.
getUser ( ) : AppserverIo\Appserver\Core\Api\Node\UserNode Returns the database user information.

Method Details

getCharset() public method

Returns the database charset to use.
public getCharset ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode
return AppserverIo\Appserver\Core\Api\Node\CharsetNode The database charset

getDatabaseHost() public method

Returns the database host information.
public getDatabaseHost ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode
return AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode The database host information

getDatabaseName() public method

Returns the database name information.
public getDatabaseName ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode
return AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode The database name information

getDatabasePort() public method

Returns the database port information.
public getDatabasePort ( ) : AppserverIo\Appserver\Core\Api\Node\DatabasePortNode
return AppserverIo\Appserver\Core\Api\Node\DatabasePortNode The database port information

getDriver() public method

Returns the database driver information.
public getDriver ( ) : AppserverIo\Appserver\Core\Api\Node\DriverNode
return AppserverIo\Appserver\Core\Api\Node\DriverNode The database driver information

getDriverOptions() public method

Returns the database driver options.
public getDriverOptions ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode
return AppserverIo\Appserver\Core\Api\Node\CharsetNode The database driver options

getMemory() public method

Returns the flag to run Sqlite in memory (mutually exclusive with the path option).
public getMemory ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode
return AppserverIo\Appserver\Core\Api\Node\PathNode The flag to run Sqlite in memory

getPassword() public method

Returns the database password information.
public getPassword ( ) : AppserverIo\Appserver\Core\Api\Node\PasswordNode
return AppserverIo\Appserver\Core\Api\Node\PasswordNode The database password information

getPath() public method

Returns the database path information (when using sqlite for example).
public getPath ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode
return AppserverIo\Appserver\Core\Api\Node\PathNode The database path information

getPlatform() public method

Returns the DB platform.
public getPlatform ( ) : AppserverIo\Appserver\Core\Api\Node\PlatformNode
return AppserverIo\Appserver\Core\Api\Node\PlatformNode The DB platform

getServerVersion() public method

Returns the server version we want to connect to.
public getServerVersion ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode
return AppserverIo\Appserver\Core\Api\Node\CharsetNode The server version to connect to

getUnixSocket() public method

Returns the name of the socket used to connect to the database.
public getUnixSocket ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode
return AppserverIo\Appserver\Core\Api\Node\CharsetNode The name of the socket

getUser() public method

Returns the database user information.
public getUser ( ) : AppserverIo\Appserver\Core\Api\Node\UserNode
return AppserverIo\Appserver\Core\Api\Node\UserNode The database user information