public function Insert::execute in Drupal driver for SQL Server and SQL Azure 8.2

Same name and namespace in other branches

1. 8 drivers/lib/Drupal/Driver/Database/sqlsrv/Insert.php \Drupal\Driver\Database\sqlsrv\Insert::execute()
2. 3.0.x drivers/lib/Drupal/Driver/Database/sqlsrv/Insert.php \Drupal\Driver\Database\sqlsrv\Insert::execute()

Executes the insert query.

Return value

The last insert ID of the query, if one exists. If the query was given multiple sets of values to insert, the return value is undefined. If no fields are specified, this method will do nothing and return NULL. That That makes it safe to use in multi-insert loops.

Overrides Insert::execute

File

drivers/lib/Drupal/Driver/Database/sqlsrv/Insert.php, line 58

Definition of Drupal\Driver\Database\sqlsrv\Insert

Class

Insert

Namespace

Drupal\Driver\Database\sqlsrv

Code

public function execute() {
  if (!$this
    ->preExecute()) {
    return null;
  }

  // Check that the table does exist.
  if (!$this->connection
    ->schema()
    ->tableExists($this->table)) {
    throw new \Drupal\Core\Database\SchemaObjectDoesNotExistException("Table {$this->table} does not exist.");
  }

  // Fetch the list of blobs and sequences used on that table.
  $columnInformation = $this->connection
    ->schema()
    ->getTableIntrospection($this->table);

  // Find out if there is an identity field set in this insert.
  $this->setIdentity = !empty($columnInformation['identity']) && in_array($columnInformation['identity'], $this->insertFields);
  $identity = !empty($columnInformation['identity']) ? $columnInformation['identity'] : null;

  // Retrieve query options.
  $options = $this->queryOptions;

  #region Select Based Insert
  if (!empty($this->fromQuery)) {

    // Re-initialize the values array so that we can re-use this query.
    $this->insertValues = [];
    $stmt = $this->connection
      ->prepareQuery((string) $this);

    // Handle the case of SELECT-based INSERT queries first.
    $arguments = $this->fromQuery
      ->getArguments();
    $stmt
      ->BindArguments($arguments);

    // Run the query
    $this->connection
      ->query($stmt, [], $options);

    // We can only have 1 identity column per table (or none, where fetchColumn will fail)
    try {
      return $stmt
        ->fetchColumn(0);
    } catch (\PDOException $e) {
      return null;
    }
  }

  #endregion

  #region Inserts with no values (full defaults)

  // Handle the case of full-default queries.
  if (empty($this->fromQuery) && (empty($this->insertFields) || empty($this->insertValues))) {

    // Re-initialize the values array so that we can re-use this query.
    $this->insertValues = [];
    $stmt = $this->connection
      ->prepareQuery((string) $this);

    // Run the query
    $this->connection
      ->query($stmt, [], $options);

    // We can only have 1 identity column per table (or none, where fetchColumn will fail)
    try {
      return $stmt
        ->fetchColumn(0);
    } catch (\PDOException $e) {
      return null;
    }
  }

  #endregion

  #region Regular Inserts
  $this->inserted_keys = [];

  // Each insert happens in its own query. However, we wrap it in a transaction
  // so that it is atomic where possible.
  $transaction = null;

  // At most we can process in batches of $batch_size.
  $batch = array_splice($this->insertValues, 0, Insert::MAX_BATCH_SIZE);

  // If we are going to need more than one batch for this... start a transaction.
  if (empty($this->queryOptions['sqlsrv_skip_transactions']) && !empty($this->insertValues)) {
    $transaction = $this->connection
      ->startTransaction('', DatabaseTransactionSettings::GetBetterDefaults());
  }
  while (!empty($batch)) {

    // Give me a query with the amount of batch inserts.
    $query = $this
      ->BuildQuery(count($batch));

    // Prepare the query.
    $stmt = $this->connection
      ->prepareQuery($query);

    // We use this array to store references to the blob handles.
    // This is necessary because the PDO will otherwise messes up with references.
    $blobs = [];
    $max_placeholder = 0;
    foreach ($batch as $insert_index => $insert_values) {
      $values = array_combine($this->insertFields, $insert_values);
      $stmt
        ->BindValues($values, $blobs, ':db_insert', $columnInformation, $max_placeholder, $insert_index);
    }

    // Run the query
    $this->connection
      ->query($stmt, [], array_merge($options, array(
      'fetch' => PDO::FETCH_ASSOC,
    )));

    // We can only have 1 identity column per table (or none, where fetchColumn will fail)
    // When the column does not have an identity column, no results are thrown back.
    foreach ($stmt as $insert) {
      try {
        $this->inserted_keys[] = $insert[$identity];
      } catch (\Exception $e) {
        $this->inserted_keys[] = null;
      }
    }

    // Fetch the next batch.
    $batch = array_splice($this->insertValues, 0, Insert::MAX_BATCH_SIZE);
  }

  // If we started a transaction, commit it.
  if ($transaction) {
    $transaction
      ->commit();
  }

  // Re-initialize the values array so that we can re-use this query.
  $this->insertValues = [];

  // Return the last inserted key.
  return empty($this->inserted_keys) ? null : end($this->inserted_keys);

  #endregion
}