2019-10-28 13:45:32 -04:00
|
|
|
#!/usr/bin/env python
|
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
import argparse
|
|
|
|
import logging
|
|
|
|
import sys
|
|
|
|
|
|
|
|
import yaml
|
|
|
|
|
|
|
|
from twisted.internet import defer, reactor
|
|
|
|
|
2020-01-21 14:04:58 -05:00
|
|
|
import synapse
|
2019-10-28 13:45:32 -04:00
|
|
|
from synapse.config.homeserver import HomeServerConfig
|
|
|
|
from synapse.metrics.background_process_metrics import run_as_background_process
|
|
|
|
from synapse.server import HomeServer
|
|
|
|
from synapse.storage import DataStore
|
2020-01-21 14:04:58 -05:00
|
|
|
from synapse.util.versionstring import get_version_string
|
2019-10-28 13:45:32 -04:00
|
|
|
|
|
|
|
logger = logging.getLogger("update_database")
|
|
|
|
|
|
|
|
|
|
|
|
class MockHomeserver(HomeServer):
|
|
|
|
DATASTORE_CLASS = DataStore
|
|
|
|
|
2019-12-10 08:32:34 -05:00
|
|
|
def __init__(self, config, **kwargs):
|
2019-10-28 13:45:32 -04:00
|
|
|
super(MockHomeserver, self).__init__(
|
2019-12-10 08:32:34 -05:00
|
|
|
config.server_name, reactor=reactor, config=config, **kwargs
|
2019-10-28 13:45:32 -04:00
|
|
|
)
|
|
|
|
|
2020-01-21 14:04:58 -05:00
|
|
|
self.version_string = "Synapse/"+get_version_string(synapse)
|
|
|
|
|
2019-10-28 13:45:32 -04:00
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
parser = argparse.ArgumentParser(
|
|
|
|
description=(
|
|
|
|
"Updates a synapse database to the latest schema and runs background updates"
|
|
|
|
" on it."
|
|
|
|
)
|
|
|
|
)
|
2019-12-05 06:20:49 -05:00
|
|
|
parser.add_argument("-v", action="store_true")
|
2019-10-28 13:45:32 -04:00
|
|
|
parser.add_argument(
|
|
|
|
"--database-config",
|
2019-12-05 06:20:49 -05:00
|
|
|
type=argparse.FileType("r"),
|
2019-10-28 13:45:32 -04:00
|
|
|
required=True,
|
|
|
|
help="A database config file for either a SQLite3 database or a PostgreSQL one.",
|
|
|
|
)
|
|
|
|
|
|
|
|
args = parser.parse_args()
|
|
|
|
|
|
|
|
logging_config = {
|
|
|
|
"level": logging.DEBUG if args.v else logging.INFO,
|
|
|
|
"format": "%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(message)s",
|
|
|
|
}
|
|
|
|
|
|
|
|
logging.basicConfig(**logging_config)
|
|
|
|
|
|
|
|
# Load, process and sanity-check the config.
|
|
|
|
hs_config = yaml.safe_load(args.database_config)
|
|
|
|
|
|
|
|
if "database" not in hs_config:
|
|
|
|
sys.stderr.write("The configuration file must have a 'database' section.\n")
|
|
|
|
sys.exit(4)
|
|
|
|
|
|
|
|
config = HomeServerConfig()
|
|
|
|
config.parse_config_dict(hs_config, "", "")
|
|
|
|
|
2019-12-10 08:32:34 -05:00
|
|
|
# Instantiate and initialise the homeserver object.
|
|
|
|
hs = MockHomeserver(config)
|
2019-10-28 13:45:32 -04:00
|
|
|
|
2019-12-18 05:45:12 -05:00
|
|
|
# Setup instantiates the store within the homeserver object and updates the
|
|
|
|
# DB.
|
2019-10-28 13:45:32 -04:00
|
|
|
hs.setup()
|
|
|
|
store = hs.get_datastore()
|
|
|
|
|
2020-01-21 14:04:58 -05:00
|
|
|
async def run_background_updates():
|
|
|
|
await store.db.updates.run_background_updates(sleep=False)
|
2019-10-28 13:45:32 -04:00
|
|
|
# Stop the reactor to exit the script once every background update is run.
|
|
|
|
reactor.stop()
|
|
|
|
|
2020-01-21 14:04:58 -05:00
|
|
|
def run():
|
|
|
|
# Apply all background updates on the database.
|
|
|
|
defer.ensureDeferred(
|
|
|
|
run_as_background_process("background_updates", run_background_updates)
|
|
|
|
)
|
|
|
|
|
|
|
|
reactor.callWhenRunning(run)
|
2019-10-28 13:45:32 -04:00
|
|
|
|
|
|
|
reactor.run()
|