pgtoolkit/pgmanager.py
author Radek Brich <radek.brich@devl.cz>
Fri, 17 Aug 2012 11:07:22 +0200
changeset 40 922d7fb63384
parent 37 5b0eb4b11940
child 41 6aad5e35efe8
permissions -rw-r--r--
Add listserial tool. PgBrowser: Add list_sequences.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     2
#
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     3
# PgManager - manage database connections
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     4
#
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
     5
# Requires: Python 3.2, psycopg2
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     6
#
9
2fcc8ef0b97d Reorganize again :-) Add setup.py.
Radek Brich <radek.brich@devl.cz>
parents: 8
diff changeset
     7
# Part of pgtoolkit
2fcc8ef0b97d Reorganize again :-) Add setup.py.
Radek Brich <radek.brich@devl.cz>
parents: 8
diff changeset
     8
# http://hg.devl.cz/pgtoolkit
2fcc8ef0b97d Reorganize again :-) Add setup.py.
Radek Brich <radek.brich@devl.cz>
parents: 8
diff changeset
     9
#
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
    10
# Copyright (c) 2010, 2011, 2012  Radek Brich <radek.brich@devl.cz>
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    11
#
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    12
# Permission is hereby granted, free of charge, to any person obtaining a copy
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    13
# of this software and associated documentation files (the "Software"), to deal
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    14
# in the Software without restriction, including without limitation the rights
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    15
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    16
# copies of the Software, and to permit persons to whom the Software is
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    17
# furnished to do so, subject to the following conditions:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    18
#
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    19
# The above copyright notice and this permission notice shall be included in
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    20
# all copies or substantial portions of the Software.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    21
#
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    22
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    23
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    24
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    25
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    26
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    27
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    28
# THE SOFTWARE.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    29
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    30
"""Postgres database connection manager
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    31
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    32
PgManager wraps psycopg2 connect function, adding following features:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    33
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    34
 * Manage database connection parameters - link connection parameters
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    35
   to an unique identifier, retrieve connection object by this identifier
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    36
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    37
 * Connection pooling - connections with same identifier are pooled and reused
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    38
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    39
 * Easy query using the with statement - retrieve cursor directly by connection
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    40
   identifier, don't worry about connections
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    41
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    42
 * Dict rows - cursor has additional methods like fetchall_dict(), which
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    43
   returns dict row instead of ordinary list-like row
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    44
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    45
Example:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    46
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    47
import pgmanager
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    48
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    49
pgm = pgmanager.get_instance()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    50
pgm.create_conn(hostaddr='127.0.0.1', dbname='postgres')
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    51
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    52
with pgm.cursor() as curs:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    53
    curs.execute('SELECT now() AS now')
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    54
    row = curs.fetchone_dict()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    55
    print row.now
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    56
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    57
First, we have obtained PgManager instance. This is like calling
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    58
PgManager(), although in our example the instance is global. That means
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    59
getting the instance in another module brings us all the defined connections
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    60
etc.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    61
9
2fcc8ef0b97d Reorganize again :-) Add setup.py.
Radek Brich <radek.brich@devl.cz>
parents: 8
diff changeset
    62
On second line we have created connection named 'default' (this name can be left out).
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    63
The with statement obtains connection (actually connects to database when needed),
9
2fcc8ef0b97d Reorganize again :-) Add setup.py.
Radek Brich <radek.brich@devl.cz>
parents: 8
diff changeset
    64
then returns cursor for this connection. At the end of with statement,
2fcc8ef0b97d Reorganize again :-) Add setup.py.
Radek Brich <radek.brich@devl.cz>
parents: 8
diff changeset
    65
the connection is returned to the pool or closed (depending on number of connections
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
    66
in pool and on setting of pool_size parameter).
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    67
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    68
The row returned by fetchone_dict() is special dict object, which can be accessed
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    69
using item or attribute access, that is row['now'] or row.now.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    70
"""
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    71
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    72
from contextlib import contextmanager
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
    73
from collections import OrderedDict
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    74
import logging
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    75
import threading
24
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
    76
import multiprocessing
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    77
import select
8
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
    78
import socket
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    79
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    80
import psycopg2
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    81
import psycopg2.extensions
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    82
19
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
    83
from psycopg2 import DatabaseError, IntegrityError, OperationalError
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    84
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    85
26
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
    86
log_sql = logging.getLogger("pgmanager_sql")
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
    87
log_notices = logging.getLogger("pgmanager_notices")
20
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
    88
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
    89
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    90
class PgManagerError(Exception):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    91
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    92
    pass
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    93
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    94
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    95
class ConnectionInfo:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    96
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
    97
    def __init__(self, name, dsn, isolation_level=None, keep_alive=True,
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
    98
                 init_statement=None, pool_size=1):
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
    99
        self.name = name  # connection name is logged with SQL queries
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   100
        self.dsn = dsn
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   101
        self.isolation_level = isolation_level
19
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   102
        self.keep_alive = keep_alive
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   103
        self.init_statement = init_statement
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   104
        self.pool_size = pool_size
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   105
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   106
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   107
class RowDict(OrderedDict):
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   108
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   109
    def __getattr__(self, key):
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   110
        try:
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   111
            return self[key]
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   112
        except KeyError:
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   113
            raise AttributeError(key)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   114
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   115
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   116
class Cursor(psycopg2.extensions.cursor):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   117
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   118
    def execute(self, query, args=None):
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   119
        self._log_query(query, args)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   120
        try:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   121
            return super(Cursor, self).execute(query, args)
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   122
        except DatabaseError:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   123
            self._log_exception()
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   124
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   125
    def callproc(self, procname, args=None):
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   126
        self._log_query('CALL %s(%s)' % (procname, ','.join(args)))
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   127
        try:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   128
            return super(Cursor, self).callproc(procname, args)
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   129
        except DatabaseError:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   130
            self._log_exception()
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   131
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   132
    def row_dict(self, row, lstrip=None):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   133
        adjustname = lambda a: a
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   134
        if lstrip:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   135
            adjustname = lambda a: a.lstrip(lstrip)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   136
        return RowDict(zip([adjustname(desc[0]) for desc in self.description], row))
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   137
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   138
    def fetchone_dict(self, lstrip=None):
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   139
        '''Return one row as OrderedDict'''
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   140
        row = super(Cursor, self).fetchone()
7
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   141
        if row is None:
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   142
            return None
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   143
        return self.row_dict(row, lstrip)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   144
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   145
    def fetchall_dict(self, lstrip=None):
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   146
        '''Return all rows as OrderedDict'''
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   147
        rows = super(Cursor, self).fetchall()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   148
        return [self.row_dict(row, lstrip) for row in rows]
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   149
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   150
    def fetchone_adapted(self, lstrip=None):
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   151
        '''Like fetchone_dict() but values are quoted for direct inclusion in SQL query.
7
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   152
        
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   153
        This is useful when you need to generate SQL script from data returned
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   154
        by the query. Use mogrify() for simple cases.
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   155
        
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   156
        '''
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   157
        row = super(Cursor, self).fetchone()
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   158
        if row is None:
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   159
            return None
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   160
        return self.row_dict([self.mogrify('%s', [x]).decode('utf8') for x in row], lstrip)
7
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   161
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   162
    def fetchall_adapted(self, lstrip=None):
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   163
        '''Like fetchall_dict() but values are quoted for direct inclusion in SQL query.'''
7
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   164
        rows = super(Cursor, self).fetchall()
31
c2e6e24b83d9 Add browser - database schema browser using tuikit (curses UI). Add listdepends - tool which shows depending views for column. Update pgdatadiff - allow composite primary key. Update pgmanager - RowDict is now OrderedDict. Drop support for Python2.x.
Radek Brich <radek.brich@devl.cz>
parents: 26
diff changeset
   165
        return [self.row_dict([self.mogrify('%s', [x]).decode('utf8') for x in row], lstrip) for row in rows]
7
685b20d2d3ab Reorganize directories. PgDataDiff - reworked. PgManager - add fetchone_adapted, fetchall_adapted to cursor.
Radek Brich <radek.brich@devl.cz>
parents: 4
diff changeset
   166
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   167
    def _log_query(self, query, args=None):
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   168
        name = self.connection.name if hasattr(self.connection, 'name') else '-'
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   169
        log_sql.info('[%s] %s' % (name, self.mogrify(query, args).decode('utf8')))
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   170
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   171
    def _log_exception(self):
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   172
        name = self.connection.name if hasattr(self.connection, 'name') else '-'
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   173
        log_sql.exception('[%s] exception:' % (name,))
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   174
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   175
class Connection(psycopg2.extensions.connection):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   176
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   177
    def cursor(self, name=None):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   178
        if name is None:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   179
            return super(Connection, self).cursor(cursor_factory=Cursor)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   180
        else:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   181
            return super(Connection, self).cursor(name, cursor_factory=Cursor)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   182
8
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   183
    def keep_alive(self):
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   184
        '''Set socket to keepalive mode. Must be called before any query.'''
37
Radek Brich <radek.brich@devl.cz>
parents: 36
diff changeset
   185
        sock = socket.fromfd(self.fileno(), socket.AF_INET, socket.SOCK_STREAM)
8
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   186
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
19
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   187
        try:
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   188
            # Maximum keep-alive probes before asuming the connection is lost
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   189
            sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 5)
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   190
            # Interval (in seconds) between keep-alive probes
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   191
            sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 2)
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   192
            # Maximum idle time (in seconds) before start sending keep-alive probes
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   193
            sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 10)
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   194
        except socket.error:
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   195
            pass
37
Radek Brich <radek.brich@devl.cz>
parents: 36
diff changeset
   196
        # close duplicated fd, options set for socket stays
Radek Brich <radek.brich@devl.cz>
parents: 36
diff changeset
   197
        sock.close()
8
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   198
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   199
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   200
class PgManager:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   201
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   202
    def __init__(self):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   203
        self.conn_known = {}  # available connections
24
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   204
        self.conn_pool = {}  # active connetions
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   205
        self.lock = threading.Lock()  # mutual exclusion for threads
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   206
        self.pid = multiprocessing.current_process().pid  # forking check
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   207
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   208
    def __del__(self):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   209
        for conn in tuple(self.conn_known.keys()):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   210
            self.destroy_conn(conn)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   211
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   212
    def create_conn(self, name='default', isolation_level=None, keep_alive=True, init_statement=None,
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   213
                    pool_size=1, dsn=None, **kwargs):
19
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   214
        '''Create named connection.
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   215
        
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   216
        name -- name for connection (default is "default")
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   217
        pool_size -- how many connections will be kept open in pool
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   218
                     (more connections will still be created but they will be closed by put_conn)
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   219
                     None - disable pool, always return same connection
19
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   220
        isolation_level -- "autocommit", "read_committed", "serializable" or None for driver default
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   221
        keep_alive -- set socket to keepalive mode
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   222
        dsn -- string with connection parameters (dsn means Data Source Name)
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   223
        
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   224
        Alternative for dsn is keyword args (same names as in dsn).
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   225
        
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   226
        '''
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   227
        if name in self.conn_known:
2
efee419b7a2d Fix pgmanager exceptions.
Radek Brich <radek.brich@devl.cz>
parents: 0
diff changeset
   228
            raise PgManagerError('Connection name "%s" already registered.' % name)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   229
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   230
        if dsn is None:
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   231
            dsn = ' '.join([x[0]+'='+str(x[1]) for x in kwargs.items() if x[1] is not None])
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   232
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   233
        isolation_level = self._normalize_isolation_level(isolation_level)
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   234
        ci = ConnectionInfo(name, dsn, isolation_level, keep_alive, init_statement, pool_size)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   235
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   236
        self.conn_known[name] = ci
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   237
        self.conn_pool[name] = []
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   238
    
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   239
    def create_conn_listen(self, name, channel, dsn=None, copy_dsn=None, **kwargs):
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   240
        '''Create connection listening for notifies.
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   241
        
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   242
        Disables pool. If you want to use pool, create other connection for that.
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   243
        This connection can be used as usual: conn.cursor() etc.
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   244
        Don't use PgManager's cursor() and put_conn(). 
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   245
        
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   246
        name -- name for connection
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   247
        channel -- listen on this channel
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   248
        copy_dsn -- specify name of other connection and its dsn will be used
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   249
        
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   250
        Other parameters forwarded to create_conn().
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   251
        
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   252
        '''
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   253
        if dsn is None and copy_dsn:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   254
            try:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   255
                dsn = self.conn_known[copy_dsn].dsn
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   256
            except KeyError:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   257
                raise PgManagerError("Connection name '%s' not registered." % copy_dsn)
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   258
        listen_query = "LISTEN " + channel
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   259
        self.create_conn(name=name, pool_size=None, isolation_level='autocommit', init_statement=listen_query,
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   260
            dsn=dsn, **kwargs)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   261
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   262
    def close_conn(self, name='default'):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   263
        '''Close all connections of given name.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   264
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   265
        Connection credentials are still saved.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   266
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   267
        '''
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   268
        while len(self.conn_pool[name]):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   269
            conn = self.conn_pool[name].pop()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   270
            conn.close()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   271
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   272
    def destroy_conn(self, name='default'):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   273
        '''Destroy connection.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   274
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   275
        Counterpart of create_conn.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   276
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   277
        '''
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   278
        if not name in self.conn_known:
2
efee419b7a2d Fix pgmanager exceptions.
Radek Brich <radek.brich@devl.cz>
parents: 0
diff changeset
   279
            raise PgManagerError('Connection name "%s" not registered.' % name)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   280
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   281
        self.close_conn(name)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   282
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   283
        del self.conn_known[name]
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   284
        del self.conn_pool[name]
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   285
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   286
    def get_conn(self, name='default'):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   287
        '''Get connection of name 'name' from pool.'''
24
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   288
        self._check_fork()
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   289
        self.lock.acquire()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   290
        try:
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   291
            try:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   292
                ci = self.conn_known[name]
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   293
            except KeyError:
2
efee419b7a2d Fix pgmanager exceptions.
Radek Brich <radek.brich@devl.cz>
parents: 0
diff changeset
   294
                raise PgManagerError("Connection name '%s' not registered." % name)
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   295
            
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   296
            # no pool, just one static connection
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   297
            if ci.pool_size is None:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   298
                # check for existing connection
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   299
                try:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   300
                    conn = self.conn_pool[name][0]
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   301
                    if conn.closed:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   302
                        conn = None
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   303
                except IndexError:
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   304
                    conn = None
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   305
                    self.conn_pool[name].append(conn)
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   306
                # if no existing connection is valid, connect new one and save it
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   307
                if conn is None:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   308
                    conn = self._connect(ci)
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   309
                    self.conn_pool[name][0] = conn
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   310
            
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   311
            # connection from pool
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   312
            else:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   313
                conn = None
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   314
                while len(self.conn_pool[name]) and conn is None:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   315
                    conn = self.conn_pool[name].pop()
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   316
                    if conn.closed:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   317
                        conn = None
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   318
                
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   319
                if conn is None:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   320
                    conn = self._connect(ci)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   321
        finally:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   322
            self.lock.release()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   323
        return conn
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   324
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   325
    def put_conn(self, conn, name='default'):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   326
        '''Put connection back to pool.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   327
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   328
        Name must be same as used for get_conn,
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   329
        otherwise things become broken.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   330
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   331
        '''
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   332
        self.lock.acquire()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   333
        try:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   334
            if not name in self.conn_known:
2
efee419b7a2d Fix pgmanager exceptions.
Radek Brich <radek.brich@devl.cz>
parents: 0
diff changeset
   335
                raise PgManagerError("Connection name '%s' not registered." % name)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   336
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   337
            if len(self.conn_pool[name]) >= self.conn_known[name].pool_size:
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   338
                conn.close()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   339
                return
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   340
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   341
            if conn.get_transaction_status() == psycopg2.extensions.TRANSACTION_STATUS_UNKNOWN:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   342
                conn.close()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   343
                return
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   344
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   345
            # connection returned to the pool must not be in transaction
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   346
            if conn.get_transaction_status() != psycopg2.extensions.TRANSACTION_STATUS_IDLE:
33
bd0beda49bcb PgManager: log connection name with queries. BatchUpdateTool: handle some possible exceptions and try reconnect to database.
Radek Brich <radek.brich@devl.cz>
parents: 31
diff changeset
   347
                try:
bd0beda49bcb PgManager: log connection name with queries. BatchUpdateTool: handle some possible exceptions and try reconnect to database.
Radek Brich <radek.brich@devl.cz>
parents: 31
diff changeset
   348
                    conn.rollback()
bd0beda49bcb PgManager: log connection name with queries. BatchUpdateTool: handle some possible exceptions and try reconnect to database.
Radek Brich <radek.brich@devl.cz>
parents: 31
diff changeset
   349
                except OperationalError:
bd0beda49bcb PgManager: log connection name with queries. BatchUpdateTool: handle some possible exceptions and try reconnect to database.
Radek Brich <radek.brich@devl.cz>
parents: 31
diff changeset
   350
                    if not conn.closed:
bd0beda49bcb PgManager: log connection name with queries. BatchUpdateTool: handle some possible exceptions and try reconnect to database.
Radek Brich <radek.brich@devl.cz>
parents: 31
diff changeset
   351
                        conn.close()
bd0beda49bcb PgManager: log connection name with queries. BatchUpdateTool: handle some possible exceptions and try reconnect to database.
Radek Brich <radek.brich@devl.cz>
parents: 31
diff changeset
   352
                    return
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   353
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   354
            self.conn_pool[name].append(conn)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   355
        finally:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   356
            self.lock.release()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   357
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   358
    @contextmanager
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   359
    def cursor(self, name='default'):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   360
        '''Cursor context.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   361
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   362
        Uses any connection of name 'name' from pool
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   363
        and returns cursor for that connection.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   364
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   365
        '''
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   366
        conn = self.get_conn(name)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   367
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   368
        try:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   369
            curs = conn.cursor()
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   370
            yield curs
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   371
        finally:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   372
            curs.close()
26
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
   373
            self.log_notices(conn)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   374
            self.put_conn(conn, name)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   375
26
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
   376
    def log_notices(self, conn):
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
   377
        for notice in conn.notices:
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
   378
            log_notices.info(notice.rstrip())
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
   379
        conn.notices[:] = []
7f219da7ab71 Add logging mechanism for notices from postgres server. Rename SQL log to "pgmanager_sql".
Radek Brich <radek.brich@devl.cz>
parents: 24
diff changeset
   380
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   381
    def wait_for_notify(self, name='default', timeout=5.0):
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   382
        '''Wait for asynchronous notifies, return the last one.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   383
        
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   384
        name -- name of connection, must be created using create_conn_listen()
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   385
        timeout -- in seconds, floating point (None - wait forever)
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   386
        
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   387
        Returns None on timeout.
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   388
        
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   389
        '''
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   390
        conn = self.get_conn(name)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   391
        
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   392
        # return any notifies on stack
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   393
        if conn.notifies:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   394
            return conn.notifies.pop()
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   395
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   396
        if select.select([conn], [], [], timeout) == ([], [], []):
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   397
            # timeout
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   398
            return None
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   399
        else:
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   400
            conn.poll()
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   401
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   402
            # return just the last notify (we do not care for older ones)
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   403
            if conn.notifies:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   404
                return conn.notifies.pop()
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   405
            return None
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   406
8
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   407
    def _connect(self, ci):
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   408
        conn = psycopg2.connect(ci.dsn, connection_factory=Connection)
36
e67101c22e83 pgmanager: Add create_conn_listen() which should be used with wait_for_notify. Update wait_for_notify() to not use put_conn(). Add name to ConnectionInfo. Log queries before they are called. Log exceptions. Add notifyexample.
Radek Brich <radek.brich@devl.cz>
parents: 33
diff changeset
   409
        conn.name = ci.name
19
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   410
        if ci.keep_alive:
e526ca146fa9 Add documentation for create_conn(). Fix keep_alive - do not crash if socket settings are not supported.
Radek Brich <radek.brich@devl.cz>
parents: 9
diff changeset
   411
            conn.keep_alive()
8
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   412
        if not ci.isolation_level is None:
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   413
            conn.set_isolation_level(ci.isolation_level)
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   414
        if ci.init_statement:
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   415
            curs = conn.cursor()
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   416
            curs.execute(ci.init_statement)
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   417
            curs.close()
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   418
        return conn
2911935c524d pgmanager: Add keep_alive support.
Radek Brich <radek.brich@devl.cz>
parents: 7
diff changeset
   419
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   420
    def _normalize_isolation_level(self, level):
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   421
        if type(level) == str:
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   422
            if level.lower() == 'autocommit':
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   423
                return psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   424
            if level.lower() == 'read_committed':
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   425
                return psycopg2.extensions.ISOLATION_LEVEL_READ_COMMITTED
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   426
            if level.lower() == 'serializable':
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   427
                return psycopg2.extensions.ISOLATION_LEVEL_SERIALIZABLE
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   428
            raise PgManagerError('Unknown isolation level name: "%s"', level)
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   429
        return level
24
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   430
    
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   431
    def _check_fork(self):
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   432
        '''Check if process was forked (PID has changed).
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   433
        
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   434
        If it was, clean parent's connections.
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   435
        New connections are created for children.
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   436
        Known connection credentials are inherited, but not shared.
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   437
        
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   438
        '''
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   439
        if self.pid == multiprocessing.current_process().pid:
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   440
            # PID has not changed
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   441
            return
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   442
        
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   443
        # update saved PID
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   444
        self.pid = multiprocessing.current_process().pid
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   445
        # reinitialize lock
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   446
        self.lock = threading.Lock()
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   447
        # clean parent's connections
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   448
        for name in self.conn_pool:
5664afa530e5 PgManager: Add partial support for multiprocessing.
Radek Brich <radek.brich@devl.cz>
parents: 23
diff changeset
   449
            self.conn_pool[name] = []
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   450
20
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
   451
    @classmethod
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
   452
    def get_instance(cls):
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
   453
        if not hasattr(cls, '_instance'):
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
   454
            cls._instance = cls()
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
   455
        return cls._instance
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   456
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   457
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   458
def get_instance():
20
73f0d53fef6b PgManager: Do not add NullHandler to logger. Rewrite get_instance(). ToolBase: fix prepare_conns() method.
Radek Brich <radek.brich@devl.cz>
parents: 19
diff changeset
   459
    return PgManager.get_instance()
0
eaae9539e910 Postgres tools.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   460