Operations · 4 min read

BulkInsert

This method inserts all rows from the client application into the database in bulk. It is supported for CockroachDB.

Call Flow Diagram

The diagram below shows the flow when calling this operation.

flowchart TD
    Client["Client<br/>(RepoDB)"] -->|BulkInsert| Source["Entities /<br/>DataTable /<br/>DbDataReader"]
    Source --> Decision{"identityBehavior ==<br/>ReturnIdentity?"}
    Decision -->|NO| Direct["CockroachDbBulkCopy"]
    Direct -->|Write| Table[("Target Table")]
    Decision -->|YES| Pseudo["Create Pseudo Table<br/>(Memory by default)"]
    Pseudo --> Staged["CockroachDbBulkCopy"]
    Staged -->|Write| PseudoTable[("Pseudo Table")]
    PseudoTable --> Insert["INSERT INTO ... SELECT ...<br/>FROM Pseudo ORDER BY row order<br/>RETURNING identity"]
    Insert --> Table
    Insert -->|"assign identities<br/>back to entities"| Client
    PseudoTable -->|Drop| Cleanup(["Pseudo Table Dropped"])

Use Case

Use this method to insert rows at high speed. It leverages CockroachDbBulkCopy, a native binary COPY-based bulk writer from RepoDb.Connector.CockroachDb.

For inserting 1,000 or more rows, prefer this method over InsertAll.

Rows are written straight to the target table. A staging table is only used when identityBehavior is set to ReturnIdentity (see below) — see Operations (CockroachDB) for the underlying mechanics.

Special Arguments

The mappings, bulkCopyTimeout, batchSize, identityBehavior and pseudoTableType arguments are available for this operation.

mappings (via CockroachDbBulkInsertMapItem) defines explicit column mappings between the source properties and the destination columns, with an optional CockroachDbType override per mapping. When omitted, columns are auto-mapped by name (case-insensitive).

bulkCopyTimeout overrides the command timeout, in seconds.

batchSize overrides the number of rows sent to the server per batch. When not set, all items are sent at once.

identityBehavior (via CockroachDbBulkImportIdentityBehavior) controls whether newly generated identity values are set back on the data entities. Disabled (KeepIdentity) by default. Enabling this (ReturnIdentity) routes the operation through a staging table instead, reading the generated identity values back via a RETURNING clause appended to the same INSERT statement.

pseudoTableType (via CockroachDbBulkImportPseudoTableType) controls the kind of staging table used when identityBehavior is ReturnIdentity.

The DbDataReader overload has no identityBehavior argument — a forward-only, single-pass reader cannot be rewound to correlate generated identity values back onto a source row, so ReturnIdentity is not supported for that overload.

Identity Setting Alignment

When identityBehavior is ReturnIdentity, the library adds an __RepoDbBulkRowOrder__ identity column to the pseudo table to track each entity’s position in the source IEnumerable. The staged rows are then fed into the real INSERT ordered by that column, and the generated identities are read back — in the same statement — via RETURNING identity, then assigned back to the correct entity by that row order.

Usability

The following example defines a method that produces a list of Person objects, then bulk-inserts 10,000 rows into the Person table.

private IEnumerable<Person> GetPeople(int count = 1000)
{
    for (var i = 0; i < count; i++)
    {
        yield return new Person
        {
            Name = $"Person-{i}",
            IsActive = true,
            CreatedDateUtc = DateTime.UtcNow
        };
    }
}

using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    var insertedRows = connection.BulkInsert(people);
}

To specify a batch size:

using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    var insertedRows = connection.BulkInsert(people, batchSize: 100);
}

When batchSize is not set, all rows are sent to the server in a single batch.

To return the newly generated identity values:

using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    var insertedRows = connection.BulkInsert(people,
        identityBehavior: CockroachDbBulkImportIdentityBehavior.ReturnIdentity);
}

DataTable

using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    var table = ConvertToDataTable(people);
    var insertedRows = connection.BulkInsert("Person", table);
}

Dictionary/ExpandoObject

using (var sourceConnection = new CockroachDbConnection(sourceConnectionString))
{
    var result = sourceConnection.QueryAll("Person");
    using (var destinationConnection = new CockroachDbConnection(destinationConnectionString))
    {
        var insertedRows = destinationConnection.BulkInsert("Person", result);
    }
}

DataReader

using (var sourceConnection = new CockroachDbConnection(sourceConnectionString))
{
    using (var reader = sourceConnection.ExecuteReader("SELECT * FROM \"Person\";"))
    {
        using (var destinationConnection = new CockroachDbConnection(destinationConnectionString))
        {
            var rows = destinationConnection.BulkInsert("Person", reader);
        }
    }
}

To bulk-insert via DataEntityDataReader:

using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    using (var reader = new DataEntityDataReader<Person>(people))
    {
        var insertedRows = connection.BulkInsert("Person", reader);
    }
}

Column Mappings

Add column mappings using the CockroachDbBulkInsertMapItem class.

var mappings = new List<CockroachDbBulkInsertMapItem>();

// Add the mappings
mappings.Add(new CockroachDbBulkInsertMapItem("SourceId", "DestinationId"));
mappings.Add(new CockroachDbBulkInsertMapItem("SourceName", "DestinationName"));
mappings.Add(new CockroachDbBulkInsertMapItem("SourceIsActive", "DestinationIsActive"));

// Execute
using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    var insertedRows = connection.BulkInsert(people,
        mappings: mappings);
}

Targeting a Table

To target a specific table, pass the literal table name.

using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    var insertedRows = connection.BulkInsert("Person", people);
}

Async Method

An equivalent BulkInsertAsync method is also available.

using (var connection = new CockroachDbConnection(connectionString))
{
    var people = GetPeople(10000);
    var insertedRows = await connection.BulkInsertAsync(people);
}