pipeworks_mud_mapper.services.db_tools
======================================

.. py:module:: pipeworks_mud_mapper.services.db_tools

.. autoapi-nested-parse::

   Utility helpers for backing up and exporting the mapper SQLite database.



Functions
---------

.. autoapisummary::

   pipeworks_mud_mapper.services.db_tools.backup_db
   pipeworks_mud_mapper.services.db_tools.dump_db_sql
   pipeworks_mud_mapper.services.db_tools.export_map_json
   pipeworks_mud_mapper.services.db_tools.export_zone_json


Module Contents
---------------

.. py:function:: backup_db(db_path, output_path)

   Create a consistent backup of the SQLite database.

   Uses the SQLite backup API so the copy is consistent even while the
   app has the database open.


.. py:function:: dump_db_sql(db_path, output)

   Write a SQL dump of the database to the given output stream.


.. py:function:: export_map_json(db_path, output_dir, map_id = None)

   Export authoring map JSON files from SQLite.


.. py:function:: export_zone_json(db_path, output_dir, map_id = None)

   Export zone JSON files (game truth) from SQLite.