1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
|
import getpass
import json
import logging
import typing
import uuid
import aiopg
from sqlalchemy.engine.cursor import CursorResultMetaData
from sqlalchemy.engine.interfaces import Dialect, ExecutionContext
from sqlalchemy.engine.row import Row
from sqlalchemy.sql import ClauseElement
from sqlalchemy.sql.ddl import DDLElement
from databases.backends.common.records import Record, Row, create_column_maps
from databases.backends.compilers.psycopg import PGCompiler_psycopg
from databases.backends.dialects.psycopg import PGDialect_psycopg
from databases.core import LOG_EXTRA, DatabaseURL
from databases.interfaces import (
ConnectionBackend,
DatabaseBackend,
Record as RecordInterface,
TransactionBackend,
)
logger = logging.getLogger("databases")
class AiopgBackend(DatabaseBackend):
def __init__(
self, database_url: typing.Union[DatabaseURL, str], **options: typing.Any
) -> None:
self._database_url = DatabaseURL(database_url)
self._options = options
self._dialect = self._get_dialect()
self._pool: typing.Union[aiopg.Pool, None] = None
def _get_dialect(self) -> Dialect:
dialect = PGDialect_psycopg(
json_serializer=json.dumps, json_deserializer=lambda x: x
)
dialect.statement_compiler = PGCompiler_psycopg
dialect.implicit_returning = True
dialect.supports_native_enum = True
dialect.supports_smallserial = True # 9.2+
dialect._backslash_escapes = False
dialect.supports_sane_multi_rowcount = True # psycopg 2.0.9+
dialect._has_native_hstore = True
dialect.supports_native_decimal = True
return dialect
def _get_connection_kwargs(self) -> dict:
url_options = self._database_url.options
kwargs = {}
min_size = url_options.get("min_size")
max_size = url_options.get("max_size")
ssl = url_options.get("ssl")
if min_size is not None:
kwargs["minsize"] = int(min_size)
if max_size is not None:
kwargs["maxsize"] = int(max_size)
if ssl is not None:
kwargs["ssl"] = {"true": True, "false": False}[ssl.lower()]
for key, value in self._options.items():
# Coerce 'min_size' and 'max_size' for consistency.
if key == "min_size":
key = "minsize"
elif key == "max_size":
key = "maxsize"
kwargs[key] = value
return kwargs
async def connect(self) -> None:
assert self._pool is None, "DatabaseBackend is already running"
kwargs = self._get_connection_kwargs()
self._pool = await aiopg.create_pool(
host=self._database_url.hostname,
port=self._database_url.port,
user=self._database_url.username or getpass.getuser(),
password=self._database_url.password,
database=self._database_url.database,
**kwargs,
)
async def disconnect(self) -> None:
assert self._pool is not None, "DatabaseBackend is not running"
self._pool.close()
await self._pool.wait_closed()
self._pool = None
def connection(self) -> "AiopgConnection":
return AiopgConnection(self, self._dialect)
class CompilationContext:
def __init__(self, context: ExecutionContext):
self.context = context
class AiopgConnection(ConnectionBackend):
def __init__(self, database: AiopgBackend, dialect: Dialect):
self._database = database
self._dialect = dialect
self._connection: typing.Optional[aiopg.Connection] = None
async def acquire(self) -> None:
assert self._connection is None, "Connection is already acquired"
assert self._database._pool is not None, "DatabaseBackend is not running"
self._connection = await self._database._pool.acquire()
async def release(self) -> None:
assert self._connection is not None, "Connection is not acquired"
assert self._database._pool is not None, "DatabaseBackend is not running"
await self._database._pool.release(self._connection)
self._connection = None
async def fetch_all(self, query: ClauseElement) -> typing.List[RecordInterface]:
assert self._connection is not None, "Connection is not acquired"
query_str, args, result_columns, context = self._compile(query)
column_maps = create_column_maps(result_columns)
dialect = self._dialect
cursor = await self._connection.cursor()
try:
await cursor.execute(query_str, args)
rows = await cursor.fetchall()
metadata = CursorResultMetaData(context, cursor.description)
rows = [
Row(
metadata,
metadata._processors,
metadata._keymap,
row,
)
for row in rows
]
return [Record(row, result_columns, dialect, column_maps) for row in rows]
finally:
cursor.close()
async def fetch_one(self, query: ClauseElement) -> typing.Optional[RecordInterface]:
assert self._connection is not None, "Connection is not acquired"
query_str, args, result_columns, context = self._compile(query)
column_maps = create_column_maps(result_columns)
dialect = self._dialect
cursor = await self._connection.cursor()
try:
await cursor.execute(query_str, args)
row = await cursor.fetchone()
if row is None:
return None
metadata = CursorResultMetaData(context, cursor.description)
row = Row(
metadata,
metadata._processors,
metadata._keymap,
row,
)
return Record(row, result_columns, dialect, column_maps)
finally:
cursor.close()
async def execute(self, query: ClauseElement) -> typing.Any:
assert self._connection is not None, "Connection is not acquired"
query_str, args, _, _ = self._compile(query)
cursor = await self._connection.cursor()
try:
await cursor.execute(query_str, args)
return cursor.lastrowid
finally:
cursor.close()
async def execute_many(self, queries: typing.List[ClauseElement]) -> None:
assert self._connection is not None, "Connection is not acquired"
cursor = await self._connection.cursor()
try:
for single_query in queries:
single_query, args, _, _ = self._compile(single_query)
await cursor.execute(single_query, args)
finally:
cursor.close()
async def iterate(
self, query: ClauseElement
) -> typing.AsyncGenerator[typing.Any, None]:
assert self._connection is not None, "Connection is not acquired"
query_str, args, result_columns, context = self._compile(query)
column_maps = create_column_maps(result_columns)
dialect = self._dialect
cursor = await self._connection.cursor()
try:
await cursor.execute(query_str, args)
metadata = CursorResultMetaData(context, cursor.description)
async for row in cursor:
record = Row(
metadata,
metadata._processors,
metadata._keymap,
row,
)
yield Record(record, result_columns, dialect, column_maps)
finally:
cursor.close()
def transaction(self) -> TransactionBackend:
return AiopgTransaction(self)
def _compile(self, query: ClauseElement) -> typing.Tuple[str, list, tuple]:
compiled = query.compile(
dialect=self._dialect, compile_kwargs={"render_postcompile": True}
)
execution_context = self._dialect.execution_ctx_cls()
execution_context.dialect = self._dialect
if not isinstance(query, DDLElement):
compiled_params = sorted(compiled.params.items())
args = compiled.construct_params()
for key, val in args.items():
if key in compiled._bind_processors:
args[key] = compiled._bind_processors[key](val)
execution_context.result_column_struct = (
compiled._result_columns,
compiled._ordered_columns,
compiled._textual_ordered_columns,
compiled._ad_hoc_textual,
compiled._loose_column_name_matching,
)
mapping = {
key: "$" + str(i) for i, (key, _) in enumerate(compiled_params, start=1)
}
compiled_query = compiled.string % mapping
result_map = compiled._result_columns
else:
args = {}
result_map = None
compiled_query = compiled.string
query_message = compiled_query.replace(" \n", " ").replace("\n", " ")
logger.debug(
"Query: %s Args: %s", query_message, repr(tuple(args)), extra=LOG_EXTRA
)
return compiled.string, args, result_map, CompilationContext(execution_context)
@property
def raw_connection(self) -> aiopg.connection.Connection:
assert self._connection is not None, "Connection is not acquired"
return self._connection
class AiopgTransaction(TransactionBackend):
def __init__(self, connection: AiopgConnection):
self._connection = connection
self._is_root = False
self._savepoint_name = ""
async def start(
self, is_root: bool, extra_options: typing.Dict[typing.Any, typing.Any]
) -> None:
assert self._connection._connection is not None, "Connection is not acquired"
self._is_root = is_root
cursor = await self._connection._connection.cursor()
if self._is_root:
await cursor.execute("BEGIN")
else:
id = str(uuid.uuid4()).replace("-", "_")
self._savepoint_name = f"STARLETTE_SAVEPOINT_{id}"
try:
await cursor.execute(f"SAVEPOINT {self._savepoint_name}")
finally:
cursor.close()
async def commit(self) -> None:
assert self._connection._connection is not None, "Connection is not acquired"
cursor = await self._connection._connection.cursor()
if self._is_root:
await cursor.execute("COMMIT")
else:
try:
await cursor.execute(f"RELEASE SAVEPOINT {self._savepoint_name}")
finally:
cursor.close()
async def rollback(self) -> None:
assert self._connection._connection is not None, "Connection is not acquired"
cursor = await self._connection._connection.cursor()
if self._is_root:
await cursor.execute("ROLLBACK")
else:
try:
await cursor.execute(f"ROLLBACK TO SAVEPOINT {self._savepoint_name}")
finally:
cursor.close()
|