synapse.tools.service package

Submodules

synapse.tools.service.apikey module

async synapse.tools.service.apikey.main(argv, outp=<synapse.lib.output.OutPut object>)[source]
synapse.tools.service.apikey.printkey(outp, info, apikey=None)[source]

synapse.tools.service.backup module

synapse.tools.service.backup.backup(srcdir, dstdir, skipdirs=None)[source]

Create a backup of a Synapse application.

Parameters:

  • srcdir (str) – Path to the directory to backup.

  • dstdir (str) – Path to backup target directory.

  • skipdirs (list or None) – Optional list of relative directory name glob patterns to exclude from the backup.

Note

Running this method from the same process as a running user of the directory may lead to a segmentation fault

synapse.tools.service.backup.backup_lmdb(env: Environment, dstdir: str, txn=None)[source]
synapse.tools.service.backup.capturelmdbs(srcdir, skipdirs=None, onlydirs=None)[source]

A context manager that opens all the lmdb files under a srcdir and makes a read transaction. All transactions are aborted and environments closed when the context is exited.

Yields:

Dict[str, Tuple[lmdb.Environment, lmdb.Transaction]] – Maps path to environment, transaction

async synapse.tools.service.backup.main(argv)[source]
synapse.tools.service.backup.parse_args(argv)[source]
synapse.tools.service.backup.txnbackup(lmdbinfo, srcdir, dstdir, skipdirs=None)[source]

Create a backup of a Synapse application under a (hopefully consistent) set of transactions.

Parameters:

  • lmdbinfo (Dict[str, Tuple[lmdb.Environment, lmdb.Transaction]]) – Maps of path to environment, transaction

  • srcdir (str) – Path to the directory to backup.

  • dstdir (str) – Path to backup target directory.

  • skipdirs (list or None) – Optional list of relative directory name glob patterns to exclude from the backup.

Note

Running this method from the same process as a running user of the directory may lead to a segmentation fault

synapse.tools.service.demote module

async synapse.tools.service.demote.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.service.healthcheck module

synapse.tools.service.healthcheck.format_component(e, mesg: str) → dict[source]
synapse.tools.service.healthcheck.getArgParser(outp)[source]
async synapse.tools.service.healthcheck.main(argv, outp=<synapse.lib.output.OutPut object>)[source]
synapse.tools.service.healthcheck.serialize(ret)[source]

synapse.tools.service.livebackup module

async synapse.tools.service.livebackup.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.service.modrole module

async synapse.tools.service.modrole.main(argv, outp=<synapse.lib.output.OutPut object>)[source]
synapse.tools.service.modrole.printrole(role, outp)[source]

synapse.tools.service.moduser module

async synapse.tools.service.moduser.main(argv, outp=<synapse.lib.output.OutPut object>)[source]
synapse.tools.service.moduser.printuser(user, outp)[source]

synapse.tools.service.promote module

async synapse.tools.service.promote.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.service.reload module

synapse.tools.service.reload.getArgParser(outp)[source]
async synapse.tools.service.reload.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.service.shutdown module

async synapse.tools.service.shutdown.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.service.snapshot module

async synapse.tools.service.snapshot.main(argv, outp=<synapse.lib.output.OutPut object>)[source]