-# -*- encoding: utf-8 -*-
+# -*- coding: utf-8 -*-
##############################################################################
#
-# OpenERP, Open Source Management Solution
-# Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
-# $Id$
+# OpenERP, Open Source Management Solution
+# Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
#
# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# 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.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
+# GNU Affero General Public License for more details.
#
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
__all__ = ['db_connect', 'close_db']
-import netsvc
+from threading import currentThread
+import logging
from psycopg2.extensions import ISOLATION_LEVEL_AUTOCOMMIT, ISOLATION_LEVEL_READ_COMMITTED, ISOLATION_LEVEL_SERIALIZABLE
from psycopg2.psycopg1 import cursor as psycopg1cursor
from psycopg2.pool import PoolError
from datetime import datetime as mdt
from datetime import timedelta
import threading
+from inspect import stack
import re
re_from = re.compile('.* from "?([a-zA-Z_0-9]+)"? .*$');
re_into = re.compile('.* into "?([a-zA-Z_0-9]+)"? .*$');
-
-def log(msg, lvl=netsvc.LOG_DEBUG):
- logger = netsvc.Logger()
- logger.notifyChannel('sql', lvl, msg)
+sql_counter = 0
class Cursor(object):
- IN_MAX = 1000
+ IN_MAX = 1000 # decent limit on size of IN queries - guideline = Oracle limit
+ __logger = logging.getLogger('db.cursor')
def check(f):
@wraps(f)
def wrapper(self, *args, **kwargs):
if self.__closed:
- raise psycopg2.ProgrammingError('Unable to use the cursor after having closing it')
+ raise psycopg2.ProgrammingError('Unable to use the cursor after having closed it')
return f(self, *args, **kwargs)
return wrapper
def __init__(self, pool, dbname, serialized=False):
self.sql_from_log = {}
self.sql_into_log = {}
- self.sql_log = False
- self.sql_log_count = 0
+ # default log level determined at cursor creation, could be
+ # overridden later for debugging purposes
+ self.sql_log = self.__logger.isEnabledFor(logging.DEBUG_SQL)
+
+ self.sql_log_count = 0
self.__closed = True # avoid the call of close() (by __del__) if an exception
# is raised by any of the following initialisations
self._pool = pool
self._obj = self._cnx.cursor(cursor_factory=psycopg1cursor)
self.__closed = False # real initialisation value
self.autocommit(False)
-
- if tools.config['log_level'] in (netsvc.LOG_DEBUG, netsvc.LOG_DEBUG_RPC):
- from inspect import stack
- self.__caller = tuple(stack()[2][1:3])
+ self.__caller = tuple(stack()[2][1:3])
def __del__(self):
if not self.__closed:
# but the database connection is not put back into the connection
# pool, preventing some operation on the database like dropping it.
# This can also lead to a server overload.
- if tools.config['log_level'] in (netsvc.LOG_DEBUG, netsvc.LOG_DEBUG_RPC):
- msg = "Cursor not closed explicitly\n" \
- "Cursor was created at %s:%s" % self.__caller
- log(msg, netsvc.LOG_WARNING)
- self.close()
+ msg = "Cursor not closed explicitly\n" \
+ "Cursor was created at %s:%s"
+ self.__logger.warn(msg, *self.__caller)
+ self._close(True)
@check
- def execute(self, query, params=None):
+ def execute(self, query, params=None, log_exceptions=True):
if '%d' in query or '%f' in query:
- log(query, netsvc.LOG_WARNING)
- log("SQL queries mustn't contain %d or %f anymore. Use only %s", netsvc.LOG_WARNING)
- if params:
- query = query.replace('%d', '%s').replace('%f', '%s')
+ self.__logger.warn(query)
+ self.__logger.warn("SQL queries cannot contain %d or %f anymore. "
+ "Use only %s")
if self.sql_log:
now = mdt.now()
try:
params = params or None
res = self._obj.execute(query, params)
- except Exception, e:
- log("bad query: %s" % self._obj.query)
- log(e)
+ except psycopg2.ProgrammingError, pe:
+ if log_exceptions or self.sql_log:
+ self.__logger.error("Programming error: %s, in query %s", pe, query)
+ raise
+ except Exception:
+ if log_exceptions or self.sql_log:
+ self.__logger.exception("bad query: %s", self._obj.query or query)
raise
if self.sql_log:
delay = mdt.now() - now
delay = delay.seconds * 1E6 + delay.microseconds
- log("query: %s" % self._obj.query)
+ self.__logger.log(logging.DEBUG_SQL, "query: %s", self._obj.query)
self.sql_log_count+=1
res_from = re_from.match(query.lower())
if res_from:
self.sql_into_log[res_into.group(1)][1] += delay
return res
+
+ def split_for_in_conditions(self, ids):
+ """Split a list of identifiers into one or more smaller tuples
+ safe for IN conditions, after uniquifying them."""
+ return tools.misc.split_every(self.IN_MAX, set(ids))
+
def print_log(self):
+ global sql_counter
+ sql_counter += self.sql_log_count
if not self.sql_log:
return
-
def process(type):
sqllogs = {'from':self.sql_from_log, 'into':self.sql_into_log}
- if not sqllogs[type]:
- return
- sqllogitems = sqllogs[type].items()
- sqllogitems.sort(key=lambda k: k[1][1])
sum = 0
- log("SQL LOG %s:" % (type,))
- for r in sqllogitems:
- delay = timedelta(microseconds=r[1][1])
- log("table: %s: %s/%s" %(r[0], str(delay), r[1][0]))
- sum+= r[1][1]
+ if sqllogs[type]:
+ sqllogitems = sqllogs[type].items()
+ sqllogitems.sort(key=lambda k: k[1][1])
+ self.__logger.log(logging.DEBUG_SQL, "SQL LOG %s:", type)
+ sqllogitems.sort(lambda x,y: cmp(x[1][0], y[1][0]))
+ for r in sqllogitems:
+ delay = timedelta(microseconds=r[1][1])
+ self.__logger.log(logging.DEBUG_SQL, "table: %s: %s/%s",
+ r[0], delay, r[1][0])
+ sum+= r[1][1]
+ sqllogs[type].clear()
sum = timedelta(microseconds=sum)
- log("SUM:%s/%d" % (str(sum), self.sql_log_count))
+ self.__logger.log(logging.DEBUG_SQL, "SUM %s:%s/%d [%d]",
+ type, sum, self.sql_log_count, sql_counter)
sqllogs[type].clear()
process('from')
process('into')
@check
def close(self):
+ return self._close(False)
+
+ def _close(self, leak=False):
if not self._obj:
return
# part because browse records keep a reference to the cursor.
del self._obj
self.__closed = True
- self._pool.give_back(self._cnx)
+
+ if leak:
+ self._cnx.leaked = True
+ else:
+ keep_in_pool = self.dbname not in ('template1', 'template0', 'postgres')
+ self._pool.give_back(self._cnx, keep_in_pool=keep_in_pool)
@check
def autocommit(self, on):
return getattr(self._obj, name)
+class PsycoConnection(psycopg2.extensions.connection):
+ pass
+
class ConnectionPool(object):
+ __logger = logging.getLogger('db.connection_pool')
+
def locked(fun):
@wraps(fun)
def _locked(self, *args, **kwargs):
self._connections = []
self._maxconn = max(maxconn, 1)
self._lock = threading.Lock()
- self._logger = netsvc.Logger()
- def _debug(self, msg):
- self._logger.notifyChannel('ConnectionPool', netsvc.LOG_DEBUG, msg)
- #pass
+ def __repr__(self):
+ used = len([1 for c, u in self._connections[:] if u])
+ count = len(self._connections)
+ return "ConnectionPool(used=%d/count=%d/max=%d)" % (used, count, self._maxconn)
+
+ def _debug(self, msg, *args):
+ self.__logger.log(logging.DEBUG_SQL, ('%r ' + msg), self, *args)
@locked
def borrow(self, dsn):
- self._debug('Borrow connection to %s' % (dsn,))
+ self._debug('Borrow connection to %r', dsn)
+
+ # free leaked connections
+ for i, (cnx, _) in tools.reverse_enumerate(self._connections):
+ if getattr(cnx, 'leaked', False):
+ delattr(cnx, 'leaked')
+ self._connections.pop(i)
+ self._connections.append((cnx, False))
+ self.__logger.warn('%r: Free leaked connection to %r', self, cnx.dsn)
- result = None
for i, (cnx, used) in enumerate(self._connections):
if not used and dsn_are_equals(cnx.dsn, dsn):
- self._debug('Existing connection found at index %d' % i)
-
self._connections.pop(i)
self._connections.append((cnx, True))
+ self._debug('Existing connection found at index %d', i)
- result = cnx
- break
- if result:
- return result
+ return cnx
if len(self._connections) >= self._maxconn:
- # try to remove the older connection not used
+ # try to remove the oldest connection not used
for i, (cnx, used) in enumerate(self._connections):
if not used:
- self._debug('Removing old connection at index %d: %s' % (i, cnx.dsn))
self._connections.pop(i)
+ self._debug('Removing old connection at index %d: %r', i, cnx.dsn)
break
else:
# note: this code is called only if the for loop has completed (no break)
- raise PoolError('Connection Pool Full')
+ raise PoolError('The Connection Pool Is Full')
- self._debug('Create new connection')
- result = psycopg2.connect(dsn=dsn)
+ result = psycopg2.connect(dsn=dsn, connection_factory=PsycoConnection)
self._connections.append((result, True))
+ self._debug('Create new connection')
return result
@locked
- def give_back(self, connection):
- self._debug('Give back connection to %s' % (connection.dsn,))
+ def give_back(self, connection, keep_in_pool=True):
+ self._debug('Give back connection to %r', connection.dsn)
for i, (cnx, used) in enumerate(self._connections):
if cnx is connection:
self._connections.pop(i)
- self._connections.append((cnx, False))
+ if keep_in_pool:
+ self._connections.append((cnx, False))
+ self._debug('Put connection to %r in pool', cnx.dsn)
+ else:
+ self._debug('Forgot connection to %r', cnx.dsn)
break
else:
raise PoolError('This connection does not below to the pool')
@locked
def close_all(self, dsn):
- self._debug('Close all connections to %s' % (dsn,))
+ self.__logger.info('%r: Close all connections to %r', self, dsn)
for i, (cnx, used) in tools.reverse_enumerate(self._connections):
if dsn_are_equals(cnx.dsn, dsn):
cnx.close()
class Connection(object):
- def _debug(self, msg):
- self._logger.notifyChannel('Connection', netsvc.LOG_DEBUG, msg)
+ __logger = logging.getLogger('db.connection')
def __init__(self, pool, dbname):
self.dbname = dbname
self._pool = pool
- self._logger = netsvc.Logger()
def cursor(self, serialized=False):
cursor_type = serialized and 'serialized ' or ''
- self._debug('create %scursor to "%s"' % (cursor_type, self.dbname,))
+ self.__logger.log(logging.DEBUG_SQL, 'create %scursor to %r', cursor_type, self.dbname)
return Cursor(self._pool, self.dbname, serialized=serialized)
def serialized_cursor(self):
_Pool = ConnectionPool(int(tools.config['db_maxconn']))
def db_connect(db_name):
+ currentThread().dbname = db_name
return Connection(_Pool, db_name)
def close_db(db_name):
_Pool.close_all(dsn(db_name))
tools.cache.clean_caches_for_db(db_name)
+ ct = currentThread()
+ if hasattr(ct, 'dbname'):
+ delattr(ct, 'dbname')
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: