Skip to content

Fix outdated batch insertion example in README #470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slabko merged 1 commit into from
Mar 31, 2026
+4 −4
Merged

Fix outdated batch insertion example in README #470

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,13 @@ target_link_libraries(${PROJECT_NAME} PRIVATE clickhouse-cpp-lib)
## Batch Insertion

In addition to the `Insert` method, which inserts all the data in a block in a
single call, you can use the `BeginInsert` / `InsertData` / `EndInsert`
single call, you can use the `BeginInsert` / `SendInsertBlock` / `EndInsert`
pattern to insert batches of data. This can be useful for managing larger data
sets without inflating memory with the entire set.

To use it pass `BeginInsert` an `INSERT` statement ending in `VALUES` but with
no actual values. Use the resulting `Block` to append batches of data, sending
each to the sever with `InsertData`. Finally, call `EndInsert` (or let the
each to the sever with `SendInsertBlock`. Finally, call `EndInsert` (or let the
client go out of scope) to signal the server that insertion is complete.
Example:

Expand All @@ -186,7 +186,7 @@ col2.Append("naomi");

// Send those records.
block.RefreshRowCount();
client->InsertData(block);
client->SendInsertBlock(block);
block.Clear();

// Add another record.
Expand All @@ -195,7 +195,7 @@ col2.Append("amos");

// Send it and finish.
block.RefreshRowCount();
client->EndInsert(block);
client->EndInsert();
```

## Thread-safety
Expand Down