From 00a2895cd2dc42c63846216b36b2dc9f41170129 Mon Sep 17 00:00:00 2001
From: Simon Willison <swillison@gmail.com>
Date: Thu, 23 Dec 2021 11:03:49 -0800
Subject: [PATCH] execute_write defaut is now block=True, closes #1579

---
 datasette/database.py            |  8 ++++----
 docs/internals.rst               | 14 +++++++-------
 tests/test_internals_database.py |  2 +-
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/datasette/database.py b/datasette/database.py
index 0e41ff32..e908d1ea 100644
--- a/datasette/database.py
+++ b/datasette/database.py
@@ -94,7 +94,7 @@ class Database:
             f"file:{self.path}{qs}", uri=True, check_same_thread=False
         )
 
-    async def execute_write(self, sql, params=None, block=False):
+    async def execute_write(self, sql, params=None, block=True):
         def _inner(conn):
             with conn:
                 return conn.execute(sql, params or [])
@@ -103,7 +103,7 @@ class Database:
             results = await self.execute_write_fn(_inner, block=block)
         return results
 
-    async def execute_write_script(self, sql, block=False):
+    async def execute_write_script(self, sql, block=True):
         def _inner(conn):
             with conn:
                 return conn.executescript(sql)
@@ -112,7 +112,7 @@ class Database:
             results = await self.execute_write_fn(_inner, block=block)
         return results
 
-    async def execute_write_many(self, sql, params_seq, block=False):
+    async def execute_write_many(self, sql, params_seq, block=True):
         def _inner(conn):
             count = 0
 
@@ -132,7 +132,7 @@ class Database:
             kwargs["count"] = count
         return results
 
-    async def execute_write_fn(self, fn, block=False):
+    async def execute_write_fn(self, fn, block=True):
         task_id = uuid.uuid5(uuid.NAMESPACE_DNS, "datasette.io")
         if self._write_queue is None:
             self._write_queue = queue.Queue()
diff --git a/docs/internals.rst b/docs/internals.rst
index bc0174a8..667ac33a 100644
--- a/docs/internals.rst
+++ b/docs/internals.rst
@@ -663,7 +663,7 @@ Example usage:
 
 .. _database_execute_write:
 
-await db.execute_write(sql, params=None, block=False)
+await db.execute_write(sql, params=None, block=True)
 -----------------------------------------------------
 
 SQLite only allows one database connection to write at a time. Datasette handles this for you by maintaining a queue of writes to be executed against a given database. Plugins can submit write operations to this queue and they will be executed in the order in which they are received.
@@ -672,20 +672,20 @@ This method can be used to queue up a non-SELECT SQL query to be executed agains
 
 You can pass additional SQL parameters as a tuple or dictionary.
 
-By default queries are considered to be "fire and forget" - they will be added to the queue and executed in a separate thread while your code can continue to do other things. The method will return a UUID representing the queued task.
+The method will block until the operation is completed, and the return value will be the return from calling ``conn.execute(...)`` using the underlying ``sqlite3`` Python library.
 
-If you pass ``block=True`` this behaviour changes: the method will block until the write operation has completed, and the return value will be the return from calling ``conn.execute(...)`` using the underlying ``sqlite3`` Python library.
+If you pass ``block=False`` this behaviour changes to "fire and forget" - queries will be added to the write queue and executed in a separate thread while your code can continue to do other things. The method will return a UUID representing the queued task.
 
 .. _database_execute_write_script:
 
-await db.execute_write_script(sql, block=False)
+await db.execute_write_script(sql, block=True)
 -----------------------------------------------
 
 Like ``execute_write()`` but can be used to send multiple SQL statements in a single string separated by semicolons, using the ``sqlite3`` `conn.executescript() <https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.executescript>`__ method.
 
 .. _database_execute_write_many:
 
-await db.execute_write_many(sql, params_seq, block=False)
+await db.execute_write_many(sql, params_seq, block=True)
 ---------------------------------------------------------
 
 Like ``execute_write()`` but uses the ``sqlite3`` `conn.executemany() <https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.executemany>`__ method. This will efficiently execute the same SQL statement against each of the parameters in the ``params_seq`` iterator, for example:
@@ -700,7 +700,7 @@ Like ``execute_write()`` but uses the ``sqlite3`` `conn.executemany() <https://d
 
 .. _database_execute_write_fn:
 
-await db.execute_write_fn(fn, block=False)
+await db.execute_write_fn(fn, block=True)
 ------------------------------------------
 
 This method works like ``.execute_write()``, but instead of a SQL statement you give it a callable Python function. This function will be queued up and then called when the write connection is available, passing that connection as the argument to the function.
@@ -725,7 +725,7 @@ This method is fire-and-forget, queueing your function to be executed and then a
 
 If you pass ``block=True`` your calling code will block until the function has been executed. The return value to the ``await`` will be the return value of your function.
 
-If your function raises an exception and you specified ``block=True``, that exception will be propagated up to the ``await`` line. With ``block=False`` any exceptions will be silently ignored.
+If your function raises an exception and you specified ``block=True``, that exception will be propagated up to the ``await`` line. With ``block=True`` any exceptions will be silently ignored.
 
 Here's an example of ``block=True`` in action:
 
diff --git a/tests/test_internals_database.py b/tests/test_internals_database.py
index f751bf9a..80f47ab9 100644
--- a/tests/test_internals_database.py
+++ b/tests/test_internals_database.py
@@ -435,7 +435,7 @@ async def test_execute_write_fn_block_false(db):
             row = conn.execute("select count(*) from roadside_attractions").fetchone()
         return row[0]
 
-    task_id = await db.execute_write_fn(write_fn)
+    task_id = await db.execute_write_fn(write_fn, block=False)
     assert isinstance(task_id, uuid.UUID)