[Mydatabasepilot-cvs] Docs dbProcess-ShowTables.html,NONE,1.1

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/mydatabasepilot/Docs
In directory sc8-pr-cvs1:/tmp/cvs-serv28197

Added Files:
	dbProcess-ShowTables.html 
Log Message:
New Document Added: dbProcess-ShowTables.html

--- NEW FILE: dbProcess-ShowTables.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 - ShowTables</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 - ShowTables</div>
<p style="text-align: justify;">The listing of available tables in the currently connected database will be handled by the ShowTables dbProcess. This will be the default database process that will be executed after connecting to the datasource.</p>

<div style="font-size: 18px; font-weight: bold; color: #003399; margin: 3px 0px;">Input</div>
<p style="text-align: justify;">The following session variables are either configured in the Application.cfm file, or are provided by the user when filling out the &quot;login to MyDatabase&quot; form. These session variables are used by the required queries to connect to the database.</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>
</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 tableList query in the Query/tableList.cfm file.</p>
<p style="text-align: justify;">See the ShowTables query document for more details.</p>

<div style="font-size: 18px; font-weight: bold; color: #003399; margin: 3px 0px;">Internal Variables</div>
<p style="text-align: justify;">The tableList query creates a recordset with the column name TABLES_IN_MyDatabase where MyDatabase is the name of the database currently in use. Since this variable name is not known until run time, we need a Dynamic Variable name called: TABLES_IN_#dbGeneralInfo.dbInUse#. (The dbGeneralInfo Query is available to all dbProcess, because it is created on the MyDatabasePilot.cfm page before dbProcess handling is initiated.)</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>TABLES_IN_#dbGeneralInfo.dbInUse#</td><td>Dynamic Local</td><td>String</td><td>used to access tableList recordset</td></tr>
</table>

<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/ShowTables.cfm.</p>
<p style="text-align: justify;">A read-only lock will be necessary when accessing session variables needed for href links that pass the session.URLToken variable.</p>
<p style="text-align: justify;">The table listing will include the table name, a link to show table fields and properties, a link to show records in the table, a link to alter the table, a link to drop the table. In addition a link will be provided to create a new table.</p>
</body>
</html>