Differences

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

--- v5:userguide:userguide_index [2016/03/19 03:43] – [Example 6: Connecting to 2 Databases At Once] mnewnham
+++ v5:userguide:userguide_index [2020/01/13 15:50] (current) – Remove NOTOC dregad
@@ Line 1: / Line 1: @@
-<WRAP todo>
-This page is under reconstruction
-</WRAP>
 <WRAP right box>
 [[v5:userguide:index|User Guide Index]]\\
 </WRAP>
-~~NOTOC~~
 ====== User Guide ======
 ===== List Of Tutorials =====
 ==== Basic Tasks ====
-|[[v5:userguide:learn_abstraction:introduction|Database Abstraction]]|Using basic ADOdb commands to read data from and write back to the database|
+<WRAP>
-|[[v5:userguide:learn_dictionary:introduction|Data Dictionary Basics]]|How to obtain information about database fields, columns and tables|
+<wrap left 180px>[[v5:userguide:learn_abstraction:introduction|Database Abstraction]]</wrap>
-|[[v5:userguide:learn_fields:introduction|Keys,Fields & Field Objects]]|Understanding how to work with the most detailed level of data provided by ADOdb|
+<wrap left 450px>Using basic ADOdb commands to read data from and write back to the database</wrap>
+</WRAP>
+--------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:learn_dictionary:introduction|Data Dictionary Basics]]</wrap>
+<wrap left 450px>How to obtain information about database fields, columns and tables</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:learn_fields:introduction|Keys,Fields & Field Objects]]</wrap>
+<wrap left 450px>Understanding how to work with the most detailed level of data provided by ADOdb</wrap>
+</WRAP>
+-------------------------------
 ==== Advanced Tasks ====
-| [[v5:userguide:transactions|Transactions]]                                 | Understanding Transaction scope, and how to start, stop and roll back transactions     |
+<WRAP>
-| [[v5:userguide:learn_multidatabase:connections|Multi Database Connections]]            | Controlling connections and transactional scoping in multiple databases simultaneously  |
+<wrap left 180px>[[v5:userguide:transactions|Transactions]]</wrap>
-| [[v5:userguide:learn_extensions:new_driver|Creating & Extending Drivers]]  | Adding new functionality and changing the behaviour of existing drivers                |
+<wrap left 450px>Understanding Transaction scope, and how to start, stop and roll back transactions </wrap>
-===== Additional Documentation =====
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:learn_bind:bind_vars|Parameter Binding]]</wrap>
+<wrap left 450px>Understanding variable binding, portability and bulk insertions</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:learn_multidatabase:connections|Multi Database Connections]]</wrap>
+<wrap left 450px>Controlling connections and transaction scoping in multiple databases simultaneously</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:learn_caching:introduction|Result Set Caching]]</wrap>
+<wrap left 450px>Caching queries to speed up re-use, via Disk or Memcached caching</wrap>
+</WRAP>
+---------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:learn_extensions:new_driver|Creating & Extending Drivers]]</wrap>
+<wrap left 450px>Adding new functionality and changing the behaviour of existing drivers</wrap>
+</WRAP>
+--------------------------
-[[v5:reference:reference_index|Reference Guide]]\\
-[[project:include_file_guide|Include File Guide]]\\
-[[v5:userguide:portable_sql|Writing Portable SQL]]\\
-[[v5:userguide:mysql_tutorial|Migrating MySQL applications to ADOdb]]\\
-[[v5:userguide:error_handling|Customizing Error Handling]]\\
-[[v5:userguide:stored_procedure|Stored Procedure Example]]\\
-[[v5:userguide:deprecated|Deprecated Functionality]]\\
-===== Example 3: Inserting =====
-Insert a row to the Orders table containing dates and strings that need to be quoted before they can be accepted by the database, eg: the single-quote in the word John's.
-<code php>
-include('adodb.inc.php');    # load code common to ADOdb
-$conn = adoONewConnection('access');        # create a connection
-$conn->pConnect('northwind');   # connect to MS-Access, northwind dsn
-/*
-* Inserting a string containing quote characters
-* may cause a statement to fail if not pre-processed
-*/
-$shipto = $conn->qstr("John's Old Shoppe");
-$orderDate = $conn->dbDate(time());
-$sql = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";
-$sql .= "values ('ANATR',2,".$orderDate.",$shipto)";
-if ($conn->Execute($sql) === false)
-    print 'error inserting: '.$conn->errorMsg().'<BR>';
-</code>
-In this example, we see the advanced date and quote handling facilities of ADOdb. The unix timestamp (which is a long integer) is appropriately formatted for Access with [[v5:reference:connection:dbdate|dBDate()]]. Note that the date field should not be quoted. If required by the database, the field will be automatically quoted.
-The correct escape character is used for quoting the John's Old Shoppe, which is John``s Old Shoppe and not PHP's default John's Old Shoppe by using [[v5:reference:connection:qstr|qStr()]].
-Observe the error-handling of the Execute statement. False is returned by Execute() if an error occurred. The error message for the last error that occurred is displayed in [[v5:reference:connection:errormsg|errorMsg()]]. Note: php_track_errors might have to be enabled for error messages to be saved.
-===== Example 4: Debugging =====
-<code php>
-include 'adodb.inc.php';    # load code common to ADOdb
-$conn = adoNewConnection('access');# create a connection
-$conn->PConnect('northwind');   # connect to MS-Access, northwind dsn
-$shipto = $conn->qstr("John's Old Shoppe");
-$sql = "insert into orders (customerID,EmployeeID,OrderDate,ShipName)
-                    values ('ANATR',2,".$conn->FormatDate(time()).",$shipto)";
-$conn->debug = true;
-if ($conn->Execute($sql) === false) print 'error inserting';
-</code>
-In the above example, we have turned on debugging by setting debug = true. This will display the SQL statement before execution, and also show any error messages. There is no need to call ErrorMsg() in this case. For displaying the recordset, see the rs2html() example.
-For more detailed information on error handling, see the section on [[v5:userguide:debug|debugging]]
-===== $ADODB_FORCE_TYPE =====
-The behaviour of [[v5:reference:connection:autoexecute|AutoExecute()]], [[v5:reference:connection:getupdatesql|GetUpdateSQL()]] and [[v5:reference:connection:getinsertsql|GetInsertSQL()]] when converting empty or null PHP variables to SQL is controlled by the global [[v5:reference:adodb_force_type|$ADODB_FORCE_TYPE]] variable.
-===== Example 8: Implementing Scrolling with Next and Previous ====
-The following code creates a very simple recordset pager, where you can scroll from page to page of a recordset.
-<code php>
-include_once('../adodb.inc.php');
-include_once('../adodb-pager.inc.php');
-session_start();
-$db = NewADOConnection('mysql');
-$db->Connect('localhost','root','','xphplens');
-$sql = "select * from adoxyz ";
-$pager = new ADODB_Pager($db,$sql);
-$pager->Render($rows_per_page=5);
-</code>
-This will create a basic record pager that looks like this:
-    |<   <<   >>   >|
-  ^ID^First Name^Last Name^Date Created^
-  |36|Alan|Turing|Sat 06, Oct 2001|
-  |37|Serena|Williams|Sat 06, Oct 2001|
-  |38|Yat Sun|Sun|Sat 06, Oct 2001|
-  |39|Wai Hun|See|Sat 06, Oct 2001|
-  |40|Steven|Oey|Sat 06, Oct 2001|
-  Page 8/10
-The number of rows to display at one time is controled by the Render($rows) method. If you do not pass any value to Render(), ADODB_Pager will default to 10 records per page.
-You can control the column titles by modifying your SQL (supported by most databases):
-<code php>
-$sql = 'select id as "ID",
-       firstname as "First Name",
-       lastname as "Last Name",
-       created as "Date Created"
-       from adoxyz';
-</code>
-The above code can be found in the adodb/tests/testpaging.php example included with this release, and the class ADODB_Pager in adodb/adodb-pager.inc.php. The ADODB_Pager code can be adapted by a programmer so that the text links can be replaced by images, and the dull white background be replaced with more interesting colors.
-You can also allow display of html by setting $pager->htmlSpecialChars = false.
-Some of the code used here was contributed by Iván Oliva and Cornel G.
+===== Additional Documentation =====
+<WRAP>
+<wrap left 180px>[[v5:database:connection_matrix]]</wrap>
+<wrap left 450px>A guide to establishing connections across the supported databases</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[project:include_file_guide|Include File Guide]]</wrap>
+<wrap left 450px>Include file requirements for the various features</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:portable_sql|Writing Portable SQL]]</wrap>
+<wrap left 450px>Limiting SQL statements to ensure cross database portability</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:mysql_tutorial]]</wrap>
+<wrap left 450px>How to migrate database specific applications to ADOdb</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:error_handling|Customizing Error Handling]]</wrap>
+<wrap left 450px>Trapping and redirecting database errors using exceptions</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:stored_procedure|Stored Procedure Example]]</wrap>
+<wrap left 450px>How to use stored procedures in the supported databases</wrap>
+</WRAP>
+-----------------------------
+<WRAP>
+<wrap left 180px>[[v5:database:feature_comparison|Feature Comparison Matrix]]</wrap>
+<wrap left 450px>Supported database feature</wrap>
+</WRAP>
+----------------------------
+<WRAP>
+<wrap left 180px>[[v5:userguide:deprecated|Deprecated Functionality]]</wrap>
+<wrap left 450px>Unsupported features</wrap>
+</WRAP>