Differences

This shows you the differences between two versions of the page.

--- dictionary:createtablesql [2015/08/26 00:56] – mnewnham
+++ v5:dictionary:createtablesql [2016/03/05 01:55] (current) – [$tableOptions] mnewnham
@@ Line 3: / Line 3: @@
 <WRAP right box>
 == See Also ==
-[[dictionary:addcolumnsql|addColumnSql()]]
+[[v5:dictionary:column_attributes|Column Attributes Reference]]
+[[v5:dictionary:executesqlarray|executeSqlArray()]]
 == Syntax ==
@@ Line 13: / Line 16: @@
 </WRAP>
 ===== Description =====
-The method ''createTableSql()'' creates the SQL statement necessary to create a table in the database and populates it with columns defined in ''$fields'' option. In order to create the table, the output of the command must be executed with the [[dictionary:executesqlarray|executeSqlArray()]] method.
+The method ''createTableSql()'' creates the SQL statement necessary to create a table in the database and populates it with columns defined in ''$fields'' option. In order to create the table, the output of the command must be executed with the [[v5:dictionary:executesqlarray|executeSqlArray()]] method.
 ===== Parameters =====
 ==== $tableName =====
 The table name must not yet exist in the database. Names must conform to any database specific requirements such as length limitations and name casing.
+---------
+<WRAP right tip 200px>
+$fields is a string, not an array
+</WRAP>
 ==== $fields ====
-A string holding information regarding the columns to create in the new table. For a detailed description of the format of this string, see [[dictionary:addcolumnsql|addColumnSql()]].
+A string holding information regarding the columns to create in the new table. For a detailed description of the format of this string, see [[v5:dictionary:addcolumnsql|addColumnSql()]].
 ==== $tableOptions ====
-An optional array of information that adds information regarding the table creation. This array may also contain field specific information, for example information pertaining to auto-increment fields.
+An optional array of information that adds information regarding the table creation. This array may also contain field specific information, for example information pertaining to auto-increment fields. Another feature of this option is that it can be used to provide database specific options to the table itself, e.g.
+<code php>
+$tabname = 'TEST';
+$flds    = 'column definitions....';
+$opts    = array('MYSQL'=>"ENGINE INNODB,COMPRESSION 'ZLIB'",
+                 'DB2'=>'TABLESPACE LARGE_SPACE');
+$sql = $db->createTableSql($tabname,$flds,$opts);
+</code>
+In the example above, the values provided in ''$opts'' will be added to the table if the **data provider** matches that of the currently attached database.
 ===== Usage =====
 <code php>