1. class
  2. PhpMyAdmin
  3. \
  4. Plugins
  5. \
  6. Export
  7. \
  8. ExportSql

ExportSql

class ExportSql extends ExportPlugin (View source)

Handles the export for the SQL class

Properties

protected ExportPluginProperties $properties

Object containing the specific export plugin type properties.

 from  ExportPlugin
static ExportType $exportType from  ExportPlugin
static bool $singleTable from  ExportPlugin
protected StructureOrData $structureOrData from  ExportPlugin
string|null $sqlAutoIncrements
string|null $sqlConstraints
string $sqlConstraintsQuery
string|null $sqlIndexes

Methods

__construct(Relation $relation, Export $export, Transformations $transformations)

No description

from  ExportPlugin
bool
exportHeader()

Outputs export header. It is the first method to be called, so all the required variables are initialized here.

bool
exportFooter()

Outputs export footer

bool
exportDBHeader(string $db, string $dbAlias = '')

Outputs database header

bool
exportDBFooter(string $db)

Outputs database footer

bool
exportDBCreate(string $db, string $dbAlias = '')

Outputs CREATE DATABASE statement

bool
exportData(string $db, string $table, string $sqlQuery, array $aliases = [])

Outputs the content of a table in SQL format

bool
exportRoutines(string $db, array $aliases = [])

Exports routines (procedures and functions)

bool
exportEvents(string $db)

Exports events

bool
exportRawQuery(string|null $db, string $sqlQuery)

Outputs a raw query

bool
exportStructure(string $db, string $table, string $exportMode, array $aliases = [])

Outputs table's structure

bool
exportMetadata(string $db, string|array $tables, array $metadataTypes)

Exports metadata from Configuration Storage

string
getTableDefStandIn(string $db, string $view, array $aliases = [])

Returns a stand-in CREATE definition to resolve view dependencies

void
init()

Plugin specific initializations.

from  ExportPlugin
PluginPropertyItem
getProperties()

Gets the export specific format plugin properties

from  ExportPlugin
ExportPluginProperties
setProperties()

Sets the export plugins properties and is implemented by each export plugin.

void
initAlias(array $aliases, string $db, string|null $table = null)

Initialize aliases

from  ExportPlugin
string
getAlias(array $aliases, string $id, string $type = 'dbtblcol', string $db = '', string $tbl = '')

Search for alias of a identifier.

from  ExportPlugin
string
getRelationString(array $foreigners, string $fieldName, string $db, array $aliases = [])

Gives the relation string and also substitutes with alias if required in this format: [Foreign Table] ([Foreign Field])

from  ExportPlugin
static bool
isAvailable()

No description

from  ExportPlugin
void
setExportOptions(ServerRequest $request, array $exportConfig)

No description

StructureOrData
getStructureOrData()

No description

from  ExportPlugin
StructureOrData
setStructureOrData(mixed $valueFromRequest, mixed $valueFromConfig, StructureOrData $defaultValue)

No description

from  ExportPlugin
string
getName()

No description

void
useSqlBackquotes(bool $useSqlBackquotes)

No description

string
exportRoutineSQL(string $db, array $aliases, string $type, string $name, array $routines, string $delimiter)

Generates SQL for routines export

string
getTableDef(string $db, string $table, bool $addSemicolon = true, bool $view = false, bool $updateIndexesIncrements = true, array $aliases = [])

Returns $table's CREATE definition

string
replaceWithAliases(string|null $delimiter, string $sqlQuery, array $aliases, string $db, bool|null $flag = null)

replaces db/table/column names with their aliases

string
generateComment(string|null $sqlStatement, string $comment1, string $comment2, string $tableAlias, string $compat)

Generate comment

bool
hasCreateProcedureFunction()

No description

bool
hasCreateTable()

No description

bool
hasCreateView()

No description

bool
hasCreateTrigger()

No description

void
setAutoIncrement(bool $autoIncrement)

No description

bool
hasMetadata()

No description

Details

in ExportPlugin at line 39
final __construct(Relation $relation, Export $export, Transformations $transformations)

No description

Parameters

Relation $relation
Export $export
Transformations $transformations

at line 739
bool exportHeader()

Outputs export header. It is the first method to be called, so all the required variables are initialized here.

Return Value

bool

at line 703
bool exportFooter()

Outputs export footer

Return Value

bool

at line 916
bool exportDBHeader(string $db, string $dbAlias = '')

Outputs database header

Parameters

string $db

Database name
string $dbAlias

Aliases of db

Return Value

bool

at line 941
bool exportDBFooter(string $db)

Outputs database footer

Parameters

string $db

Database name

Return Value

bool

at line 838
bool exportDBCreate(string $db, string $dbAlias = '')

Outputs CREATE DATABASE statement

Parameters

string $db

Database name
string $dbAlias

Aliases of db

Return Value

bool

at line 2012
bool exportData(string $db, string $table, string $sqlQuery, array $aliases = [])

Outputs the content of a table in SQL format

Parameters

string $db

database name
string $table

table name
string $sqlQuery

SQL query for obtaining data
array $aliases

Aliases of db/table/columns

Return Value

bool

at line 607
bool exportRoutines(string $db, array $aliases = [])

Exports routines (procedures and functions)

Parameters

string $db Database
array $aliases

Aliases of db/table/columns

Return Value

bool

at line 977
bool exportEvents(string $db)

Exports events

Parameters

string $db Database

Return Value

bool

at line 1860
bool exportRawQuery(string|null $db, string $sqlQuery)

Outputs a raw query

Parameters

string|null $db

the database where the query is executed
string $sqlQuery

the rawquery to output

Return Value

bool

at line 1877
bool exportStructure(string $db, string $table, string $exportMode, array $aliases = [])

Outputs table's structure

Parameters

string $db

database name
string $table

table name
string $exportMode

'create_table', 'triggers', 'create_view', 'stand_in'
array $aliases

Aliases of db/table/columns

Return Value

bool

at line 1036
bool exportMetadata(string $db, string|array $tables, array $metadataTypes)

Exports metadata from Configuration Storage

Parameters

string $db

database being exported
string|array $tables

table(s) being exported
array $metadataTypes

types of metadata to export

Return Value

bool

at line 1243
string getTableDefStandIn(string $db, string $view, array $aliases = [])

Returns a stand-in CREATE definition to resolve view dependencies

Parameters

string $db

the database name
string $view

the view name
array $aliases

Aliases of db/table/columns

Return Value

string

resulting definition

in ExportPlugin at line 178
protected void init()

Plugin specific initializations.

Return Value

void

in ExportPlugin at line 187
PluginPropertyItem getProperties()

Gets the export specific format plugin properties

Return Value

PluginPropertyItem

at line 138
protected ExportPluginProperties setProperties()

Sets the export plugins properties and is implemented by each export plugin.

Return Value

ExportPluginProperties

in ExportPlugin at line 211
void initAlias(array $aliases, string $db, string|null $table = null)

Initialize aliases

Parameters

array $aliases

Alias information for db/table/column
string $db

the database
string|null $table

the table

Return Value

void

in ExportPlugin at line 236
string getAlias(array $aliases, string $id, string $type = 'dbtblcol', string $db = '', string $tbl = '')

Search for alias of a identifier.

Parameters

array $aliases

Alias information for db/table/column
string $id

the identifier to be searched
string $type

db/tbl/col or any combination of them representing what to be searched
string $db

the database in which search is to be done
string $tbl

the table in which search is to be done

Return Value

string

alias of the identifier if found or ''

in ExportPlugin at line 299
string getRelationString(array $foreigners, string $fieldName, string $db, array $aliases = [])

Gives the relation string and also substitutes with alias if required in this format: [Foreign Table] ([Foreign Field])

Parameters

array $foreigners

the foreigners array
string $fieldName

the field name
string $db

the field name
array $aliases

Alias information for db/table/column

Return Value

string

the Relation string

in ExportPlugin at line 323
static bool isAvailable()

No description

Return Value

bool

at line 2676
void setExportOptions(ServerRequest $request, array $exportConfig)

No description

Parameters

ServerRequest $request
array $exportConfig

Return Value

void

in ExportPlugin at line 331
StructureOrData getStructureOrData()

No description

Return Value

StructureOrData

in ExportPlugin at line 336
protected StructureOrData setStructureOrData(mixed $valueFromRequest, mixed $valueFromConfig, StructureOrData $defaultValue)

No description

Parameters

mixed $valueFromRequest
mixed $valueFromConfig
StructureOrData $defaultValue

Return Value

StructureOrData

at line 128
string getName()

No description

Return Value

string

at line 133
void useSqlBackquotes(bool $useSqlBackquotes)

No description

Parameters

bool $useSqlBackquotes

Return Value

void

at line 540
protected string exportRoutineSQL(string $db, array $aliases, string $type, string $name, array $routines, string $delimiter)

Generates SQL for routines export

Parameters

string $db Database
array $aliases

Aliases of db/table/columns
string $type
string $name

Verbose name of exported routine
array $routines

List of routines to export
string $delimiter

Delimiter to use in SQL

Return Value

string

SQL query

at line 1362
string getTableDef(string $db, string $table, bool $addSemicolon = true, bool $view = false, bool $updateIndexesIncrements = true, array $aliases = [])

Returns $table's CREATE definition

Parameters

string $db

the database name
string $table

the table name
bool $addSemicolon

whether to add semicolon and end-of-line at the end
bool $view

whether we're handling a view
bool $updateIndexesIncrements

whether we need to update two global variables
array $aliases

Aliases of db/table/columns

Return Value

string

resulting schema

at line 2397
string replaceWithAliases(string|null $delimiter, string $sqlQuery, array $aliases, string $db, bool|null $flag = null)

replaces db/table/column names with their aliases

Parameters

string|null $delimiter

The delimiter for the parser (";" or "$$")
string $sqlQuery

SQL query in which aliases are to be substituted
array $aliases

Alias information for db/table/column
string $db

the database name
bool|null $flag

the flag denoting whether any replacement was done

Return Value

string

query replaced with aliases

at line 2578
protected string generateComment(string|null $sqlStatement, string $comment1, string $comment2, string $tableAlias, string $compat)

Generate comment

Parameters

string|null $sqlStatement

SQL statement
string $comment1

Comment for dumped table
string $comment2

Comment for current table
string $tableAlias

Table alias
string $compat

Compatibility mode

Return Value

string

at line 2777
bool hasCreateProcedureFunction()

No description

Return Value

bool

at line 2782
bool hasCreateTable()

No description

Return Value

bool

at line 2797
bool hasCreateView()

No description

Return Value

bool

at line 2802
bool hasCreateTrigger()

No description

Return Value

bool

at line 2807
void setAutoIncrement(bool $autoIncrement)

No description

Parameters

bool $autoIncrement

Return Value

void

at line 2836
bool hasMetadata()

No description

Return Value

bool