tflori/orm

» API Reference » ORM\BulkInsert

ORM\BulkInsert

Table of Contents

• Abstract
• Methods
  • $bulkInsert->__construct - BulkInsert constructor.
  • $bulkInsert->add - Add an entity to the bulk insert.
  • $bulkInsert->finish - Insert the outstanding entities and return all synced objects.
  • $bulkInsert->getLimit - Get the current limit of entities inserted at once.
  • $bulkInsert->limit - Limit the amount of entities inserted at once.
  • $bulkInsert->noAutoIncrement - Disable updating the primary key by auto increment.
  • $bulkInsert->noUpdates - Disable updating entities after insert
  • $bulkInsert->onSync - Executes $callback after insert
  • $bulkInsert->updateEntities - Enable updating entities after insert
  • $bulkInsert->useAutoincrement - Enable updating the primary keys from autoincrement

Abstract

Methods

ORM\BulkInsert::__construct

public function __construct(
    \ORM\Dbal\Dbal $dbal, 
    string $class, 
    int $limit = 20, 
)

BulkInsert constructor.

Parameters

ORM\BulkInsert::__construct

↑ top

ORM\BulkInsert::add

public function add(\ORM\Entity $entities): mixed

Add an entity to the bulk insert.

Parameters

ORM\BulkInsert::add

↑ top

ORM\BulkInsert::finish

public function finish(): \ORM\Entity[]

Insert the outstanding entities and return all synced objects.

ORM\BulkInsert::finish

↑ top

ORM\BulkInsert::getLimit

public function getLimit(): int

Get the current limit of entities inserted at once.

ORM\BulkInsert::getLimit

↑ top

ORM\BulkInsert::limit

public function limit(int $limit): $this

Limit the amount of entities inserted at once.

Parameters

ORM\BulkInsert::limit

↑ top

ORM\BulkInsert::noAutoIncrement

public function noAutoIncrement(): $this

Disable updating the primary key by auto increment.

Caution: If this is disabled updating could cause a IncompletePrimaryKey exception.

ORM\BulkInsert::noAutoIncrement

↑ top

ORM\BulkInsert::noUpdates

public function noUpdates(): $this

Disable updating entities after insert

ORM\BulkInsert::noUpdates

↑ top

ORM\BulkInsert::onSync

public function onSync(callable $callback = null): $this

Executes $callback after insert

Provides an array of the just inserted entities in first argument.

Parameters

ORM\BulkInsert::onSync

↑ top

ORM\BulkInsert::updateEntities

public function updateEntities(): $this

Enable updating entities after insert

Caution: This option will need to update the primary key by autoincrement which maybe is not supported by your db access layer (DBAL).

ORM\BulkInsert::updateEntities

↑ top

ORM\BulkInsert::useAutoincrement

public function useAutoincrement(): $this

Enable updating the primary keys from autoincrement

Caution: Your db access layer (DBAL) may not support this feature.

ORM\BulkInsert::useAutoincrement

↑ top