classes/phing/tasks/ext/pdo/PDOSQLExecTask.php

Global
Classes
- \PDOSQLExecTask
- \PDOSQLExecTransaction

\PDOSQLExecTask
jump to top

Executes a series of SQL statements on a database using PDO.

Statements can either be read in from a text file using the src attribute or from between the enclosing SQL tags.

Multiple statements can be provided, separated by semicolons (or the defined delimiter). Individual lines within the statements can be commented using either --, // or REM at the start of the line.

The autocommit attribute specifies whether auto-commit should be turned on or off whilst executing the statements. If auto-commit is turned on each statement will be executed and committed. If it is turned off the statements will all be executed as one transaction.

The onerror attribute specifies how to proceed when an error occurs during the execution of one of the statements. The possible values are: continue execution, only show the error; stop execution and commit transaction; and abort execution and transaction and fail task.

Extends from: \PDOTask
author: Hans Lellelid (Phing)
author: Jeff Martin (Ant)
author: Michael McCallum (Ant)
author: Tim Stephenson (Ant)
copyright: 2001,2002 THYRELL. All rights reserved
package: phing.tasks.ext.pdo
version: $Revision: 1274 $

Constants

 
                DELIM_ROW
                = 'row'

 
                DELIM_NORMAL
                = 'normal'

Properties

\PDO
                 $conn= 'null'

Database connection

Default valuenullDetails

Type: \PDO

string
                 $delimiter= ';'

SQL Statement delimiter (for parsing files)

Default value;Details

Type: string


                 $delimiterType= 'normal'

The delimiter type indicating whether the delimiter will only be recognized on a line by itself

Default valuenormalDetails

Type


                 $encoding= 'null'

Encoding to use when reading SQL statements from a file

Default valuenullDetails

Type

int
                 $fetchMode= ''

Fetch mode for PDO select queries.

Details

Type: int

array
                 $filelists= 'array'

Files to load

FileList[]

Default valuearrayDetails

Type: array

array
                 $filesets= 'array'

Files to load

FileSet[]

Default valuearrayDetails

Type: array

array
                 $formatters= 'array'

Formatter elements.

PDOSQLExecFormatterElement[]

Default valuearrayDetails

Type: array

int
                 $goodSql= '0'

Count of how many statements were executed successfully.

Default value0Details

Type: int


                 $onError= 'abort'

Action to perform if an error is found

Default valueabortDetails

Type

string
                 $sqlCommand= ''

SQL input command

Details

Type: string

\PhingFile
                 $srcFile= ''

SQL input file

Details

Type: \PhingFile

\PDOStatement
                 $statement= ''

SQL statement

Details

Type: \PDOStatement

int
                 $totalSql= '0'

Count of total number of SQL statements.

Default value0Details

Type: int


                 $transactions= 'array'

SQL transactions to perform

Default valuearrayDetails

Type

Methods

 
            addFilelist(
           $list
          )
        
        :

Adds a set of files (nested filelist attribute).

Parameters

Name	Type	Description
$list

 
            addFileset(
           $set
          )
        
        :

Adds a set of files (nested fileset attribute).

Parameters

Name	Type	Description
$set

 
            addText(
           $sql
          )
        
        :

Set an inline SQL command to execute.

NB: Properties are not expanded in this text.

Parameters

Name	Type	Description
$sql

 
            closeConnection(
          
          )
        
        :

Closes current connection

 
            closeFormatters(
          
          )
        
        :

Run cleanup and close formatters.

 
            createFormatter(
          
          )
        
        :
        \PDOSQLExecFormatterElement

Creates a new PDOSQLExecFormatterElement for element.

Returns

Type	Description
\PDOSQLExecFormatterElement

 
            createTransaction(
          
          )
        
        :

Add a SQL transaction to execute

 
            execSQL(
           $sql
          )
        
        :

Exec the sql statement.

Parameters

Name	Type	Description
$sql

Details

throws

 
            getConfiguredFormatters(
          
          )
        
        :
        array

Returns configured PDOResultFormatter objects (which were created from PDOSQLExecFormatterElement objects).

Returns

Type	Description
array

 
            getDefaultOutput(
          
          )
        
        :
        \Writer

Gets a default output writer for this task.

Returns

Type	Description
\Writer

 
            getDelimiter(
          
          )
        
        :
        string

Get the statement delimiter.

Returns

Type	Description
string

 
            initFormatters(
          
          )
        
        :

Initialize the formatters.

 
            isSelectSql(
          string $sql
          )
        
        :
        boolean

Whether the passed-in SQL statement is a SELECT statement.

This does a pretty simple match, checking to see if statement starts with 'select' (but not 'select into').

Parameters

Name	Type	Description
$sql	string

Returns

Type	Description
boolean

Load the sql file and then execute it

Details

throws

 
            processResults(
          
          )
        
        :

Passes results from query to any formatters.

Details

throws

 
            runStatements(
           $reader
          )
        
        :

read in lines and execute them

Parameters

Name	Type	Description
$reader

Details

throws: IOException

 
            setDelimiter(
           $delimiter
          )
        
        :

Set the statement delimiter.

For example, set this to "go" and delimitertype to "ROW" for Sybase ASE or MS SQL Server.

Parameters

Name	Type	Description
$delimiter		delimiter

 
            setDelimiterType(
          string $delimiterType
          )
        
        :

Set the Delimiter type for this sql task. The delimiter type takes two values - normal and row. Normal means that any occurence of the delimiter terminate the SQL command whereas with row, only a line containing just the delimiter is recognized as the end of the command.

Parameters

Name	Type	Description
$delimiterType	string

 
            setEncoding(
          \encoding $encoding
          )
        
        :

Set the file encoding to use on the SQL files read in

Parameters

Name	Type	Description
$encoding	\encoding	the encoding to use on the files

 
            setFetchmode(
          mixed $mode
          )
        
        :

Sets the fetch mode to use for the PDO resultset.

Parameters

Name	Type	Description
$mode	mixed	The PDO fetchmode integer or constant name.

 
            setOnerror(
           $action
          )
        
        :

Action to perform when statement fails: continue, stop, or abort optional; default "abort"

Parameters

Name	Type	Description
$action

 
            setSrc(
           $srcFile
          )
        
        :

Set the name of the SQL file to be run.

Required unless statements are enclosed in the build file

Parameters

Name	Type	Description
$srcFile

\PDOSQLExecTransaction
jump to top

"Inner" class that contains the definition of a new transaction element.

Transactions allow several files or blocks of statements to be executed using the same JDBC connection and commit operation in between.

package: phing.tasks.ext.pdo

Properties


                 $parent= ''

Details

Type


                 $tSqlCommand= ''

Details

Type


                 $tSrcFile= 'null'

Default valuenullDetails

Type

Methods

 
            __construct(
           $parent
          )
        
        :

Parameters

Name	Type	Description
$parent

 
            addText(
           $sql
          )
        
        :

Parameters

Name	Type	Description
$sql

 
            runTransaction(
          
          )
        
        :

Details

throws: PDOException

Parameters

Name	Type	Description
$src

classes/phing/tasks/ext/pdo/PDOSQLExecTask.php

\PDOSQLExecTaskjump to top

Constants

Properties

Methods

\PDOSQLExecTransactionjump to top

Properties

Methods

\PDOSQLExecTask
jump to top

\PDOSQLExecTransaction
jump to top