Differences

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

--- dictionary:createtablesql [2015/08/23 22:13] – created mnewnham
+++ dictionary:createtablesql [2015/08/26 00:56] – mnewnham
@@ Line 1: / Line 1: @@
 ====== createTableSql ======
+~~NOTOC~~
 <WRAP right box>
 == See Also ==
@@ Line 5: / Line 6: @@
 == Syntax ==
-  string createTableSql (
+  array createTableSql (
       string $tableName,
       string $fields,
@@ Line 12: / Line 13: @@
 </WRAP>
 ===== Description =====
-The method ''createTableSql()'' creates a new table in the database and populates it with columns defined in ''$fields'' option.
+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.
 ===== Parameters =====
 ==== $tableName =====
@@ Line 23: / Line 25: @@
 ===== Usage =====
 <code php>
+/*
+* create a data dictionary object, using the database connection
-# Then create a data dictionary object, using this connection
+*/
 $dict = NewDataDictionary($db);
@@ Line 37: / Line 39: @@
 /*
-* create the SQL statement necessary to create the table
+* create the SQL statement necessary to create the table and its columns
 */
 $sqlarray = $dict->createTableSQL($tabname, $flds);
+/*
+ * This returns (for DB2)
+Array
+(
+    [0] => CREATE TABLE UCTABLE (
+           COL1         VARCHAR(32) DEFAULT 'abc' NOT NULL,
+           COL2         INTEGER DEFAULT 0,
+           COL3         DECIMAL(12,2)
+           )
+)
+*/
 /*
@@ Line 45: / Line 60: @@
 */
 $dict->executeSqlArray($sqlarray);
-</code>
 </code>