mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-28 13:11:56 +00:00
synapse/storage/_base.py:Table was unused
This commit is contained in:
parent
cc3ab0c214
commit
527d95dea0
@ -25,8 +25,6 @@ from util.id_generators import IdGenerator, StreamIdGenerator
|
|||||||
|
|
||||||
from twisted.internet import defer
|
from twisted.internet import defer
|
||||||
|
|
||||||
from collections import namedtuple
|
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
import time
|
import time
|
||||||
import threading
|
import threading
|
||||||
@ -791,129 +789,3 @@ class _RollbackButIsFineException(Exception):
|
|||||||
something went wrong.
|
something went wrong.
|
||||||
"""
|
"""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
class Table(object):
|
|
||||||
""" A base class used to store information about a particular table.
|
|
||||||
"""
|
|
||||||
|
|
||||||
table_name = None
|
|
||||||
""" str: The name of the table """
|
|
||||||
|
|
||||||
fields = None
|
|
||||||
""" list: The field names """
|
|
||||||
|
|
||||||
EntryType = None
|
|
||||||
""" Type: A tuple type used to decode the results """
|
|
||||||
|
|
||||||
_select_where_clause = "SELECT %s FROM %s WHERE %s"
|
|
||||||
_select_clause = "SELECT %s FROM %s"
|
|
||||||
_insert_clause = "REPLACE INTO %s (%s) VALUES (%s)"
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def select_statement(cls, where_clause=None):
|
|
||||||
"""
|
|
||||||
Args:
|
|
||||||
where_clause (str): The WHERE clause to use.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
str: An SQL statement to select rows from the table with the given
|
|
||||||
WHERE clause.
|
|
||||||
"""
|
|
||||||
if where_clause:
|
|
||||||
return cls._select_where_clause % (
|
|
||||||
", ".join(cls.fields),
|
|
||||||
cls.table_name,
|
|
||||||
where_clause
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
return cls._select_clause % (
|
|
||||||
", ".join(cls.fields),
|
|
||||||
cls.table_name,
|
|
||||||
)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def insert_statement(cls):
|
|
||||||
return cls._insert_clause % (
|
|
||||||
cls.table_name,
|
|
||||||
", ".join(cls.fields),
|
|
||||||
", ".join(["?"] * len(cls.fields)),
|
|
||||||
)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def decode_single_result(cls, results):
|
|
||||||
""" Given an iterable of tuples, return a single instance of
|
|
||||||
`EntryType` or None if the iterable is empty
|
|
||||||
Args:
|
|
||||||
results (list): The results list to convert to `EntryType`
|
|
||||||
Returns:
|
|
||||||
EntryType: An instance of `EntryType`
|
|
||||||
"""
|
|
||||||
results = list(results)
|
|
||||||
if results:
|
|
||||||
return cls.EntryType(*results[0])
|
|
||||||
else:
|
|
||||||
return None
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def decode_results(cls, results):
|
|
||||||
""" Given an iterable of tuples, return a list of `EntryType`
|
|
||||||
Args:
|
|
||||||
results (list): The results list to convert to `EntryType`
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
list: A list of `EntryType`
|
|
||||||
"""
|
|
||||||
return [cls.EntryType(*row) for row in results]
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def get_fields_string(cls, prefix=None):
|
|
||||||
if prefix:
|
|
||||||
to_join = ("%s.%s" % (prefix, f) for f in cls.fields)
|
|
||||||
else:
|
|
||||||
to_join = cls.fields
|
|
||||||
|
|
||||||
return ", ".join(to_join)
|
|
||||||
|
|
||||||
|
|
||||||
class JoinHelper(object):
|
|
||||||
""" Used to help do joins on tables by looking at the tables' fields and
|
|
||||||
creating a list of unique fields to use with SELECTs and a namedtuple
|
|
||||||
to dump the results into.
|
|
||||||
|
|
||||||
Attributes:
|
|
||||||
tables (list): List of `Table` classes
|
|
||||||
EntryType (type)
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, *tables):
|
|
||||||
self.tables = tables
|
|
||||||
|
|
||||||
res = []
|
|
||||||
for table in self.tables:
|
|
||||||
res += [f for f in table.fields if f not in res]
|
|
||||||
|
|
||||||
self.EntryType = namedtuple("JoinHelperEntry", res)
|
|
||||||
|
|
||||||
def get_fields(self, **prefixes):
|
|
||||||
"""Get a string representing a list of fields for use in SELECT
|
|
||||||
statements with the given prefixes applied to each.
|
|
||||||
|
|
||||||
For example::
|
|
||||||
|
|
||||||
JoinHelper(PdusTable, StateTable).get_fields(
|
|
||||||
PdusTable="pdus",
|
|
||||||
StateTable="state"
|
|
||||||
)
|
|
||||||
"""
|
|
||||||
res = []
|
|
||||||
for field in self.EntryType._fields:
|
|
||||||
for table in self.tables:
|
|
||||||
if field in table.fields:
|
|
||||||
res.append("%s.%s" % (prefixes[table.__name__], field))
|
|
||||||
break
|
|
||||||
|
|
||||||
return ", ".join(res)
|
|
||||||
|
|
||||||
def decode_results(self, rows):
|
|
||||||
return [self.EntryType(*row) for row in rows]
|
|
||||||
|
@ -13,7 +13,7 @@
|
|||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
from ._base import SQLBaseStore, Table
|
from ._base import SQLBaseStore
|
||||||
from twisted.internet import defer
|
from twisted.internet import defer
|
||||||
|
|
||||||
from synapse.api.errors import StoreError
|
from synapse.api.errors import StoreError
|
||||||
@ -149,5 +149,5 @@ class PusherStore(SQLBaseStore):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
class PushersTable(Table):
|
class PushersTable(object):
|
||||||
table_name = "pushers"
|
table_name = "pushers"
|
||||||
|
Loading…
Reference in New Issue
Block a user