ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools

Trace:
v5:reference:connection:autoexecute

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
reference:autoexecute [2015/12/19 17:23] – mnewnhamv5:reference:connection:autoexecute [2021/01/25 03:07] (current) – mnewnham
Line 1: Line 1:
 +====== autoExecute ======
 +<WRAP info>
 +autoExecute is designed to provide a robust simple interface to record updating and insertion. As such, it contains multiple layers of table, column and data validation to ensure data integrity prior to record insertion or update. Consequently, there may be some performance degradation when used for large numbers of record updates. Consider using [[v5:reference:connection:execute|execute()]] for that purpose instead.
 +</WRAP>
 +~~NOTOC~~
 +<WRAP right box>
 +== See Also ==
 +[[v5:reference:adodb_quote_fieldnames|$ADODB_QUOTE_FIELDNAMES]]
 +== Syntax ==
 +    bool autoExecute(
 +       string $tables,
 +       string[] $arrFields,
 +       string $mode,
 +       optional mixed $where=false
 +       optional bool $forceUpdate=false
 +       )
  
 +</WRAP>
 +
 +
 +===== Description =====
 +The function ''autoExecute()'' can automatically generate and execute INSERT and UPDATE statements on a given table with this function, and is a wrapper for [[v5:reference:connection:getinsertsql|getInsertSQL()]] and [[v5:reference:connection:getupdatesql|getUpdateSQL()]]
 +
 +autoExecute() inserts or updates **$table** given an array of **$arrFields**, where the keys are the field names and the array values are the field values to store. Note that there is some overhead because the table is first queried to extract key information before the SQL is generated. An INSERT or UPDATE is generated based on **$mode** (see below). 
 +
 +==== $table ====
 +The name of the table to update
 +
 +==== $arrFields ====
 +An associative array of field=>value pairs
 +
 +==== $mode =====
 +Legal values for ` $mode ` are 
 +
 +^String^Integer^Constant^
 +|INSERT|1|DB_AUTOQUERY_INSERT|
 +|UPDATE|2|DB_AUTOQUERY_UPDATE| 
 +
 +==== $where ====
 +The $where clause is required if $mode == 'UPDATE'. 
 +
 +==== $forceUpdate ====
 +
 +^Value^Description^Overhead^
 +|false|(default). Only fields that have been modified are updated|The database record is re-read before update|
 +|true|All fields provided are updated|The constructed statement may be considerably larger|
 + 
 +==== Usage ====
 +<code php>
 +autoExecute($table, $arrFields, $mode, $where=false, $forceUpdate=true)
 +</code>
 +
 +=== Insert example ===
 +<code php>
 +$table               = 'people'
 +$record["first_name"] = "Carol";
 +$record["last_name"]  = "Smith"; 
 +
 +$conn->autoExecute($table,$record,'INSERT');
 +
 +/*
 + * result executes "INSERT INTO people (first_name,last_name) values ('Carol',Smith')";
 + */
 +</code>
 +
 +=== Update example ===
 +<code php>
 +$table               = 'people'
 +$record["first_name"] = 'Carol';
 +$record["last_name"]  = 'Jones'; 
 +$where               = "last_name like 'Sm%'";
 +
 +$conn->autoExecute($table,$record,'UPDATE', $where);
 +
 +/*
 + * result executes "UPDATE people SET first_name='Carol',last_name='Jones' WHERE last_name like 'Sm%'";
 + */
 +</code>
 +
 +In situations where the table names contain certain special characters, such as dashes, the [[v5:reference:adodb_quote_fieldnames|$ADODB_QUOTE_FIELDNAMES]] setting can be used to wrap the table and field names.
 +
 +<code php>
 +$ADODB_QUOTE_FIELDNAMES = 'NATIVE';
 +$table               = 'people'
 +$record["first-name"] = 'Carol';
 +$record["last-name"]  = 'Jones'; 
 +$where               = "last_name like 'Sm%'";
 +
 +$conn->autoExecute($table,$record,'UPDATE', $where);
 +
 +/*
 + * result executes "UPDATE `people` SET `first-name`='Carol',`last-name`='Jones' WHERE `last-name` like 'Sm%'";
 + */
 +</code>