Struct BulkInsert 

pub struct BulkInsert { /* private fields */ }

Active bulk insert operation.

This struct manages the streaming of row data to the server. Call send_row() for each row, then finish() to complete.

Implementations

impl BulkInsert

pub fn new(columns: Vec<BulkColumn>, batch_size: usize) -> Self

Create a new bulk insert operation.

pub fn new_with_server_metadata( columns: Vec<BulkColumn>, batch_size: usize, raw_colmetadata: Option<Bytes>, server_columns: Option<&[ColumnData]>, ) -> Self

Create a new bulk insert operation using server metadata.

When raw_colmetadata is provided, it is written directly into the BulkLoad buffer, ensuring the COLMETADATA matches the server’s exact encoding. server_columns provides per-column type info so row values are encoded correctly (fixed-length types have no length prefix).

This follows the pattern used by Tiberius: the server’s own metadata from SELECT TOP 0 is echoed back rather than constructing it from user-specified types.

pub fn send_row<T: ToSql>(&mut self, values: &[T]) -> Result<(), Error>

Send a row of data.

The values must match the column order and types specified when creating the bulk insert.

Errors

Returns an error if:

• Wrong number of values provided
• A value cannot be converted to the expected type

pub fn send_row_values(&mut self, values: &[SqlValue]) -> Result<(), Error>

Send a row of pre-converted SQL values.

impl BulkInsert

pub fn take_packets(&mut self) -> Vec<BytesMut>

Get the buffered data as packets ready to send.

Returns a vector of complete TDS packets with BulkLoad packet type (0x07).

pub fn total_rows(&self) -> u64

Get total rows sent so far.

pub fn rows_in_batch(&self) -> usize

Get rows in current batch.

pub fn should_flush(&self) -> bool

Check if a batch flush is needed.

Note: BulkWriter does not consult this — it buffers every row and sends one batch on finish. This is a helper for callers driving the lower-level BulkInsert packet API manually.

pub fn finish_packets(&mut self) -> Vec<BytesMut>

Prepare for finishing the bulk operation. Writes the DONE token and returns final packets.

pub fn result(&self) -> BulkInsertResult

Create a result from the current state.