Update lib/exqlite/sqlite3.ex

Co-authored-by: Matthew Johnston <warmwaffles@gmail.com>
elixir-sqlite · Oct 14, 2024 · 7e66ddd · 7e66ddd
1 parent c23604f
commit 7e66ddd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/exqlite/sqlite3.ex b/lib/exqlite/sqlite3.ex
@@ -280,6 +280,9 @@ defmodule Exqlite.Sqlite3 do
   @doc """
   Bulk-inserts rows into a prepared statement. Must be called inside a transaction.
 
+  The `types` parameter is type of each column in the order they are specified 
+  in the parameter `rows`. For example, `[["a", 1, 1.0]]` would have `types`
+  specified as `[:text, :integer, :float]`.
       iex> {:ok, conn} = Sqlite3.open(":memory:", [:readonly])
       iex> :ok = Sqlite3.execute(conn, "CREATE TABLE users (name TEXT)")
       iex> {:ok, insert} = Sqlite3.prepare(conn, "INSERT INTO users (name) VALUES (?)")