remote/sqlite-utils
1
0
Fork 0
mirror of https://github.com/simonw/sqlite-utils.git synced 2026-07-30 04:44:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

Neater return_db pattern for reusing memory command, closes #643

Browse source
This commit is contained in:
Simon Willison 2024-11-08 12:11:17 -08:00
commit 2258b431d4
3 changed files with 18 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/plugins.rst
View file

@ -117,13 +117,10 @@ Example implementation:
New commands implemented by plugins can invoke existing commands using the `context.invoke <https://click.palletsprojects.com/en/stable/api/#click.Context.invoke>`__ mechanism.
As a special niche feature, if your plugin needs to import some files and then act against an in-memory database containing those files you can forward to the :ref:`sqlite-utils memory command <cli_memory>` and then access a named in-memory database called ``sqlite_utils_memory`` like this:
As a special niche feature, if your plugin needs to import some files and then act against an in-memory database containing those files you can forward to the :ref:`sqlite-utils memory command <cli_memory>` and pass it ``return_db=True``:
.. code-block:: python
from contextlib import redirect_stdout
import io
@cli.command()
@click.pass_context
@click.argument(
@ -134,9 +131,7 @@ As a special niche feature, if your plugin needs to import some files and then a
)
def show_schema_for_files(ctx, paths):
from sqlite_utils.cli import memory
with redirect_stdout(io.StringIO()):
ctx.invoke(memory, paths=paths, sql="select 1")
db = sqlite_utils.Database(memory_name="sqlite_utils_memory")
db = ctx.invoke(memory, paths=paths, _return_db=True)
# Now do something with that database
click.echo(db.schema)