1. class
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. Queries
  7. \
  8. SQLInsert

SQLInsert

class SQLInsert extends SQLExpression implements SQLWriteExpression

Object representing a SQL INSERT query.

The various parts of the SQL query can be manipulated individually.

Methods

replaceText(string $old, string $new)

Swap some text in the SQL query with another.

from SQLExpression
string
__toString()

Return the generated SQL string for this query

from SQLExpression
renameTable(string $old, string $new)

Swap the use of one table with another.

from SQLExpression
bool
isEmpty()

Determine if this query is empty, and thus cannot be executed

string
sql(array $parameters = array())

Generate the SQL statement for this query.

from SQLExpression
Query
execute()

Execute this query.

from SQLExpression
static SQLInsert
create(string $into = null, array $assignments = array())

Construct a new SQLInsert object

__construct(string $into = null, array $assignments = array())

Construct a new SQLInsert object

$this
setInto(string $into)

Sets the table name to insert into

string
getInto()

Gets the table name to insert into

$this
addRow(array|SQLAssignmentRow $data = null)

Appends a new row to insert

SQLAssignmentRow[]
getRows()

Returns the current list of rows

array
getColumns()

Returns the list of distinct column names used in this insert

$this
setRows(array $rows)

Sets all rows to the given array

$this
addRows(array $rows)

Adds the list of rows to the array

SQLAssignmentRow|false
currentRow(boolean $create = false)

Returns the currently set row

$this
addAssignments(array $assignments)

Adds assignments for a list of several fields.

$this
setAssignments(array $assignments)

Sets the list of assignments to the given list

array
getAssignments()

Retrieves the list of assignments in parameterised format

$this
assign(string $field, mixed $value)

Set the value for a single field

$this
assignSQL(string $field, string $sql)

Assigns a value to a field using the literal SQL expression, rather than a value to be escaped

$this
clearRow()

Clears all currently set assigment values on the current row

$this
clear()

Clears all rows

Details

in SQLExpression at line 39
replaceText(string $old, string $new)

Swap some text in the SQL query with another.

Note that values in parameters will not be replaced

Parameters

string $old The old text (escaped)
string $new The new text (escaped)

in SQLExpression at line 52
string __toString()

Return the generated SQL string for this query

Return Value

string

in SQLExpression at line 71
renameTable(string $old, string $new)

Swap the use of one table with another.

Parameters

string $old Name of the old table (unquoted, escaped)
string $new Name of the new table (unquoted, escaped)

at line 76
bool isEmpty()

Determine if this query is empty, and thus cannot be executed

Return Value

bool Flag indicating that this query is empty

in SQLExpression at line 91
string sql(array $parameters = array())

Generate the SQL statement for this query.

Parameters

array $parameters Out variable for parameters required for this query

Return Value

string The completed SQL query

in SQLExpression at line 112
Query execute()

Execute this query.

Return Value

Query

at line 35
static SQLInsert create(string $into = null, array $assignments = array())

Construct a new SQLInsert object

Parameters

string $into Table name to insert into (ANSI quoted)
array $assignments List of column assignments

Return Value

SQLInsert

at line 46
__construct(string $into = null, array $assignments = array())

Construct a new SQLInsert object

Parameters

string $into Table name to insert into (ANSI quoted)
array $assignments List of column assignments

at line 60
$this setInto(string $into)

Sets the table name to insert into

Parameters

string $into Single table name (ANSI quoted)

Return Value

$this The self reference to this query

at line 71
string getInto()

Gets the table name to insert into

Return Value

string Single table name

at line 87
$this addRow(array|SQLAssignmentRow $data = null)

Appends a new row to insert

Parameters

array|SQLAssignmentRow $data A list of data to include for this row

Return Value

$this The self reference to this query

at line 108
SQLAssignmentRow[] getRows()

Returns the current list of rows

Return Value

SQLAssignmentRow[]

at line 118
array getColumns()

Returns the list of distinct column names used in this insert

Return Value

array

at line 133
$this setRows(array $rows)

Sets all rows to the given array

Parameters

array $rows the list of rows

Return Value

$this The self reference to this query

at line 144
$this addRows(array $rows)

Adds the list of rows to the array

Parameters

array $rows the list of rows

Return Value

$this The self reference to this query

at line 158
SQLAssignmentRow|false currentRow(boolean $create = false)

Returns the currently set row

Parameters

boolean $create Flag to indicate if a row should be created if none exists

Return Value

SQLAssignmentRow|false The row, or false if none exists

at line 167
$this addAssignments(array $assignments)

Adds assignments for a list of several fields.

For multi-row objects this applies this to the current row.

Note that field values must not be escaped, as these will be internally parameterised by the database engine.

// Basic assignments $query->addAssignments(array( '"Object"."Title"' => 'Bob', '"Object"."Description"' => 'Bob was here' ))

// Parameterised assignments $query->addAssignments(array( '"Object"."Title"' => array('?' => 'Bob')), '"Object"."Description"' => array('?' => null)) ))

// Complex parameters $query->addAssignments(array( '"Object"."Score"' => array('MAX(?,?)' => array(1, 3)) ));

// Assigment of literal SQL for a field. The empty array is // important to denote the zero-number paramater list $query->addAssignments(array( '"Object"."Score"' => array('NOW()' => array()) ));

Parameters

array $assignments The list of fields to assign

Return Value

$this Self reference

at line 173
$this setAssignments(array $assignments)

Sets the list of assignments to the given list

For multi-row objects this applies this to the current row.

Parameters

array $assignments

Return Value

$this Self reference

at line 179
array getAssignments()

Retrieves the list of assignments in parameterised format

For multi-row objects returns assignments for the current row.

Return Value

array List of assigments. The key of this array will be the column to assign, and the value a parameterised array in the format array('SQL' => array(parameters));

at line 184
$this assign(string $field, mixed $value)

Set the value for a single field

For multi-row objects this applies this to the current row.

E.g.

// Literal assignment $query->assign('"Object"."Description"', 'lorum ipsum'));

// Single parameter $query->assign('"Object"."Title"', array('?' => 'Bob'));

// Complex parameters $query->assign('"Object"."Score"', array('MAX(?,?)' => array(1, 3));

Parameters

string $field The field name to update
mixed $value The value to assign to this field. This could be an array containing a parameterised SQL query of any number of parameters, or a single literal value.

Return Value

$this Self reference

at line 190
$this assignSQL(string $field, string $sql)

Assigns a value to a field using the literal SQL expression, rather than a value to be escaped

For multi-row objects this applies this to the current row.

Parameters

string $field The field name to update
string $sql The SQL to use for this update. E.g. "NOW()"

Return Value

$this Self reference

at line 201
$this clearRow()

Clears all currently set assigment values on the current row

Return Value

$this The self reference to this query

at line 212
$this clear()

Clears all rows

Return Value

$this The self reference to this query