Documentation

SQLInterface
in

Interface for database-specific syntax subclasses

Table of Contents

columnList()  : string
Get information about the columns in the specified table
dbList()  : string
Returns sql to list other databases
explain()  : string
Modify the query to get the query plan
fkList()  : string
Get the list of foreign keys for the current table
functionList()  : string|null
Return sql to list functions
indexList()  : string
Get the list of indexes for the current table
limit()  : string
Get database specific sql for limit clause
procedureList()  : string|null
Return sql to list stored procedures
random()  : string
Get the sql for random ordering
sequenceList()  : string|null
Return sql to list sequences
systemTableList()  : string|array<string|int, mixed>
Returns sql to list system tables
tableList()  : string
Returns sql to list tables
triggerList()  : string|null
Returns sql to list triggers
typeList()  : string|array<string|int, mixed>
Return sql to list database field types
viewList()  : string
Returns sql to list views

Methods

columnList()

Get information about the columns in the specified table

public columnList(string $table) : string
Parameters
$table : string
Return values
string

dbList()

Returns sql to list other databases

public dbList() : string
Return values
string

explain()

Modify the query to get the query plan

public explain(string $sql) : string
Parameters
$sql : string
Return values
string

fkList()

Get the list of foreign keys for the current table

public fkList(string $table) : string
Parameters
$table : string
Return values
string

functionList()

Return sql to list functions

public functionList() : string|null
Return values
string|null

indexList()

Get the list of indexes for the current table

public indexList(string $table) : string
Parameters
$table : string
Return values
string

limit()

Get database specific sql for limit clause

public limit(string $sql, int $limit[, int|null $offset = NULL ]) : string
Parameters
$sql : string
$limit : int
$offset : int|null = NULL
Return values
string

procedureList()

Return sql to list stored procedures

public procedureList() : string|null
Return values
string|null

random()

Get the sql for random ordering

public random() : string
Return values
string

sequenceList()

Return sql to list sequences

public sequenceList() : string|null
Return values
string|null

systemTableList()

Returns sql to list system tables

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

tableList()

Returns sql to list tables

public tableList() : string
Return values
string

triggerList()

Returns sql to list triggers

public triggerList() : string|null
Return values
string|null

typeList()

Return sql to list database field types

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

viewList()

Returns sql to list views

public viewList() : string
Return values
string

        

Search results