DatabaseConnector

Moduleejs.db
Definition class DatabaseConnector
Specifiedejscript-2.5
StabilityEvolving.

Database Connector interface.

The database connector interface is the contract implemented by concrete database implementations. This interface is implemented by database connectors such as SQLite and MYSQL.

Properties

(No own properties defined)

DatabaseConnector Class Methods

(No own class methods defined)

QualifiersMethod

DatabaseConnector Instance Methods

QualifiersMethod
addColumn(table: String, column: String, datatype: String, options: Object): Void
 Add a column to a table.
addIndex(table: String, column: String, index: String): Void
 Add an index on a column.P.
changeColumn(table: String, column: String, datatype: String, options: Object): Void
 Change a column.
close(): Void
 Close the database connection.
createDatabase(name: String, options: Object): Void
 Create a new database.
createTable(table: String, columns: Array): Void
 Create a new table.
dataTypeToSqlType(dataType: String): String
 Map the database independant data type to a database dependant SQL data type.
destroyDatabase(name: String): Void
 Destroy a database.
destroyTable(table: String): Void
 Destroy a table.
getColumns(table: String): Array
 Get column information.
getTables(): Array
 Return list of tables in a database.
removeColumns(table: String, columns: Array): Void
 Remove columns from a table.
removeIndex(table: String, index: String): Void
 Remove an index.
renameColumn(table: String, oldColumn: String, newColumn: String): Void
 Rename a column.
renameTable(oldTable: String, newTable: String): Void
 Rename a table.
sql(cmd: String): Array
 Execute a SQL command on the database.
sqlTypeToDataType(sqlType: String): String
 Map the SQL type to a database independant data type.
sqlTypeToEjsType(sqlType: String): String
 Map the SQL type to an Ejscript type class.

Method Detail

addColumn(table: String, column: String, datatype: String, options: Object): Void
Description
Add a column to a table.
Parameters
table: String Name of the table.
column: String Name of the column to add.
datatype: String Database independant type of the column. Valid types are: binary, boolean, date, datetime, decimal, float, integer, number, string, text, time and timestamp.
options: Object Optional parameters.
addIndex(table: String, column: String, index: String): Void
Description
Add an index on a column.P.
Parameters
table: String Name of the table.
column: String Name of the column to add.
index: String Name of the index.
changeColumn(table: String, column: String, datatype: String, options: Object): Void
Description
Change a column.
Parameters
table: String Name of the table holding the column.
column: String Name of the column to change.
datatype: String Database independant type of the column. Valid types are: binary, boolean, date, datetime, decimal, float, integer, number, string, text, time and timestamp.
options: Object Optional parameters.
close(): Void
Description
Close the database connection. Database connections should be closed when no longer needed rather than waiting for the garbage collector to automatically close the connection when disposing the database instance.
createDatabase(name: String, options: Object): Void
Description
Create a new database.
Parameters
name: String Name of the database.
options: Object null
Options
OptionalParameters.
createTable(table: String, columns: Array): Void
Description
Create a new table.
Parameters
table: String Name of the table.
columns: Array Array of column descriptor tuples consisting of name:datatype.
dataTypeToSqlType(dataType: String): String
Description
Map the database independant data type to a database dependant SQL data type.
Parameters
dataType: String Data type to map.
Returns
A string containing the name of the the corresponding SQL database type.
destroyDatabase(name: String): Void
Description
Destroy a database.
Parameters
name: String Name of the database to remove.
destroyTable(table: String): Void
Description
Destroy a table.
Parameters
table: String Name of the table to destroy.
getColumns(table: String): Array
Description
Get column information.
Parameters
table: String Name of the table to examine.
Returns
An array of column data. This is database specific content and will vary depending on the database connector in use.
getTables(): Array
Description
Return list of tables in a database.
Returns
An array containing list of table names present in the currently opened database.
removeColumns(table: String, columns: Array): Void
Description
Remove columns from a table.
Parameters
table: String Name of the table to modify.
columns: Array Array of column names to remove.
removeIndex(table: String, index: String): Void
Description
Remove an index.
Parameters
table: String Name of the table to modify.
index: String Name of the index to remove.
renameColumn(table: String, oldColumn: String, newColumn: String): Void
Description
Rename a column.
Parameters
table: String Name of the table to modify.
oldColumn: String Old column name.
newColumn: String New column name.
renameTable(oldTable: String, newTable: String): Void
Description
Rename a table.
Parameters
oldTable: String Old table name.
newTable: String New table name.
sql(cmd: String): Array
Description
Execute a SQL command on the database. This is a low level SQL command interface that bypasses logging. Use.
Parameters
cmd: String SQL command to issue. Note: "SELECT" is automatically prepended and ";" is appended for you.
Returns
An array of row results where each row is represented by an Object hash containing the column names and values.
sqlTypeToDataType(sqlType: String): String
Description
Map the SQL type to a database independant data type.
Parameters
sqlType: String Data type to map.
Returns
The corresponding database independant type.
sqlTypeToEjsType(sqlType: String): String
Description
Map the SQL type to an Ejscript type class.
Parameters
sqlType: String Data type to map.
Returns
The corresponding type class.

Embedthis Software LLC, 2003-2014. All rights reserved. Embedthis is a trademark of Embedthis Software LLC.