Documentation

Database
in package

FinalYes

Legacy DBMS database wrapper for table lookup and schema operations.

Tags
author

Daniel Schulz

since
2018-03-29

Table of Contents

Properties

$client  : Client
$name  : string

Methods

__construct()  : mixed
addIndex()  : void
createDatabase()  : void
createTable()  : void
databaseExists()  : bool|null
delete()  : int|null
deleteDatabase()  : void
escape()  : string
getColumns()  : array<string|int, mixed>|null
getName()  : string
getTable()  : Table
getTableList()  : array<string|int, mixed>
insert()  : int|null
optimize()  : bool|null
resetCharset()  : void
select()  : array<string|int, mixed>|null
tableExists()  : bool|null
tableMove()  : bool
update()  : int|null

Properties

Methods

__construct()

public __construct(Client $client, string $dbName) : mixed
Parameters
$client : Client
$dbName : string

addIndex()

public addIndex(string $tableName, array<string|int, mixed>|string $index) : void
Parameters
$tableName : string
$index : array<string|int, mixed>|string

createDatabase()

public createDatabase() : void

createTable()

public createTable(string $tableName, array<string|int, mixed> $cols, array<string|int, mixed> $keys[, array<string|int, mixed> $options = [] ]) : void
Parameters
$tableName : string
$cols : array<string|int, mixed>
$keys : array<string|int, mixed>
$options : array<string|int, mixed> = []

databaseExists()

public databaseExists() : bool|null
Return values
bool|null

delete()

public delete(string $tableName[, mixed $idQuery = false ]) : int|null
Parameters
$tableName : string
$idQuery : mixed = false
Return values
int|null

deleteDatabase()

public deleteDatabase() : void

escape()

public escape(string $string) : string
Parameters
$string : string
Return values
string

getColumns()

public getColumns(string $tableName) : array<string|int, mixed>|null
Parameters
$tableName : string
Return values
array<string|int, mixed>|null

getName()

public getName() : string
Return values
string

getTable()

public getTable(string $tableName) : Table
Parameters
$tableName : string
Return values
Table

getTableList()

public getTableList() : array<string|int, mixed>
Return values
array<string|int, mixed>

insert()

public insert(string $tableName[, array<string|int, mixed> $insertData = [] ][, array<string|int, mixed> $onDuplicateData = [] ]) : int|null
Parameters
$tableName : string
$insertData : array<string|int, mixed> = []
$onDuplicateData : array<string|int, mixed> = []
Return values
int|null

optimize()

public optimize([string|null $tableName = null ]) : bool|null
Parameters
$tableName : string|null = null
Return values
bool|null

resetCharset()

public resetCharset() : void

select()

public select(string $tableName[, array<string|int, mixed>|string|bool $columnQuery = true ][, array<string|int, mixed>|string $sqlQuery = '' ][, string $sqlSuffix = '' ]) : array<string|int, mixed>|null
Parameters
$tableName : string
$columnQuery : array<string|int, mixed>|string|bool = true
$sqlQuery : array<string|int, mixed>|string = ''
$sqlSuffix : string = ''
Return values
array<string|int, mixed>|null

tableExists()

public tableExists(string $tableName) : bool|null
Parameters
$tableName : string
Return values
bool|null

tableMove()

public tableMove(string $oldTableName, string $newTableName[, string|null $newDbName = null ]) : bool
Parameters
$oldTableName : string
$newTableName : string
$newDbName : string|null = null
Return values
bool

update()

public update(string $tableName[, array<string|int, mixed> $arr = [] ][, mixed $idQuery = false ]) : int|null
Parameters
$tableName : string
$arr : array<string|int, mixed> = []
$idQuery : mixed = false
Return values
int|null
On this page

Search results