[schema_generator] element index

Package indexes

• cough
• cough_generator
• as_database
• as_query
• schema

__construct

XmlSchemaGenerator::__construct() in XmlSchemaGenerator.class.php

Construct with optional configuration parameters.

__construct

MysqlTable::__construct() in MysqlTable.class.php

__construct

MysqlServer::__construct() in MysqlServer.class.php

Construct with a DSN, an array containing host, user, pass, and port (optional).

__construct

MysqlDatabase::__construct() in MysqlDatabase.class.php

__construct

DatabaseSchemaGenerator::__construct() in DatabaseSchemaGenerator.class.php

Construct with optional configuration parameters.

__destruct

MysqlServer::__destruct() in MysqlServer.class.php

$config

XmlSchemaGenerator::$config in XmlSchemaGenerator.class.php

Configuration object for this class

$config

DatabaseSchemaGenerator::$config in DatabaseSchemaGenerator.class.php

Configuration object for this class

$connected

MysqlServer::$connected in MysqlServer.class.php

constructFromFile

XmlSchemaGeneratorConfig::constructFromFile() in XmlSchemaGeneratorConfig.class.php

constructFromFile

DatabaseSchemaGeneratorConfig::constructFromFile() in DatabaseSchemaGeneratorConfig.class.php

$dbLink

MysqlTable::$dbLink in MysqlTable.class.php

$dbLink

MysqlServer::$dbLink in MysqlServer.class.php

$dbLink

MysqlDatabase::$dbLink in MysqlDatabase.class.php

DatabaseSchemaGenerator

DatabaseSchemaGenerator in DatabaseSchemaGenerator.class.php

Takes database config info and generates a schema (a collection of databases each containing a collection of tables each containing a collection of columns)

DatabaseSchemaGeneratorConfig

DatabaseSchemaGeneratorConfig in DatabaseSchemaGeneratorConfig.class.php

Config class for DatabaseSchemaGenerator.

disableVerbose

DatabaseSchemaGenerator::disableVerbose() in DatabaseSchemaGenerator.class.php

Disable verbose mode

DriverDatabase

DriverDatabase in DriverDatabase.class.php

Defines the interface for a Database Driver.

DriverServer

DriverServer in DriverServer.class.php

Defines the interface for a Server Driver.

DriverTable

DriverTable in DriverTable.class.php

Defines the interface for a Table Driver, which should:

DatabaseSchemaGenerator.class.php

DatabaseSchemaGenerator.class.php in DatabaseSchemaGenerator.class.php

DatabaseSchemaGeneratorConfig.class.php

DatabaseSchemaGeneratorConfig.class.php in DatabaseSchemaGeneratorConfig.class.php

DriverDatabase.class.php

DriverDatabase.class.php in DriverDatabase.class.php

DriverServer.class.php

DriverServer.class.php in DriverServer.class.php

DriverTable.class.php

DriverTable.class.php in DriverTable.class.php

enableVerbose

DatabaseSchemaGenerator::enableVerbose() in DatabaseSchemaGenerator.class.php

Enable verbose mode

generateError

MysqlDatabase::generateError() in MysqlDatabase.class.php

generateError

MysqlTable::generateError() in MysqlTable.class.php

generateSchema

SchemaGenerator::generateSchema() in SchemaGenerator.class.php

generateSchema

XmlSchemaGenerator::generateSchema() in XmlSchemaGenerator.class.php

Generate/load the schema and return it.

generateSchema

DatabaseSchemaGenerator::generateSchema() in DatabaseSchemaGenerator.class.php

Traverse all the databases, tables, and columns to build a schema, which basically contains the same information with the addition of relationships between tables.

getAvailableDatabaseNames

DriverServer::getAvailableDatabaseNames() in DriverServer.class.php

Get a list of available database names.

getAvailableDatabaseNames

MysqlServer::getAvailableDatabaseNames() in MysqlServer.class.php

Get a list of available database names.

getAvailableTableNames

MysqlDatabase::getAvailableTableNames() in MysqlDatabase.class.php

getAvailableTableNames

DriverDatabase::getAvailableTableNames() in DriverDatabase.class.php

getDsn

DatabaseSchemaGeneratorConfig::getDsn() in DatabaseSchemaGeneratorConfig.class.php

getIdToTableRegex

DatabaseSchemaGeneratorConfig::getIdToTableRegex() in DatabaseSchemaGeneratorConfig.class.php

Returns an array of regexes to match against in order to determine if a field can be mapped to a table name, in order of precedence.

getPrimaryKeyOverride

DatabaseSchemaGeneratorConfig::getPrimaryKeyOverride() in DatabaseSchemaGeneratorConfig.class.php

getSchema

DatabaseSchemaGenerator::getSchema() in DatabaseSchemaGenerator.class.php

Get the Schema / DriverServer object.

getTableNamePrefixes

DatabaseSchemaGeneratorConfig::getTableNamePrefixes() in DatabaseSchemaGeneratorConfig.class.php

$hasLoadedBaseDrivers

DatabaseSchemaGenerator::$hasLoadedBaseDrivers in DatabaseSchemaGenerator.class.php

Keep track of whether or not the base database drivers have been loaded.

initConfig

XmlSchemaGeneratorConfig::initConfig() in XmlSchemaGeneratorConfig.class.php

initConfig

XmlSchemaGenerator::initConfig() in XmlSchemaGenerator.class.php

Initialize the configuration object given an array or pre-constructed configuration object.

initConfig

DatabaseSchemaGeneratorConfig::initConfig() in DatabaseSchemaGeneratorConfig.class.php

initConfig

DatabaseSchemaGenerator::initConfig() in DatabaseSchemaGenerator.class.php

Initialize the configuration object given an array or pre-constructed configuration object.

loadColumns

MysqlTable::loadColumns() in MysqlTable.class.php

loadColumns

DriverTable::loadColumns() in DriverTable.class.php

loadDatabase

MysqlServer::loadDatabase() in MysqlServer.class.php

Load a specific database schema into memory.

loadDatabase

DriverServer::loadDatabase() in DriverServer.class.php

Load a specific database schema into memory.

loadDatabases

MysqlServer::loadDatabases() in MysqlServer.class.php

Load all database schemas for the currently connected server into memory.

loadDatabases

DriverServer::loadDatabases() in DriverServer.class.php

Load all database schemas for the currently connected server into memory.

loadDrivers

DatabaseSchemaGenerator::loadDrivers() in DatabaseSchemaGenerator.class.php

Load database schema drivers for the specified path and driver prefix.

loadSchema

XmlSchemaGenerator::loadSchema() in XmlSchemaGenerator.class.php

Loads the schema into memory according to the config (e.g. only includes databases and tables the config allows).

loadSchema

DatabaseSchemaGenerator::loadSchema() in DatabaseSchemaGenerator.class.php

Loads the schema into memory according to the config (e.g. only includes databases and tables the config allows).

loadTable

MysqlDatabase::loadTable() in MysqlDatabase.class.php

Load a specific database table into memory.

loadTable

DriverDatabase::loadTable() in DriverDatabase.class.php

loadTables

DriverDatabase::loadTables() in DriverDatabase.class.php

Load all tables for the database into memory.

loadTables

MysqlDatabase::loadTables() in MysqlDatabase.class.php

MysqlDatabase

MysqlDatabase in MysqlDatabase.class.php

Implements the interface for the Database Driver.

MysqlServer

MysqlServer in MysqlServer.class.php

Implements the interface for Server Driver, which:

MysqlTable

MysqlTable in MysqlTable.class.php

Implements the interface for Table Driver, which:

MysqlDatabase.class.php

MysqlDatabase.class.php in MysqlDatabase.class.php

MysqlServer.class.php

MysqlServer.class.php in MysqlServer.class.php

MysqlTable.class.php

MysqlTable.class.php in MysqlTable.class.php

parseCreateStatement

MysqlTable::parseCreateStatement() in MysqlTable.class.php

parseForeignKeyReferences

MysqlTable::parseForeignKeyReferences() in MysqlTable.class.php

query

MysqlTable::query() in MysqlTable.class.php

$schema

XmlSchemaGenerator::$schema in XmlSchemaGenerator.class.php

Schema object (mostly likely an instanceof Schema)

$schema

DatabaseSchemaGenerator::$schema in DatabaseSchemaGenerator.class.php

Schema object (mostly likely an instanceof Schema)

SchemaGenerator

SchemaGenerator in SchemaGenerator.class.php

Defines the interface for all SchemaGenerators.

SchemaGenerator.class.php

SchemaGenerator.class.php in SchemaGenerator.class.php

selectDb

MysqlDatabase::selectDb() in MysqlDatabase.class.php

selectDb

DriverDatabase::selectDb() in DriverDatabase.class.php

setSchema

DatabaseSchemaGenerator::setSchema() in DatabaseSchemaGenerator.class.php

Set the Schema / DriverServer object.

shouldProcessDatabase

DatabaseSchemaGeneratorConfig::shouldProcessDatabase() in DatabaseSchemaGeneratorConfig.class.php

Returns whether not the given database name should be processed.

shouldProcessTable

DatabaseSchemaGeneratorConfig::shouldProcessTable() in DatabaseSchemaGeneratorConfig.class.php

Returns whether not the given table name (for the given database name) should be processed.

shouldScanForJoin

DatabaseSchemaGeneratorConfig::shouldScanForJoin() in DatabaseSchemaGeneratorConfig.class.php

Returns whether or not a the $sourceTable cares about the $refDatabase when looking for joins.

trimBackticks

MysqlTable::trimBackticks() in MysqlTable.class.php

Trim whitespace, and THEN backticks (leaving any whitespice within the backticks)

$verbose

DatabaseSchemaGenerator::$verbose in DatabaseSchemaGenerator.class.php

Whether or not to echo what's happening to the screen.

XmlSchemaGenerator.class.php

XmlSchemaGenerator.class.php in XmlSchemaGenerator.class.php

XmlSchemaGeneratorConfig.class.php

XmlSchemaGeneratorConfig.class.php in XmlSchemaGeneratorConfig.class.php

XmlSchemaGenerator

XmlSchemaGenerator in XmlSchemaGenerator.class.php

Takes XML config info and generates a schema (a collection of databases each containing a collection of tables each containing a collection of columns)

XmlSchemaGeneratorConfig

XmlSchemaGeneratorConfig in XmlSchemaGeneratorConfig.class.php

XML Schema Generator takes an XML schema file and generates the Schema objects that CoughGenerator takes.