/usr/lib/python2.7/dist-packages/twext/enterprise/adbapi2.py is in python-twext 0.1.b2.dev15059-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 | # -*- test-case-name: twext.enterprise.test.test_adbapi2 -*-
##
# Copyright (c) 2010-2015 Apple Inc. All rights reserved.
#
# 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.
##
"""
Asynchronous multi-process connection pool.
This is similar to L{twisted.enterprise.adbapi}, but can hold a transaction
(and thereby a thread) open across multiple asynchronous operations, rather
than forcing the transaction to be completed entirely in a thread and/or
entirely in a single SQL statement.
Also, this module includes an AMP protocol for multiplexing connections through
a single choke-point host. This is not currently in use, however, as AMP needs
some optimization before it can be low-impact enough for this to be an
improvement.
"""
import sys
import weakref
from cStringIO import StringIO
from cPickle import dumps, loads
from itertools import count
from zope.interface import implements
from twisted.internet.defer import inlineCallbacks
from twisted.internet.defer import returnValue
from twisted.internet.defer import DeferredList
from twisted.internet.defer import Deferred
from twisted.protocols.amp import Boolean
from twisted.python.failure import Failure
from twisted.protocols.amp import Argument, String, Command, AMP, Integer
from twisted.internet import reactor as _reactor
from twisted.application.service import Service
from twisted.python import log
from twisted.internet.defer import maybeDeferred
from twisted.python.components import proxyForInterface
from twext.internet.threadutils import ThreadHolder
from twisted.internet.defer import succeed
from twext.enterprise.ienterprise import ConnectionError
from twext.enterprise.ienterprise import IDerivedParameter
from twisted.internet.defer import fail
from twext.enterprise.ienterprise import (
AlreadyFinishedError, IAsyncTransaction, POSTGRES_DIALECT, ICommandBlock
)
# FIXME: there should be no defaults for connection metadata, it should be
# discovered dynamically everywhere. Right now it's specified as an explicit
# argument to the ConnectionPool but it should probably be determined
# automatically from the database binding.
DEFAULT_PARAM_STYLE = "pyformat"
DEFAULT_DIALECT = POSTGRES_DIALECT
def _forward(thunk):
"""
Forward an attribute to the connection pool.
"""
@property
def getter(self):
return getattr(self._pool, thunk.func_name)
return getter
def _destructively(aList):
"""
Destructively iterate a list, popping elements from the beginning.
"""
while aList:
yield aList.pop(0)
def _deriveParameters(cursor, args):
"""
Some DB-API extensions need to call special extension methods on
the cursor itself before executing.
@param cursor: The DB-API cursor object to derive parameters from.
@param args: the parameters being specified to C{execSQL}. This list will
be modified to present parameters suitable to pass to the C{cursor}'s
C{execute} method.
@return: a list of L{IDerivedParameter} providers which had C{preQuery}
executed on them, so that after the query they may have C{postQuery}
executed. This may also be C{None} if no parameters were derived.
@see: {IDerivedParameter}
"""
# TODO: have the underlying connection report whether it has any
# IDerivedParameters that it knows about, so we can skip even inspecting
# the arguments if none of them could possibly provide
# IDerivedParameter.
derived = None
for n, arg in enumerate(args):
if IDerivedParameter.providedBy(arg):
if derived is None:
# Be as sparing as possible with extra allocations, as this
# usually isn't needed, and we're doing a ton of extra work to
# support it.
derived = []
derived.append(arg)
args[n] = arg.preQuery(cursor)
return derived
def _deriveQueryEnded(cursor, derived):
"""
A query which involved some L{IDerivedParameter}s just ended. Execute any
post-query cleanup or tasks that those parameters have to do.
@param cursor: The DB-API object that derived the query.
@param derived: The L{IDerivedParameter} providers that were given
C{preQuery} notifications when the query started.
@return: C{None}
"""
for arg in derived:
arg.postQuery(cursor)
class _ConnectedTxn(object):
"""
L{IAsyncTransaction} implementation based on a L{ThreadHolder} in the
current process.
"""
implements(IAsyncTransaction)
noisy = False
def __init__(self, pool, threadHolder, connection, cursor, label=None):
self._pool = pool
self._completed = "idle"
self._cursor = cursor
self._connection = connection
self._holder = threadHolder
self._first = True
self._label = label
def __repr__(self):
return "_ConnectedTxn({})".format(self._label)
@_forward
def paramstyle(self):
"""
The paramstyle attribute is mirrored from the connection pool.
"""
@_forward
def dialect(self):
"""
The dialect attribute is mirrored from the connection pool.
"""
def _reallyExecSQL(self, sql, args=None, raiseOnZeroRowCount=None):
"""
Execute the given SQL on a thread, using a DB-API 2.0 cursor.
This method is invoked internally on a non-reactor thread, one
dedicated to and associated with the current cursor. It executes the
given SQL, re-connecting first if necessary, re-cycling the old
connection if necessary, and then, if there are results from the
statement (as determined by the DB-API 2.0 "description" attribute) it
will fetch all the rows and return them, leaving them to be relayed to
L{_ConnectedTxn.execSQL} via the L{ThreadHolder}.
The rules for possibly reconnecting automatically are: if this is the
very first statement being executed in this transaction, and an error
occurs in C{execute}, close the connection and try again. We will
ignore any errors from C{close()} (or C{rollback()}) and log them
during this process. This is OK because adbapi2 always enforces
transaction discipline: connections are never in autocommit mode, so if
the first statement in a transaction fails, nothing can have happened
to the database; as per the ADBAPI spec, a lost connection is a
rolled-back transaction. In the cases where some databases fail to
enforce transaction atomicity (i.e. schema manipulations),
re-executing the same statement will result, at worst, in a spurious
and harmless error (like "table already exists"), not corruption.
@param sql: The SQL string to execute.
@type sql: C{str}
@param args: The bind parameters to pass to adbapi, if any.
@type args: C{list} or C{None}
@param raiseOnZeroRowCount: If specified, an exception to raise when no
rows are found.
@return: all the rows that resulted from execution of the given C{sql},
or C{None}, if the statement is one which does not produce results.
@rtype: C{list} of C{tuple}, or C{NoneType}
@raise Exception: this function may raise any exception raised by the
underlying C{dbapi.connect}, C{cursor.execute},
L{IDerivedParameter.preQuery}, C{connection.cursor}, or
C{cursor.fetchall}.
@raise raiseOnZeroRowCount: if the argument was specified and no rows
were returned by the executed statement.
"""
wasFirst = self._first
# If this is the first time this cursor has been used in this
# transaction, remember that, but mark it as now used.
self._first = False
if args is None:
args = []
# Note: as of this writing, derived parameters are only used to support
# cx_Oracle's "host variable" feature (i.e. cursor.var()), and creating
# a host variable will never be a connection-oriented error (a
# disconnected cursor can happily create variables of all types).
# However, this may need to move into the "try" below if other database
# features need to compute database arguments based on runtime state.
derived = _deriveParameters(self._cursor, args)
try:
self._cursor.execute(sql, args)
except:
# If execute() raised an exception, and this was the first thing to
# happen in the transaction, then the connection has probably gone
# bad in the meanwhile, and we should try again.
if wasFirst:
# Report the error before doing anything else, since doing
# other things may cause the traceback stack to be eliminated
# if they raise exceptions (even internally).
log.err(
Failure(),
"Exception from execute() on first statement in "
"transaction. Possibly caused by a database server "
"restart. Automatically reconnecting now."
)
try:
self._connection.close()
except:
# close() may raise an exception to alert us of an error as
# well. Right now the only type of error we know about is
# "the connection is already closed", which obviously
# doesn't need to be handled specially. Unfortunately the
# reporting of this type of error is not consistent or
# predictable across different databases, or even different
# bindings to the same database, so we have to do a
# catch-all here. While I can't imagine another type of
# error at the moment, bare C{except:}s are notorious for
# making debugging surprising error conditions very
# difficult, so let's make sure that the error is logged
# just in case.
log.err(
Failure(),
"Exception from close() while automatically "
"reconnecting. (Probably not serious.)"
)
# Now, if either of *these* things fail, there's an error here
# that we cannot workaround or address automatically, so no
# try:except: for them.
self._connection = self._pool.connectionFactory()
self._cursor = self._connection.cursor()
# Note that although this method is being invoked recursively,
# the "_first" flag is re-set at the very top, so we will _not_
# be re-entering it more than once.
result = self._reallyExecSQL(sql, args, raiseOnZeroRowCount)
return result
else:
raise
if derived is not None:
_deriveQueryEnded(self._cursor, derived)
if self._cursor.description:
# see test_raiseOnZeroRowCountWithUnreliableRowCount
rows = self._cursor.fetchall()
if not rows:
if raiseOnZeroRowCount is not None:
raise raiseOnZeroRowCount()
return rows
else:
if raiseOnZeroRowCount is not None and self._cursor.rowcount == 0:
raise raiseOnZeroRowCount()
# Oracle with a return into clause returns an empty set or rows, but
# we then have to insert the special bind variables for the return into.
# Thus we need to know whether there was any rowcount from the actual query.
# What we do is always insert a set of empty rows as the result if the
# rowcount is non-zero. Then we can detect whether the bind variables
# need to be added into the result set.
return [[]] * self._cursor.rowcount if self._cursor.rowcount else None
def execSQL(self, *args, **kw):
if self._completed:
raise RuntimeError("Attempt to use {} transaction.".format(self._completed))
result = self._holder.submit(
lambda: self._reallyExecSQL(*args, **kw)
)
if self.noisy:
def reportResult(results):
sys.stdout.write("\n".join([
"",
"SQL: %r %r" % (args, kw),
"Results: %r" % (results,),
"",
]))
return results
result.addBoth(reportResult)
return result
def _end(self, really, terminate=False):
"""
Common logic for commit or abort. Executed in the main reactor thread.
@param really: the callable to execute in the cursor thread to actually
do the commit or rollback.
@param terminate: abort and prevent any new SQL from being executed even
after a reset().
@return: a L{Deferred} which fires when the database logic has
completed.
@raise: L{AlreadyFinishedError} if the transaction has already been
committed or aborted.
"""
if not self._completed:
self._completed = "terminated" if terminate else "ended"
def reallySomething():
"""
Do the database work and set appropriate flags. Executed in
the cursor thread.
"""
if self._cursor is None or self._first:
return
really()
result = self._holder.submit(reallySomething)
self._pool._repoolAfter(self, result)
return result
else:
raise AlreadyFinishedError(self._completed)
def commit(self):
return self._end(self._connection.commit)
def abort(self):
return self._end(self._connection.rollback).addErrback(log.err)
def terminate(self):
return self._end(self._connection.rollback, terminate=True).addErrback(log.err)
def reset(self):
"""
Call this when placing this transaction back into the pool.
@raise RuntimeError: if the transaction has not been committed or
aborted.
"""
if not self._completed:
raise RuntimeError("Attempt to re-set active transaction.")
if self._completed != "terminated":
self._completed = False
self._first = True
def _releaseConnection(self):
"""
Release the thread and database connection associated with this
transaction.
"""
self._completed = "released"
self._stopped = True
holder = self._holder
self._holder = None
def _reallyClose():
if self._cursor is None:
return
self._connection.close()
holder.submit(_reallyClose)
return holder.stop()
class _NoTxn(object):
"""
An L{IAsyncTransaction} that indicates a local failure before we could even
communicate any statements (or possibly even any connection attempts) to
the server.
"""
implements(IAsyncTransaction)
def __init__(self, pool, reason, label=None):
self.paramstyle = pool.paramstyle
self.dialect = pool.dialect
self.reason = reason
self._label = label
def __repr__(self):
return "_NoTxn({})".format(self._label)
def _everything(self, *a, **kw):
"""
Everything fails with a L{ConnectionError}.
"""
return fail(ConnectionError(self.reason))
execSQL = _everything
commit = _everything
abort = _everything
class _WaitingTxn(object):
"""
A L{_WaitingTxn} is an implementation of L{IAsyncTransaction} which cannot
yet actually execute anything, so it waits and spools SQL requests for
later execution. When a L{_ConnectedTxn} becomes available later, it can
be unspooled onto that.
"""
implements(IAsyncTransaction)
def __init__(self, pool, label=None):
"""
Initialize a L{_WaitingTxn} based on a L{ConnectionPool}. (The C{pool}
is used only to reflect C{dialect} and C{paramstyle} attributes; not
remembered or modified in any way.)
"""
self._spool = []
self.paramstyle = pool.paramstyle
self.dialect = pool.dialect
self._label = label
def __repr__(self):
return "_WaitingTxn({})".format(self._label)
def _enspool(self, cmd, a=(), kw={}):
d = Deferred()
self._spool.append((d, cmd, a, kw))
return d
def _iterDestruct(self):
"""
Iterate the spool list destructively, while popping items from the
beginning. This allows code which executes more SQL in the callback of
a Deferred to not interfere with the originally submitted order of
commands.
"""
return _destructively(self._spool)
def _unspool(self, other):
"""
Unspool this transaction onto another transaction.
@param other: another provider of L{IAsyncTransaction} which will
actually execute the SQL statements we have been buffering.
"""
for (d, cmd, a, kw) in self._iterDestruct():
self._relayCommand(other, d, cmd, a, kw)
def _relayCommand(self, other, d, cmd, a, kw):
"""
Relay a single command to another transaction.
"""
maybeDeferred(getattr(other, cmd), *a, **kw).chainDeferred(d)
def execSQL(self, *a, **kw):
return self._enspool("execSQL", a, kw)
def commit(self):
return self._enspool("commit")
def abort(self):
"""
Succeed and do nothing. The actual logic for this method is mostly
implemented by L{_SingleTxn._stopWaiting}.
"""
return succeed(None)
class _HookableOperation(object):
def __init__(self):
self._hooks = []
@inlineCallbacks
def runHooks(self, ignored=None):
"""
Callback for C{commit} and C{abort} Deferreds.
"""
for operation in _destructively(self._hooks):
yield operation()
self.clear()
returnValue(ignored)
def addHook(self, operation):
"""
Implement L{IAsyncTransaction.postCommit}.
"""
if self._hooks is not None:
self._hooks.append(operation)
def clear(self):
"""
Remove all hooks from this operation. Once this is called, no
more hooks can be added ever again.
"""
self._hooks = None
class _CommitAndAbortHooks(object):
"""
Shared implementation of post-commit and post-abort hooks.
"""
# FIXME: this functionality needs direct tests, although it's pretty well-
# covered by txdav's test suite.
def __init__(self):
self._preCommit = _HookableOperation()
self._commit = _HookableOperation()
self._abort = _HookableOperation()
def _commitWithHooks(self, doCommit):
"""
Run pre-hooks, commit, the real DB commit, and then post-hooks.
"""
pre = self._preCommit.runHooks()
def ok(ignored):
self._abort.clear()
return doCommit().addCallback(self._commit.runHooks)
def failed(why):
return self.abort().addCallback(lambda ignored: why)
return pre.addCallbacks(ok, failed)
def preCommit(self, operation):
return self._preCommit.addHook(operation)
def postCommit(self, operation):
return self._commit.addHook(operation)
def postAbort(self, operation):
return self._abort.addHook(operation)
class _SingleTxn(_CommitAndAbortHooks,
proxyForInterface(iface=IAsyncTransaction,
originalAttribute="_baseTxn")):
"""
A L{_SingleTxn} is a single-use wrapper for the longer-lived
L{_ConnectedTxn}, so that if a badly-behaved API client accidentally hangs
on to one of these and, for example C{.abort()}s it multiple times once
another client is using that connection, it will get some harmless
tracebacks.
It's a wrapper around a "real" implementation; either a L{_ConnectedTxn},
L{_NoTxn}, or L{_WaitingTxn} depending on the availability of real
underlying datbase connections.
This is the only L{IAsyncTransaction} implementation exposed to application
code.
It's also the only implementor of the C{commandBlock} method for grouping
commands together.
"""
def __init__(self, pool, baseTxn):
super(_SingleTxn, self).__init__()
self._pool = pool
self._baseTxn = baseTxn
self._label = self._baseTxn._label
self._completed = False
self._currentBlock = None
self._blockedQueue = None
self._pendingBlocks = []
self._stillExecuting = []
def __repr__(self):
"""
Reveal the backend in the string representation.
"""
return "_SingleTxn(%r)" % (self._baseTxn,)
def _unspoolOnto(self, baseTxn):
"""
Replace my C{_baseTxn}, currently a L{_WaitingTxn}, with a new
implementation of L{IAsyncTransaction} that will actually do the work;
either a L{_ConnectedTxn} or a L{_NoTxn}.
"""
spooledBase = self._baseTxn
self._baseTxn = baseTxn
spooledBase._unspool(baseTxn)
def execSQL(self, sql, args=None, raiseOnZeroRowCount=None):
return self._execSQLForBlock(sql, args, raiseOnZeroRowCount, None)
def _execSQLForBlock(self, sql, args, raiseOnZeroRowCount, block):
"""
Execute some SQL for a particular L{CommandBlock}; or, if the given
C{block} is C{None}, execute it in the outermost transaction context.
"""
self._checkComplete()
if block is None and self._blockedQueue is not None:
return self._blockedQueue.execSQL(sql, args, raiseOnZeroRowCount)
# "block" should always be _currentBlock at this point.
d = super(_SingleTxn, self).execSQL(sql, args, raiseOnZeroRowCount)
self._stillExecuting.append(d)
def itsDone(result):
self._stillExecuting.remove(d)
self._checkNextBlock()
return result
d.addBoth(itsDone)
return d
def _checkNextBlock(self):
"""
Check to see if there are any blocks pending statements waiting to
execute, and execute the next one if there are no outstanding execute
calls.
"""
if self._stillExecuting:
# If we're still executing statements, nevermind. We'll get called
# again by the C{itsDone} callback above.
return
if self._currentBlock is not None:
# If there's still a current block, then keep it going. We'll be
# called by the C{_finishExecuting} callback below.
return
# There's no block executing now. What to do?
if self._pendingBlocks:
# If there are pending blocks, start one of them.
self._currentBlock = self._pendingBlocks.pop(0)
d = self._currentBlock._startExecuting()
d.addCallback(self._finishExecuting)
elif self._blockedQueue is not None:
# If there aren't any pending blocks any more, and there are
# spooled statements that aren't part of a block, unspool all the
# statements that have been held up until this point.
bq = self._blockedQueue
self._blockedQueue = None
bq._unspool(self)
def _finishExecuting(self, result):
"""
The active block just finished executing. Clear it and see if there
are more blocks to execute, or if all the blocks are done and we should
execute any queued free statements.
"""
self._currentBlock = None
self._checkNextBlock()
def commit(self):
if self._blockedQueue is not None:
# We're in the process of executing a block of commands. Wait
# until they're done. (Commit will be repeated in
# _checkNextBlock.)
return self._blockedQueue.commit()
def reallyCommit():
self._markComplete()
return super(_SingleTxn, self).commit()
return self._commitWithHooks(reallyCommit)
def abort(self):
self._markComplete()
self._commit.clear()
self._preCommit.clear()
result = super(_SingleTxn, self).abort()
if self in self._pool._waiting:
self._stopWaiting()
result.addCallback(self._abort.runHooks)
return result
def _stopWaiting(self):
"""
Stop waiting for a free transaction and fail.
"""
self._pool._waiting.remove(self)
self._completed = True
self._unspoolOnto(_NoTxn(
self._pool,
"connection pool shut down while txn "
"waiting for database connection.",
label=self._label,
))
def _checkComplete(self):
"""
If the transaction is complete, raise L{AlreadyFinishedError}
"""
if self._completed:
raise AlreadyFinishedError()
def _markComplete(self):
"""
Mark the transaction as complete, raising AlreadyFinishedError.
"""
self._checkComplete()
self._completed = True
def commandBlock(self):
"""
Create a L{CommandBlock} which will wait for all currently spooled
commands to complete before executing its own.
"""
self._checkComplete()
block = CommandBlock(self)
if self._currentBlock is None:
self._blockedQueue = _WaitingTxn(self._pool, label=self._label)
# FIXME: test the case where it's ready immediately.
self._checkNextBlock()
return block
def __del__(self):
"""
When garbage collected, a L{_SingleTxn} recycles itself.
"""
try:
if not self._completed:
self.abort()
except AlreadyFinishedError:
# The underlying transaction might already be completed without us
# knowing; for example if the service shuts down.
pass
class _Unspooler(object):
def __init__(self, orig):
self.orig = orig
def execSQL(self, sql, args=None, raiseOnZeroRowCount=None):
"""
Execute some SQL, but don't track a new Deferred.
"""
return self.orig.execSQL(sql, args, raiseOnZeroRowCount, False)
class CommandBlock(object):
"""
A partial implementation of L{IAsyncTransaction} that will group execSQL
calls together.
Does not implement commit() or abort(), because this will simply group
commands. In order to implement sub-transactions or checkpoints, some
understanding of the SQL dialect in use by the underlying connection is
required. Instead, it provides C{end}.
"""
implements(ICommandBlock)
def __init__(self, singleTxn):
self._singleTxn = singleTxn
self.paramstyle = singleTxn.paramstyle
self.dialect = singleTxn.dialect
self._spool = _WaitingTxn(singleTxn._pool, label=singleTxn._label)
self._started = False
self._ended = False
self._waitingForEnd = []
self._endDeferred = Deferred()
singleTxn._pendingBlocks.append(self)
def _startExecuting(self):
self._started = True
self._spool._unspool(_Unspooler(self))
return self._endDeferred
def execSQL(self, sql, args=None, raiseOnZeroRowCount=None, track=True):
"""
Execute some SQL within this command block.
@param sql: the SQL string to execute.
@param args: the SQL arguments.
@param raiseOnZeroRowCount: see L{IAsyncTransaction.execSQL}
@param track: an internal parameter; was this called by application
code or as part of unspooling some previously-queued requests?
True if application code, False if unspooling.
"""
if track and self._ended:
raise AlreadyFinishedError()
self._singleTxn._checkComplete()
if self._singleTxn._currentBlock is self and self._started:
d = self._singleTxn._execSQLForBlock(
sql, args, raiseOnZeroRowCount, self)
else:
d = self._spool.execSQL(sql, args, raiseOnZeroRowCount)
if track:
self._trackForEnd(d)
return d
def _trackForEnd(self, d):
"""
Watch the following L{Deferred}, since we need to watch it to determine
when C{end} should be considered done, and the next CommandBlock or
regular SQL statement should be unqueued.
"""
self._waitingForEnd.append(d)
def end(self):
"""
The block of commands has completed. Allow other SQL to run on the
underlying L{IAsyncTransaction}.
"""
# FIXME: test the case where end() is called when it's not the current
# executing block.
if self._ended:
raise AlreadyFinishedError()
self._ended = True
# TODO: maybe this should return a Deferred that's a clone of
# _endDeferred, so that callers can determine when the block is really
# complete? Struggling for an actual use-case on that one.
DeferredList(self._waitingForEnd).chainDeferred(self._endDeferred)
class _ConnectingPseudoTxn(object):
"""
This is a pseudo-Transaction for bookkeeping purposes.
When a connection has asked to connect, but has not yet completed
connecting, the L{ConnectionPool} still needs a way to shut it down. This
object provides that tracking handle, and will be present in the pool's
C{busy} list while it is populating the list.
"""
_retry = None
def __init__(self, pool, holder):
"""
Initialize the L{_ConnectingPseudoTxn}; get ready to connect.
@param pool: The pool that this connection attempt is participating in.
@type pool: L{ConnectionPool}
@param holder: the L{ThreadHolder} allocated to this connection attempt
and subsequent SQL executions for this connection.
@type holder: L{ThreadHolder}
"""
self._pool = pool
self._holder = holder
self._connection = False
self._aborted = False
def abort(self):
"""
Ignore the result of attempting to connect to this database, and
instead simply close the connection and free the L{ThreadHolder}
allocated for it.
"""
self._aborted = True
if self._retry is not None:
self._retry.cancel()
def _reallyClose():
if self._connection:
self._connection.close()
self._holder.submit(_reallyClose)
d = self._holder.stop()
def removeme(ignored):
if self in self._pool._busy:
self._pool._busy.remove(self)
d.addCallback(removeme)
return d
def terminate(self):
return self.abort()
def _fork(x):
"""
Produce a L{Deferred} that will fire when another L{Deferred} fires without
disturbing its results.
"""
d = Deferred()
def fired(result):
d.callback(result)
return result
x.addBoth(fired)
return d
class ConnectionPool(Service, object):
"""
This is a central service that has a threadpool and executes SQL statements
asynchronously, in a pool.
@ivar connectionFactory: a 0-or-1-argument callable that returns a DB-API
connection. The optional argument can be used as a label for
diagnostic purposes.
@ivar maxConnections: The connection pool will not attempt to make more
than this many concurrent connections to the database.
@type maxConnections: C{int}
@ivar reactor: The reactor used for scheduling threads as well as retries
for failed connect() attempts.
@type reactor: L{IReactorTime} and L{IReactorThreads} provider.
@ivar _free: The list of free L{_ConnectedTxn} objects which are not
currently attached to a L{_SingleTxn} object, and have active
connections ready for processing a new transaction.
@ivar _busy: The list of busy L{_ConnectedTxn} objects; those currently
servicing an unfinished L{_SingleTxn} object.
@ivar _finishing: The list of 2-tuples of L{_ConnectedTxn} objects which
have had C{abort} or C{commit} called on them, but are not done
executing that method, and the L{Deferred} returned from that method
that will be fired when its execution has completed.
@ivar _waiting: The list of L{_SingleTxn} objects attached to a
L{_WaitingTxn}; i.e. those which are awaiting a connection to become
free so that they can be executed.
@ivar _stopping: Is this L{ConnectionPool} in the process of shutting down?
(If so, new connections will not be established.)
"""
reactor = _reactor
RETRY_TIMEOUT = 10.0
def __init__(
self,
connectionFactory, maxConnections=10,
paramstyle=DEFAULT_PARAM_STYLE, dialect=DEFAULT_DIALECT,
name=None,
):
super(ConnectionPool, self).__init__()
self.connectionFactory = connectionFactory
self.maxConnections = maxConnections
self.paramstyle = paramstyle
self.dialect = dialect
if name is not None:
self.name = name
self._free = []
self._busy = []
self._waiting = []
self._finishing = []
self._stopping = False
def startService(self):
"""
Increase the thread pool size of the reactor by the number of threads
that this service may consume. This is important because unlike most
L{IReactorThreads} users, the connection work units are very long-lived
and block until this service has been stopped.
"""
super(ConnectionPool, self).startService()
tp = self.reactor.getThreadPool()
self.reactor.suggestThreadPoolSize(tp.max + self.maxConnections)
@inlineCallbacks
def stopService(self):
"""
Forcibly abort any outstanding transactions, and release all resources
(notably, threads).
"""
super(ConnectionPool, self).stopService()
self._stopping = True
# Phase 1: Cancel any transactions that are waiting so they won't try
# to eagerly acquire new connections as they flow into the free-list.
while self._waiting:
waiting = self._waiting[0]
waiting._stopWaiting()
# Phase 2: All of the busy transactions must be terminated first. As each
# one is terminated, it will remove itself from the list. Note we terminate
# and not abort the transaction to ensure they cannot be re-used.
while self._busy:
yield self._busy[0].terminate()
# Phase 3: Wait for all the Deferreds from the L{_ConnectedTxn}s that
# have *already* been stopped. Note we do this AFTER clearing out
# self._busy, to make sure any that were busy have properly finished
# (been added to self._free) before we clear out the free ones.
while self._finishing:
yield _fork(self._finishing[0][1])
# Phase 4: All transactions should now be in the free list, since
# "abort()" will have put them there. Shut down all the associated
# ThreadHolders.
while self._free:
# Releasing a L{_ConnectedTxn} doesn't automatically recycle it /
# remove it the way aborting a _SingleTxn does, so we need to
# .pop() here. L{_ConnectedTxn.stop} really shouldn't be able to
# fail, as it's just stopping the thread, and the holder's stop()
# is independently submitted from .abort() / .close().
yield self._free.pop()._releaseConnection()
tp = self.reactor.getThreadPool()
self.reactor.suggestThreadPoolSize(tp.max - self.maxConnections)
def _createHolder(self):
"""
Create a L{ThreadHolder}. (Test hook.)
"""
return ThreadHolder(self.reactor)
def connection(self, label="<unlabeled>"):
"""
Find and immediately return an L{IAsyncTransaction} object. Execution
of statements, commit and abort on that transaction may be delayed
until a real underlying database connection is available.
@return: an L{IAsyncTransaction}
"""
if self._stopping:
# FIXME: should be wrapping a _SingleTxn around this to get
# .commandBlock()
return _NoTxn(self, "txn created while DB pool shutting down", label=label)
if self._free:
basetxn = self._free.pop(0)
basetxn._label = label
self._busy.append(basetxn)
txn = _SingleTxn(self, basetxn)
else:
txn = _SingleTxn(self, _WaitingTxn(self, label=label))
self._waiting.append(txn)
# FIXME/TESTME: should be len(self._busy) + len(self._finishing)
# (free doesn't need to be considered, as it's tested above)
if self._activeConnectionCount() < self.maxConnections:
self._startOneMore()
return txn
def _activeConnectionCount(self):
"""
@return: the number of active outgoing connections to the database.
"""
return len(self._busy) + len(self._finishing)
def _startOneMore(self):
"""
Start one more L{_ConnectedTxn}. What happens here is that we first create a
L{_ConnectingPseudoTxn} to hold a busy slot whilst the connection is starting
up. Once the connection is up, we replace the L{_ConnectingPseudoTxn} with the
L{_ConnectedTxn} that will do the actual DB work.
"""
holder = self._createHolder()
holder.start()
txn = _ConnectingPseudoTxn(self, holder)
# take up a slot in the "busy" list, sit there so we can be aborted.
self._busy.append(txn)
def initCursor():
# support threadlevel=1; we can't necessarily cursor() in a
# different thread than we do transactions in.
txn._connection = self.connectionFactory()
cursor = txn._connection.cursor()
return (txn._connection, cursor)
def finishInit((connection, cursor)):
if txn._aborted:
return
baseTxn = _ConnectedTxn(
pool=self,
threadHolder=holder,
connection=connection,
cursor=cursor
)
self._busy.remove(txn)
self._repoolNow(baseTxn)
def maybeTryAgain(f):
log.err(f, "Re-trying connection due to connection failure")
txn._retry = self.reactor.callLater(self.RETRY_TIMEOUT, resubmit)
def resubmit():
d = holder.submit(initCursor)
d.addCallbacks(finishInit, maybeTryAgain)
resubmit()
def _repoolAfter(self, txn, d):
"""
Re-pool the given L{_ConnectedTxn} after the given L{Deferred} has
fired.
"""
self._busy.remove(txn)
finishRecord = (txn, d)
self._finishing.append(finishRecord)
def repool(result):
self._finishing.remove(finishRecord)
self._repoolNow(txn)
return result
def discard(result):
self._finishing.remove(finishRecord)
txn._releaseConnection()
self._startOneMore()
return result
return d.addCallbacks(repool, discard)
def _repoolNow(self, txn):
"""
Recycle a L{_ConnectedTxn} into the free list.
"""
txn.reset()
if self._waiting:
waiting = self._waiting.pop(0)
self._busy.append(txn)
waiting._unspoolOnto(txn)
else:
# If we are stopping, never add to the free list - release it
if self._stopping:
txn._releaseConnection()
else:
self._free.append(txn)
def txnarg():
return [("transactionID", Integer())]
CHUNK_MAX = 0xffff
class BigArgument(Argument):
"""
An argument whose payload can be larger than L{CHUNK_MAX}, by splitting
across multiple AMP keys.
"""
def fromBox(self, name, strings, objects, proto):
value = StringIO()
for counter in count():
chunk = strings.get("%s.%d" % (name, counter))
if chunk is None:
break
value.write(chunk)
objects[name] = self.fromString(value.getvalue())
def toBox(self, name, strings, objects, proto):
value = StringIO(self.toString(objects[name]))
for counter in count():
nextChunk = value.read(CHUNK_MAX)
if not nextChunk:
break
strings["%s.%d" % (name, counter)] = nextChunk
class Pickle(BigArgument):
"""
A pickle sent over AMP. This is to serialize the "args" argument to
C{execSQL}, which is the dynamically-typed "args" list argument to a DB-API
C{execute} function, as well as its dynamically-typed result ("rows").
This should be cleaned up into a nicer structure, but this is not a network
protocol, so we can be a little relaxed about security.
This is a L{BigArgument} rather than a regular L{Argument} because
individual arguments and query results need to contain entire vCard or
iCalendar documents, which can easily be greater than 64k.
"""
def toString(self, inObject):
return dumps(inObject)
def fromString(self, inString):
return loads(inString)
class FailsafeException(Exception):
"""
Exception raised by all responders.
"""
_quashErrors = {
FailsafeException: "SOMETHING_UNKNOWN",
AlreadyFinishedError: "ALREADY_FINISHED",
ConnectionError: "CONNECTION_ERROR",
}
def failsafeResponder(command):
"""
Wrap an AMP command responder in some fail-safe logic, to make it so that
unknown errors won't drop the connection, as AMP's default behavior would.
"""
def wrap(inner):
@inlineCallbacks
def innerinner(*a, **k):
try:
val = yield inner(*a, **k)
except:
f = Failure()
if f.type in command.errors:
returnValue(f)
else:
log.err(Failure(), "shared database connection pool error")
raise FailsafeException()
else:
returnValue(val)
return command.responder(innerinner)
return wrap
class StartTxn(Command):
"""
Start a transaction, identified with an ID generated by the client.
"""
arguments = txnarg()
errors = _quashErrors
class ExecSQL(Command):
"""
Execute an SQL statement.
"""
arguments = [
("sql", String()),
("queryID", String()),
("args", Pickle()),
("blockID", String()),
("reportZeroRowCount", Boolean())
] + txnarg()
errors = _quashErrors
class StartBlock(Command):
"""
Create a new SQL command block.
"""
arguments = [("blockID", String())] + txnarg()
errors = _quashErrors
class EndBlock(Command):
"""
Create a new SQL command block.
"""
arguments = [("blockID", String())] + txnarg()
errors = _quashErrors
class Row(Command):
"""
A row has been returned. Sent from server to client in response to
L{ExecSQL}.
"""
arguments = [("queryID", String()), ("row", Pickle())]
errors = _quashErrors
class QueryComplete(Command):
"""
A query issued with L{ExecSQL} is complete.
"""
arguments = [
("queryID", String()),
("norows", Boolean()),
("derived", Pickle()),
("noneResult", Boolean())
]
errors = _quashErrors
class Commit(Command):
arguments = txnarg()
errors = _quashErrors
class Abort(Command):
arguments = txnarg()
errors = _quashErrors
class _NoRows(Exception):
"""
Placeholder exception to report zero rows.
"""
class ConnectionPoolConnection(AMP):
"""
A L{ConnectionPoolConnection} is a single connection to a
L{ConnectionPool}. This is the server side of the connection-pool-sharing
protocol; it implements all the AMP responders necessary.
"""
def __init__(self, pool):
"""
Initialize a mapping of transaction IDs to transaction objects.
"""
super(ConnectionPoolConnection, self).__init__()
self.pool = pool
self._txns = {}
self._blocks = {}
def stopReceivingBoxes(self, why):
log.msg("(S) Stopped receiving boxes: " + why.getTraceback())
def unhandledError(self, failure):
"""
An unhandled error has occurred. Since we can't really classify errors
well on this protocol, log it and forget it.
"""
log.err(failure, "Shared connection pool server encountered an error.")
@failsafeResponder(StartTxn)
def start(self, transactionID):
self._txns[transactionID] = self.pool.connection()
return {}
@failsafeResponder(StartBlock)
def startBlock(self, transactionID, blockID):
self._blocks[blockID] = self._txns[transactionID].commandBlock()
return {}
@failsafeResponder(EndBlock)
def endBlock(self, transactionID, blockID):
self._blocks[blockID].end()
return {}
@failsafeResponder(ExecSQL)
@inlineCallbacks
def receivedSQL(self, transactionID, queryID, sql, args, blockID,
reportZeroRowCount):
derived = None
noneResult = False
for param in args:
if IDerivedParameter.providedBy(param):
if derived is None:
derived = []
derived.append(param)
if blockID:
txn = self._blocks[blockID]
else:
txn = self._txns[transactionID]
if reportZeroRowCount:
rozrc = _NoRows
else:
rozrc = None
try:
rows = yield txn.execSQL(sql, args, rozrc)
except _NoRows:
norows = True
else:
norows = False
if rows is not None:
for row in rows:
# Either this should be yielded or it should be
# requiresAnswer=False
self.callRemote(Row, queryID=queryID, row=row)
else:
noneResult = True
self.callRemote(
QueryComplete, queryID=queryID, norows=norows,
derived=derived, noneResult=noneResult
)
returnValue({})
def _complete(self, transactionID, thunk):
txn = self._txns.pop(transactionID)
return thunk(txn).addCallback(lambda ignored: {})
@failsafeResponder(Commit)
def commit(self, transactionID):
"""
Successfully complete the given transaction.
"""
def commitme(x):
return x.commit()
return self._complete(transactionID, commitme)
@failsafeResponder(Abort)
def abort(self, transactionID):
"""
Roll back the given transaction.
"""
def abortme(x):
return x.abort()
return self._complete(transactionID, abortme)
class ConnectionPoolClient(AMP):
"""
A client which can execute SQL.
"""
def __init__(
self, dialect=POSTGRES_DIALECT, paramstyle=DEFAULT_PARAM_STYLE
):
# See DEFAULT_PARAM_STYLE FIXME above.
super(ConnectionPoolClient, self).__init__()
self._nextID = count().next
self._txns = weakref.WeakValueDictionary()
self._queries = {}
self.dialect = dialect
self.paramstyle = paramstyle
def unhandledError(self, failure):
"""
An unhandled error has occurred. Since we can't really classify errors
well on this protocol, log it and forget it.
"""
log.err(failure, "Shared connection pool client encountered an error.")
def stopReceivingBoxes(self, why):
log.msg("(C) Stopped receiving boxes: " + why.getTraceback())
def newTransaction(self):
"""
Create a new networked provider of L{IAsyncTransaction}.
(This will ultimately call L{ConnectionPool.connection} on the other
end of the wire.)
@rtype: L{IAsyncTransaction}
"""
txnid = str(self._nextID())
txn = _NetTransaction(client=self, transactionID=txnid)
self._txns[txnid] = txn
self.callRemote(StartTxn, transactionID=txnid)
return txn
@failsafeResponder(Row)
def row(self, queryID, row):
self._queries[queryID].row(row)
return {}
@failsafeResponder(QueryComplete)
def complete(self, queryID, norows, derived, noneResult):
self._queries.pop(queryID).done(norows, derived, noneResult)
return {}
class _Query(object):
def __init__(self, sql, raiseOnZeroRowCount, args):
self.sql = sql
self.args = args
self.results = []
self.deferred = Deferred()
self.raiseOnZeroRowCount = raiseOnZeroRowCount
def row(self, row):
"""
A row was received.
"""
self.results.append(row)
def done(self, norows, derived, noneResult):
"""
The query is complete.
@param norows: A boolean. True if there were not any rows.
@param derived: either C{None} or a C{list} of L{IDerivedParameter}
providers initially passed into the C{execSQL} that started this
query. The values of these object swill mutate the original input
parameters to resemble them. Although
L{IDerivedParameter.preQuery} and L{IDerivedParameter.postQuery}
are invoked on the other end of the wire, the local objects will be
made to appear as though they were called here.
@param noneResult: should the result of the query be C{None} (i.e. did
it not have a C{description} on the cursor).
"""
if noneResult and not self.results:
results = None
else:
results = self.results
if derived is not None:
# 1) Bleecchh.
# 2) FIXME: add some direct tests in test_adbapi2, the unit test
# for this crosses some abstraction boundaries so it's a little
# integration-y and in the tests for twext.enterprise.dal
for remote, local in zip(derived, self._deriveDerived()):
local.__dict__ = remote.__dict__
if norows and (self.raiseOnZeroRowCount is not None):
exc = self.raiseOnZeroRowCount()
self.deferred.errback(Failure(exc))
else:
self.deferred.callback(results)
def _deriveDerived(self):
derived = None
for param in self.args:
if IDerivedParameter.providedBy(param):
if derived is None:
derived = []
derived.append(param)
return derived
class _NetTransaction(_CommitAndAbortHooks):
"""
A L{_NetTransaction} is an L{AMP}-protocol-based provider of the
L{IAsyncTransaction} interface. It sends SQL statements, query results,
and commit/abort commands via an AMP socket to a pooling process.
"""
implements(IAsyncTransaction)
def __init__(self, client, transactionID):
"""
Initialize a transaction with a L{ConnectionPoolClient} and a unique
transaction identifier.
"""
super(_NetTransaction, self).__init__()
self._client = client
self._transactionID = transactionID
self._completed = False
self._committing = False
self._committed = False
@property
def paramstyle(self):
"""
Forward C{paramstyle} attribute to the client.
"""
return self._client.paramstyle
@property
def dialect(self):
"""
Forward C{dialect} attribute to the client.
"""
return self._client.dialect
def execSQL(self, sql, args=None, raiseOnZeroRowCount=None, blockID=""):
if not blockID:
if self._completed:
raise AlreadyFinishedError()
if args is None:
args = []
client = self._client
queryID = str(client._nextID())
query = client._queries[queryID] = _Query(sql, raiseOnZeroRowCount,
args)
result = (
client.callRemote(
ExecSQL, queryID=queryID, sql=sql, args=args,
transactionID=self._transactionID, blockID=blockID,
reportZeroRowCount=raiseOnZeroRowCount is not None,
)
.addCallback(lambda nothing: query.deferred)
)
return result
def _complete(self, command):
if self._completed:
raise AlreadyFinishedError()
self._completed = True
return self._client.callRemote(
command, transactionID=self._transactionID
).addCallback(lambda x: None)
def commit(self):
def reallyCommit():
self._committing = True
def done(whatever):
self._committed = True
return whatever
return self._complete(Commit).addBoth(done)
return self._commitWithHooks(reallyCommit)
def abort(self):
self._commit.clear()
self._preCommit.clear()
return self._complete(Abort).addCallback(self._abort.runHooks)
def commandBlock(self):
if self._completed:
raise AlreadyFinishedError()
blockID = str(self._client._nextID())
self._client.callRemote(
StartBlock, blockID=blockID, transactionID=self._transactionID
)
return _NetCommandBlock(self, blockID)
def __del__(self):
"""
When a L{_NetTransaction} is garabage collected, it aborts itself.
"""
if not self._completed:
def shush(f):
f.trap(ConnectionError, AlreadyFinishedError)
self.abort().addErrback(shush)
class _NetCommandBlock(object):
"""
Net command block.
"""
implements(ICommandBlock)
def __init__(self, transaction, blockID):
self._transaction = transaction
self._blockID = blockID
self._ended = False
@property
def paramstyle(self):
"""
Forward C{paramstyle} attribute to the transaction.
"""
return self._transaction.paramstyle
@property
def dialect(self):
"""
Forward C{dialect} attribute to the transaction.
"""
return self._transaction.dialect
def execSQL(self, sql, args=None, raiseOnZeroRowCount=None):
"""
Execute some SQL on this command block.
"""
if (
self._ended or self._transaction._completed and
not self._transaction._committing or self._transaction._committed
):
raise AlreadyFinishedError()
return self._transaction.execSQL(sql, args, raiseOnZeroRowCount,
self._blockID)
def end(self):
"""
End this block.
"""
if self._ended:
raise AlreadyFinishedError()
self._ended = True
self._transaction._client.callRemote(
EndBlock, blockID=self._blockID,
transactionID=self._transaction._transactionID
)
|