[Mydatabasepilot-cvs] Docs dbProcess-ShowFields.html,NONE,1.1
Status: Alpha
Brought to you by:
nanoface
Menu
▾
▴
[Mydatabasepilot-cvs] Docs dbProcess-ShowFields.html,NONE,1.1
|
From: <nan...@us...> - 2003-04-25 22:18:37
|
Update of /cvsroot/mydatabasepilot/Docs In directory sc8-pr-cvs1:/tmp/cvs-serv7132 Added Files: dbProcess-ShowFields.html Log Message: Added New Document: [Task #76520] add dbProcess - ShowFields --- NEW FILE: dbProcess-ShowFields.html --- <?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>MyDatabase Pilot Docs - ALGORITHM ANALYSIS - Database Process - ShowFields</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> </head> <body> <div style="font-size: 24px;font-weight: bold;color: #003399; background-color: #FFFFCC; text-align: center; margin: 3px 0px;">ALGORITHM ANALYSIS<br>Database Process - ShowFields</div> <p style="text-align: justify;">The structure of a particular table is viewable with the ShowFields dbProcess. This database process is available from the output of the ShowTables dbProcess. The ShowTables dbProcess generates a list of tables, each of which has an associated hyper link labelled "View Structure". Clicking on this link will generate a list of fields, with their properties, using the ShowFields dbProcess.</p> <div style="font-size: 18px; font-weight: bold; color: #003399; margin: 3px 0px;">Input</div> <p style="text-align: justify;">The session variables "dataSource", "username", and "password" are either configured in the Application.cfm file, or are provided by the user when filling out the "login to MyDatabase" form. These session variables are used by the required queries to connect to the database.</p> <p style="text-align: justify;">The URL variable "table" is passed to the ShowFields dbProcess when clicking the hyper link "View Structure" on the ShowTables dbProcess page.</p> <table width="100%" border="1" cellspacing="2" cellpadding="2"> <tr><th>Var Name</th><th>Scope</th><th>Type</th><th>Description</th></tr> <tr><td>dataSource</td><td>Session</td><td>String</td><td>Connection variable for current datasource</td></tr> <tr><td>userName</td><td>Session</td><td>String</td><td>Connection variable for current user name</td></tr> <tr><td>password</td><td>Session</td><td>String</td><td>Connection variable for current password</td></tr> <tr><td>table</td><td>URL</td><td>String</td><td>Name of the table for which user has requested the ShowFields dbProcess</td></tr> </table> <div style="font-size: 18px; font-weight: bold; color: #003399; margin: 3px 0px;">Query</div> <p style="text-align: justify;">The query component of the ShowTables dbProcess will be handled by the fieldList query in the Query/fieldList.cfm file.</p> <p style="text-align: justify;">See the fieldList query document for more details.</p> <div style="font-size: 18px; font-weight: bold; color: #003399; margin: 3px 0px;">Output</div> <p style="text-align: justify;">The output component of the ShowTables dbProcess will be handled by the include file dbProcessBody/ShowFields.cfm.</p> <p style="text-align: justify;">The table name will be displayed followed by a listing of fields within that table along with their properties. The field listing will include the field name, key, data type, null value allowed, default value, and extra properties.</p> <table width="100%" border="1" cellspacing="2" cellpadding="2"> <tr><th>Var Name</th> <th>Scope</th> <th>Type</th> <th>Description</th></tr> <tr><td>table</td> <td>URL</td> <td>String</td> <td>Name of the table for which user has requsted the ShowFields dbProcess</td></tr> <tr><td>fieldList.FIELD</td> <td>Query</td> <td>String</td> <td>Field Name</td></tr> <tr><td>fieldList.KEY</td> <td>Query</td> <td>String</td> <td>Primary key or any other key designation for field</td></tr> <tr><td>fieldList.TYPE</td> <td>Query</td> <td>String</td> <td>Data type of field</td></tr> <tr><td>fieldList.NULL</td> <td>Query</td> <td>String</td> <td>Are null values allowed in field</td></tr> <tr><td>fieldList.DEFAULT</td> <td>Query</td> <td>String</td> <td>Default value of field</td></tr> <tr><td>fieldList.EXTRA</td> <td>Query</td> <td>String</td> <td>Extra properties such as auto_ increment associated with field</td></tr> </table> </body> </html> |
