2015-04-01 09:12:33 -04:00
|
|
|
#
|
2023-11-21 15:29:58 -05:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 06:26:48 -05:00
|
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
2023-11-21 15:29:58 -05:00
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2015-04-01 09:12:33 -04:00
|
|
|
#
|
|
|
|
#
|
2021-02-04 08:29:47 -05:00
|
|
|
import platform
|
2022-05-16 19:34:38 -04:00
|
|
|
import sqlite3
|
2015-10-23 08:23:48 -04:00
|
|
|
import struct
|
2018-02-06 09:31:24 -05:00
|
|
|
import threading
|
2022-05-16 19:34:38 -04:00
|
|
|
from typing import TYPE_CHECKING, Any, List, Mapping, Optional
|
2015-10-23 08:23:48 -04:00
|
|
|
|
2020-02-27 06:53:40 -05:00
|
|
|
from synapse.storage.engines import BaseDatabaseEngine
|
2022-05-16 19:34:38 -04:00
|
|
|
from synapse.storage.types import Cursor
|
2015-04-01 09:12:33 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.storage.database import LoggingDatabaseConnection
|
2015-05-14 11:54:35 -04:00
|
|
|
|
2020-03-27 09:20:00 -04:00
|
|
|
|
2022-09-26 13:28:32 -04:00
|
|
|
class Sqlite3Engine(BaseDatabaseEngine[sqlite3.Connection, sqlite3.Cursor]):
|
2022-05-16 19:34:38 -04:00
|
|
|
def __init__(self, database_config: Mapping[str, Any]):
|
|
|
|
super().__init__(sqlite3, database_config)
|
2015-04-01 09:12:33 -04:00
|
|
|
|
2019-12-18 05:45:12 -05:00
|
|
|
database = database_config.get("args", {}).get("database")
|
2021-02-16 17:32:34 -05:00
|
|
|
self._is_in_memory = database in (
|
|
|
|
None,
|
|
|
|
":memory:",
|
|
|
|
)
|
2019-12-18 05:45:12 -05:00
|
|
|
|
2023-03-30 11:21:12 -04:00
|
|
|
# A connection to a database that has already been prepared, to use as a
|
|
|
|
# base for an in-memory connection. This is used during unit tests to
|
|
|
|
# speed up setting up the DB.
|
|
|
|
self._prepped_conn: Optional[sqlite3.Connection] = database_config.get(
|
|
|
|
"_TEST_PREPPED_CONN"
|
|
|
|
)
|
|
|
|
|
2021-02-04 08:29:47 -05:00
|
|
|
if platform.python_implementation() == "PyPy":
|
|
|
|
# pypy's sqlite3 module doesn't handle bytearrays, convert them
|
|
|
|
# back to bytes.
|
2022-05-16 19:34:38 -04:00
|
|
|
sqlite3.register_adapter(bytearray, lambda array: bytes(array))
|
2021-02-04 08:29:47 -05:00
|
|
|
|
2018-02-06 09:31:24 -05:00
|
|
|
# The current max state_group, or None if we haven't looked
|
|
|
|
# in the DB yet.
|
|
|
|
self._current_state_group_id = None
|
|
|
|
self._current_state_group_id_lock = threading.Lock()
|
|
|
|
|
2020-02-27 06:53:40 -05:00
|
|
|
@property
|
|
|
|
def single_threaded(self) -> bool:
|
|
|
|
return True
|
|
|
|
|
2019-10-10 10:35:46 -04:00
|
|
|
@property
|
2022-05-16 19:34:38 -04:00
|
|
|
def supports_using_any_list(self) -> bool:
|
2021-02-16 17:32:34 -05:00
|
|
|
"""Do we support using `a = ANY(?)` and passing a list"""
|
2019-10-10 10:35:46 -04:00
|
|
|
return False
|
|
|
|
|
2021-06-30 07:07:16 -04:00
|
|
|
@property
|
|
|
|
def supports_returning(self) -> bool:
|
|
|
|
"""Do we support the `RETURNING` clause in insert/update/delete?"""
|
2022-05-16 19:34:38 -04:00
|
|
|
return sqlite3.sqlite_version_info >= (3, 35, 0)
|
2021-06-30 07:07:16 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def check_database(
|
|
|
|
self, db_conn: sqlite3.Connection, allow_outdated_version: bool = False
|
|
|
|
) -> None:
|
2020-01-09 12:46:52 -05:00
|
|
|
if not allow_outdated_version:
|
2021-04-08 08:45:19 -04:00
|
|
|
# Synapse is untested against older SQLite versions, and we don't want
|
|
|
|
# to let users upgrade to a version of Synapse with broken support for their
|
|
|
|
# sqlite version, because it risks leaving them with a half-upgraded db.
|
2022-09-09 06:14:10 -04:00
|
|
|
if sqlite3.sqlite_version_info < (3, 27, 0):
|
|
|
|
raise RuntimeError("Synapse requires sqlite 3.27 or above.")
|
2015-04-29 06:42:28 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def check_new_database(self, txn: Cursor) -> None:
|
2020-01-28 08:44:21 -05:00
|
|
|
"""Gets called when setting up a brand new database. This allows us to
|
|
|
|
apply stricter checks on new databases versus existing database.
|
|
|
|
"""
|
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def convert_param_style(self, sql: str) -> str:
|
2015-04-01 09:12:33 -04:00
|
|
|
return sql
|
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def on_new_connection(self, db_conn: "LoggingDatabaseConnection") -> None:
|
2019-12-18 05:45:12 -05:00
|
|
|
# We need to import here to avoid an import loop.
|
|
|
|
from synapse.storage.prepare_database import prepare_database
|
|
|
|
|
|
|
|
if self._is_in_memory:
|
|
|
|
# In memory databases need to be rebuilt each time. Ideally we'd
|
|
|
|
# reuse the same connection as we do when starting up, but that
|
|
|
|
# would involve using adbapi before we have started the reactor.
|
2023-03-30 11:21:12 -04:00
|
|
|
#
|
|
|
|
# If we have a `prepped_conn` we can use that to initialise the DB,
|
|
|
|
# otherwise we need to call `prepare_database`.
|
|
|
|
if self._prepped_conn is not None:
|
|
|
|
# Initialise the new DB from the pre-prepared DB.
|
|
|
|
assert isinstance(db_conn.conn, sqlite3.Connection)
|
|
|
|
self._prepped_conn.backup(db_conn.conn)
|
|
|
|
else:
|
|
|
|
prepare_database(db_conn, self, config=None)
|
2019-12-18 05:45:12 -05:00
|
|
|
|
2015-10-23 08:23:48 -04:00
|
|
|
db_conn.create_function("rank", 1, _rank)
|
2020-04-30 13:47:49 -04:00
|
|
|
db_conn.execute("PRAGMA foreign_keys = ON;")
|
2022-10-25 05:22:55 -04:00
|
|
|
|
|
|
|
# Enable WAL.
|
|
|
|
# see https://www.sqlite.org/wal.html
|
|
|
|
db_conn.execute("PRAGMA journal_mode = WAL;")
|
2020-10-07 10:15:57 -04:00
|
|
|
db_conn.commit()
|
2015-04-02 05:06:22 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def is_deadlock(self, error: Exception) -> bool:
|
2015-04-07 10:28:37 -04:00
|
|
|
return False
|
2015-04-27 07:40:49 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def is_connection_closed(self, conn: sqlite3.Connection) -> bool:
|
2015-04-27 07:40:49 -04:00
|
|
|
return False
|
2015-04-27 08:22:30 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def lock_table(self, txn: Cursor, table: str) -> None:
|
2015-04-27 08:22:30 -04:00
|
|
|
return
|
2015-10-23 08:23:48 -04:00
|
|
|
|
2019-02-27 05:21:49 -05:00
|
|
|
@property
|
2022-05-16 19:34:38 -04:00
|
|
|
def server_version(self) -> str:
|
|
|
|
"""Gets a string giving the server version. For example: '3.22.0'."""
|
|
|
|
return "%i.%i.%i" % sqlite3.sqlite_version_info
|
2019-02-27 05:21:49 -05:00
|
|
|
|
2023-09-06 03:30:53 -04:00
|
|
|
@property
|
|
|
|
def row_id_name(self) -> str:
|
|
|
|
return "rowid"
|
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def in_transaction(self, conn: sqlite3.Connection) -> bool:
|
|
|
|
return conn.in_transaction
|
2020-10-07 10:15:57 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def attempt_to_set_autocommit(
|
|
|
|
self, conn: sqlite3.Connection, autocommit: bool
|
|
|
|
) -> None:
|
2020-10-07 10:15:57 -04:00
|
|
|
# Twisted doesn't let us set attributes on the connections, so we can't
|
|
|
|
# set the connection to autocommit mode.
|
|
|
|
pass
|
|
|
|
|
2022-01-25 09:14:46 -05:00
|
|
|
def attempt_to_set_isolation_level(
|
2022-05-16 19:34:38 -04:00
|
|
|
self, conn: sqlite3.Connection, isolation_level: Optional[int]
|
|
|
|
) -> None:
|
|
|
|
# All transactions are SERIALIZABLE by default in sqlite
|
2022-01-25 09:14:46 -05:00
|
|
|
pass
|
|
|
|
|
2022-09-26 13:28:32 -04:00
|
|
|
@staticmethod
|
|
|
|
def executescript(cursor: sqlite3.Cursor, script: str) -> None:
|
|
|
|
"""Execute a chunk of SQL containing multiple semicolon-delimited statements.
|
|
|
|
|
|
|
|
Python's built-in SQLite driver does not allow you to do this with DBAPI2's
|
|
|
|
`execute`:
|
|
|
|
|
|
|
|
> execute() will only execute a single SQL statement. If you try to execute more
|
|
|
|
> than one statement with it, it will raise a Warning. Use executescript() if
|
|
|
|
> you want to execute multiple SQL statements with one call.
|
|
|
|
|
2023-01-31 06:03:55 -05:00
|
|
|
The script is prefixed with a `BEGIN TRANSACTION`, since the docs for
|
2023-01-25 08:38:53 -05:00
|
|
|
`executescript` warn:
|
2022-09-26 13:28:32 -04:00
|
|
|
|
|
|
|
> If there is a pending transaction, an implicit COMMIT statement is executed
|
|
|
|
> first. No other implicit transaction control is performed; any transaction
|
|
|
|
> control must be added to sql_script.
|
|
|
|
"""
|
2023-01-31 06:03:55 -05:00
|
|
|
# The implementation of `executescript` can be found at
|
|
|
|
# https://github.com/python/cpython/blob/3.11/Modules/_sqlite/cursor.c#L1035.
|
|
|
|
cursor.executescript(f"BEGIN TRANSACTION; {script}")
|
2022-09-26 13:28:32 -04:00
|
|
|
|
2015-10-23 08:23:48 -04:00
|
|
|
|
|
|
|
# Following functions taken from: https://github.com/coleifer/peewee
|
|
|
|
|
2019-04-03 05:07:29 -04:00
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def _parse_match_info(buf: bytes) -> List[int]:
|
2015-10-23 08:23:48 -04:00
|
|
|
bufsize = len(buf)
|
2019-06-20 05:32:02 -04:00
|
|
|
return [struct.unpack("@I", buf[i : i + 4])[0] for i in range(0, bufsize, 4)]
|
2015-10-23 08:23:48 -04:00
|
|
|
|
|
|
|
|
2022-05-16 19:34:38 -04:00
|
|
|
def _rank(raw_match_info: bytes) -> float:
|
2015-10-23 08:23:48 -04:00
|
|
|
"""Handle match_info called w/default args 'pcx' - based on the example rank
|
|
|
|
function http://sqlite.org/fts3.html#appendix_a
|
|
|
|
"""
|
|
|
|
match_info = _parse_match_info(raw_match_info)
|
|
|
|
score = 0.0
|
|
|
|
p, c = match_info[:2]
|
|
|
|
for phrase_num in range(p):
|
|
|
|
phrase_info_idx = 2 + (phrase_num * c * 3)
|
|
|
|
for col_num in range(c):
|
|
|
|
col_idx = phrase_info_idx + (col_num * 3)
|
2019-04-03 05:07:29 -04:00
|
|
|
x1, x2 = match_info[col_idx : col_idx + 2]
|
2015-10-23 08:23:48 -04:00
|
|
|
if x1 > 0:
|
|
|
|
score += float(x1) / x2
|
|
|
|
return score
|