class Bdb extends StorageEngine (View source)

The BDB storage engine

Constants

protected SUPPORT_NO

protected SUPPORT_DISABLED

protected SUPPORT_YES

protected SUPPORT_DEFAULT

protected DETAILS_TYPE_PLAINTEXT

protected DETAILS_TYPE_SIZE

protected DETAILS_TYPE_NUMERIC

protected DETAILS_TYPE_BOOLEAN

Properties

string $engine from  StorageEngine
string $title from  StorageEngine
string $comment from  StorageEngine
int $support

Engine supported by current server.

from  StorageEngine

Methods

__construct(string $engine)

No description

static array[]
getStorageEngines()

Returns array of storage engines

static bool
hasMroongaEngine()

Returns if Mroonga is available to be used

static array
getMroongaLengths(string $dbName, string $tableName)

Get the lengths of a table of database

static array
getArray()

No description

static StorageEngine
getEngine(string $engine)

Loads the corresponding engine plugin, if available.

static bool
isValid(string $engine)

Returns true if given engine name is supported/valid, otherwise false

string
getHtmlVariables()

Returns as HTML table of the engine's server variables

array|null
resolveTypeSize(int $value)

Returns the engine specific handling for DETAILS_TYPE_SIZE type variables.

array
getVariablesStatus()

Returns array with detailed info about engine specific server variables

string
getTitle()

Reveals the engine's title

string
getComment()

Fetches the server's comment about this engine

string
getSupportInformationMessage()

Information message on whether this storage engine is supported

array
getVariables()

Returns array with variable names related to this storage engine

string
getMysqlHelpPage()

returns string with filename for the MySQL helppage about this storage engine

string
getVariablesLikePattern()

Returns the pattern to be used in the query for SQL variables related to this storage engine

string[]
getInfoPages()

Returns a list of available information pages with labels

string
getPage(string $id)

Generates the requested information page

Details

__construct(string $engine)

No description

Parameters

string $engine

The engine ID

static array[] getStorageEngines()

Returns array of storage engines

Return Value

array[]

array of storage engines

static bool hasMroongaEngine()

Returns if Mroonga is available to be used

This is public to be used in the StructureComtroller, the first release of this function was looking Mroonga in the engines list but this second method checks too that mroonga is installed successfully

Return Value

bool

static array getMroongaLengths(string $dbName, string $tableName)

Get the lengths of a table of database

Parameters

string $dbName

DB name

string $tableName

Table name

Return Value

array

static array getArray()

No description

Return Value

array

static StorageEngine getEngine(string $engine)

Loads the corresponding engine plugin, if available.

Parameters

string $engine

The engine ID

Return Value

StorageEngine

The engine plugin

static bool isValid(string $engine)

Returns true if given engine name is supported/valid, otherwise false

Parameters

string $engine

name of engine

Return Value

bool

string getHtmlVariables()

Returns as HTML table of the engine's server variables

Return Value

string

The table that was generated based on the retrieved information

array|null resolveTypeSize(int $value)

Returns the engine specific handling for DETAILS_TYPE_SIZE type variables.

This function should be overridden when DETAILS_TYPE_SIZE type needs to be handled differently for a particular engine.

Parameters

int $value

Value to format

Return Value

array|null

the formatted value and its unit

array getVariablesStatus()

Returns array with detailed info about engine specific server variables

Return Value

array

array with detailed info about specific engine server variables

string getTitle()

Reveals the engine's title

Return Value

string

The title

string getComment()

Fetches the server's comment about this engine

Return Value

string

The comment

string getSupportInformationMessage()

Information message on whether this storage engine is supported

Return Value

string

The localized message.

array getVariables()

Returns array with variable names related to this storage engine

Return Value

array

The list of variables.

string getMysqlHelpPage()

returns string with filename for the MySQL helppage about this storage engine

Return Value

string

MySQL help page filename

string getVariablesLikePattern()

Returns the pattern to be used in the query for SQL variables related to this storage engine

Return Value

string

SQL query LIKE pattern

string[] getInfoPages()

Returns a list of available information pages with labels

Return Value

string[]

The list

string getPage(string $id)

Generates the requested information page

Parameters

string $id

page id

Return Value

string

html output