diff options
| author | Richard van der Hoff <richard@matrix.org> | 2017-10-30 15:16:21 +0000 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2017-10-31 14:01:53 +0000 |
| commit | 1650eb584772dbad61d74c2b3c9c932a52fe1979 (patch) | |
| tree | 35e4d79fe3ea8a8133a084c55c38341143f3fccd /docs/password_auth_providers.rst | |
| parent | Merge pull request #2609 from matrix-org/rav/refactor_login (diff) | |
| download | synapse-1650eb584772dbad61d74c2b3c9c932a52fe1979.tar.xz | |
DB schema interface for password auth providers
Provide an interface by which password auth providers can register db schema files to be run at startup
Diffstat (limited to 'docs/password_auth_providers.rst')
| -rw-r--r-- | docs/password_auth_providers.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/password_auth_providers.rst b/docs/password_auth_providers.rst index 3da1a67844..ca05a76617 100644 --- a/docs/password_auth_providers.rst +++ b/docs/password_auth_providers.rst @@ -37,3 +37,15 @@ Password auth provider classes must provide the following methods: The method should return a Twisted ``Deferred`` object, which resolves to ``True`` if authentication is successful, and ``False`` if not. + +Optional methods +---------------- + +Password provider classes may optionally provide the following methods. + +*class* ``SomeProvider.get_db_schema_files()`` + + This method, if implemented, should return an Iterable of ``(name, + stream)`` pairs of database schema files. Each file is applied in turn at + initialisation, and a record is then made in the database so that it is + not re-applied on the next start. |