synapse-old/synapse/storage/__init__.py

61 lines
2.3 KiB
Python
Raw Normal View History

2014-08-12 08:10:52 -06:00
# -*- coding: utf-8 -*-
2016-01-06 21:26:29 -07:00
# Copyright 2014-2016 OpenMarket Ltd
2019-07-25 09:08:24 -06:00
# Copyright 2018,2019 New Vector Ltd
2014-08-12 08:10:52 -06:00
#
# 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.
"""
The storage layer is split up into multiple parts to allow Synapse to run
against different configurations of databases (e.g. single or multiple
databases). The `DatabasePool` class represents connections to a single physical
database. The `databases` are classes that talk directly to a `DatabasePool`
instance and have associated schemas, background updates, etc. On top of those
there are classes that provide high level interfaces that combine calls to
multiple `databases`.
There are also schemas that get applied to every database, regardless of the
data stores associated with them (e.g. the schema version tables), which are
stored in `synapse.storage.schema`.
"""
from typing import TYPE_CHECKING
2018-04-25 10:37:29 -06:00
from synapse.storage.databases import Databases
from synapse.storage.databases.main import DataStore
2019-10-30 07:33:38 -06:00
from synapse.storage.persist_events import EventsPersistenceStorage
2019-10-30 09:12:49 -06:00
from synapse.storage.purge_events import PurgeEventsStorage
2019-10-30 08:07:48 -06:00
from synapse.storage.state import StateGroupStorage
2019-10-23 09:14:16 -06:00
if TYPE_CHECKING:
from synapse.app.homeserver import HomeServer
__all__ = ["Databases", "DataStore"]
2019-10-23 09:14:16 -06:00
2020-09-04 04:54:56 -06:00
class Storage:
2019-10-23 09:14:16 -06:00
"""The high level interfaces for talking to various storage layers.
"""
def __init__(self, hs: "HomeServer", stores: Databases):
2019-10-23 09:14:16 -06:00
# We include the main data store here mainly so that we don't have to
# rewrite all the existing code to split it into high vs low level
# interfaces.
self.main = stores.main
2019-10-30 09:12:49 -06:00
self.purge_events = PurgeEventsStorage(hs, stores)
2019-10-30 08:07:48 -06:00
self.state = StateGroupStorage(hs, stores)
self.persistence = None
if stores.persist_events:
self.persistence = EventsPersistenceStorage(hs, stores)