##Examples
using SqlBulkTools;
// IBulkOperations Interface for easy mocking.
public class BookClub(IBulkOperations bulk) {
IBulkOperations _bulk;
public BookClub(IBulkOperations bulk) {
_bulk = bulk;
}
// Do your stuff
}
// Or simply new up an instance.
var bulk = new BulkOperations();
// The following examples are based on a cut down Book model
public class Book {
public int Id {get; set;}
public string ISBN {get; set;}
public string Description {get; set;}
}books = GetBooks();
bulk.Setup<Book>(x => x.ForCollection(books))
.WithTable("Books")
.AddAllColumns()
.BulkInsert();
bulk.CommitTransaction("DefaultConnection");
/*
Notes:
(1) It's also possible to add each column manually via the AddColumn method. Bear in mind that
columns that are not added will be assigned their default value according to the property type.
(2) It's possible to disable non-clustered indexes during the transaction. See advanced section
for more info.
*/books = GetBooks();
bulk.Setup<Book>(x => x.ForCollection(books))
.WithTable("Books")
.AddColumn(x => x.ISBN)
.AddColumn(x => x.Title)
.AddColumn(x => x.Description)
.BulkInsertOrUpdate()
.MatchTargetOn(x => x.ISBN)
bulk.CommitTransaction("DefaultConnection");
// Another example using an identity column
bulk.Setup<Book>(x => x.ForCollection(books))
.WithTable("Books")
.AddAllColumns()
.BulkInsertOrUpdate()
.SetIdentityColumn(x => x.Id)
.MatchTargetOn(x => x.Id)
bulk.CommitTransaction("DefaultConnection");
/*
Notes:
(1) It's possible to use AddAllColumns for operations BulkInsert/BulkInsertOrUpdate/BulkUpdate.
(2) MatchTargetOn is mandatory for BulkUpdate, BulkInsertOrUpdate and BulkDelete... unless you want to eat
an InvalidOperationException.
(3) If model property name does not match the actual SQL column name, you can set up a custom
mapping. An example of this is shown in a dedicated section somewhere in this Readme...
(4) BulkInsertOrUpdate also supports DeleteWhenNotMatched which is false by default. With power
comes responsibility. Use at your own risk.
(5) If your model contains an identity column and it's included (via AddAllColumns, AddColumn or
MatchTargetOn) in your setup, you must use SetIdentityColumn to mark it as your identity column.
Identity columns are immutable and auto incremented. You can of course update based on an identity
column (using MatchTargetOn) but just make sure to use SetIdentityColumn to mark it as an
identity column.
*/books = GetBooksToUpdate();
bulk.Setup<Book>(x => x.ForCollection(books))
.WithTable("Books")
.AddColumn(x => x.ISBN)
.AddColumn(x => x.Title)
.AddColumn(x => x.Description)
.BulkUpdate()
.MatchTargetOn(x => x.ISBN)
/* Notes:
(1) Whilst it's possible to use AddAllColumns for BulkUpdate, using AddColumn for only the columns
that need to be updated leads to performance gains.
(2) MatchTargetOn is mandatory for BulkUpdate, BulkInsertOrUpdate and BulkDelete... unless you want to eat
an InvalidOperationException.
(3) MatchTargetOn can be called multiple times for more than one column to match on.
(4) If your model contains an identity column and it's included (via AddAllColumns, AddColumn or
MatchTargetOn) in your setup, you must use SetIdentityColumn to mark it as your identity column.
Identity columns are immutable and auto incremented. You can of course update based on an identity
column (using MatchTargetOn) but just make sure to use SetIdentityColumn to mark it as an
identity column.
*/
bulk.CommitTransaction("DefaultConnection");/* Tip: Considering you only need to match a key, use a DTO containing only the column(s) needed for
performance gains. */
public class BookDto {
public string ISBN {get; set;}
}
books = GetBooksIDontLike();
bulk.Setup<BookDto>(x => x.ForCollection(books))
.WithTable("Books")
.AddColumn(x => x.ISBN)
.BulkDelete()
.MatchTargetOn(x => x.ISBN)
bulk.CommitTransaction("DefaultConnection");
/*
Notes:
(1) Avoid using AddAllColumns for BulkDelete.
(2) MatchTargetOn is mandatory for BulkUpdate, BulkInsertOrUpdate and BulkDelete... unless you want to eat
an InvalidOperationException.
*//* If the property names in your model don't match the column names in the corresponding table, you
can use a custom column mapping. For the below example, assume that there is a 'BookTitle' column
name in database which is defined in the model as 'Title' */
books = GetBooks();
bulk.Setup<Book>(x => x.ForCollection(books))
.WithTable("Books")
.AddAllColumns()
.CustomColumnMapping(x => x.Title, "BookTitle")
.BulkInsert();
bulk.CommitTransaction("DefaultConnection");books = GetBooks();
bulk.Setup<Book>(x => x.ForCollection(books))
.WithTable("Books")
.WithSchema("Api") // Specify a schema
.WithBulkCopyBatchSize(4000)
.WithBulkCopyCommandTimeout(720) // Default is 600 seconds
.WithBulkCopyEnableStreaming(false)
.WithBulkCopyNotifyAfter(300)
.WithSqlCommandTimeout(720) // Default is 600 seconds
.WithSqlBulkCopyOptions(SqlBulkCopyOptions.TableLock)
.AddColumn(x => // ........
/* SqlBulkTools gives you the ability to disable all or selected non-clustered indexes during
the transaction. Indexes are rebuilt once the transaction is completed. If at any time during
the transaction an exception arises, the transaction is safely rolled back and indexes revert
to their initial state. */
// Example
bulk.Setup<Book>(x => x.ForCollection(col))
.WithTable("Books")
.WithBulkCopyBatchSize(5000)
.WithSqlBulkCopyOptions(SqlBulkCopyOptions.TableLock)
.AddAllColumns()
.TmpDisableAllNonClusteredIndexes()
.BulkInsert();
bulk.CommitTransaction("DefaultConnection");###How does SqlBulkTools compare to others?
Test notes:
- Table had 6 columns including an identity column.
- There were 3 non-clustered indexes on the table.
- SqlBulkTools used the following setup options: AddAllColumns, TmpDisableAllNonClusteredIndexes.
#####Setup
Setup<T>(Func<Setup<T>, CollectionSelect<T>> list)
// Example usage where col implements IEnumerable and is of type Book
bulk.Setup<Book>(x => x.ForCollection(col))
/* Setup is the main entry point. Because of the vast flexibility possible with SqlBulkTools,
a fluent interface helps to guide you through setup process. This design choice was made to
make it easier for you to use SqlBulkTools. Options that are not relevant to a particular
operation are not exposed. For example the MatchTargetOn method is not accessible from the
BulkInsert method because it would not make sense. */#####CommitTransaction
CommitTransaction(string connectionName, SqlCredential credentials = null)
CommitTransaction(SqlConnection connection)
CommitTransactionAsync(string connectionName, SqlCredential credentials = null)
CommitTransactionAsync(SqlConnection connection)
/* A transaction will only take place if CommitTransaction is called. CommitTransaction is
always called after a valid setup is built and Async flavours are included for scalability.
CommitTransaction and CommmitTransactionAsync respectively are overloaded. It's up to you how
you would like to pass in your SQL configuration.
*/