pvl/verkko/db.py
author Tero Marttila <terom@paivola.fi>
Sat, 26 Jan 2013 17:52:40 +0200
changeset 178 f9f5e669bace
parent 40 bc8ab048b208
child 184 eef756d892e9
permissions -rw-r--r--
pvl.verkko: refactor into dhcp -> hosts -> web+db modules, reworking index page
178
f9f5e669bace pvl.verkko: refactor into dhcp -> hosts -> web+db modules, reworking index page
Tero Marttila <terom@paivola.fi>
parents: 40
diff changeset
     1
"""
f9f5e669bace pvl.verkko: refactor into dhcp -> hosts -> web+db modules, reworking index page
Tero Marttila <terom@paivola.fi>
parents: 40
diff changeset
     2
    SQLAlchemy Database tables model for pvl.verkko
f9f5e669bace pvl.verkko: refactor into dhcp -> hosts -> web+db modules, reworking index page
Tero Marttila <terom@paivola.fi>
parents: 40
diff changeset
     3
"""
f9f5e669bace pvl.verkko: refactor into dhcp -> hosts -> web+db modules, reworking index page
Tero Marttila <terom@paivola.fi>
parents: 40
diff changeset
     4
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     5
import sqlalchemy
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     6
from sqlalchemy import *
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     7
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     8
import logging; log = logging.getLogger('pvl.verkko.db')
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     9
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    10
# schema
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    11
metadata = MetaData()
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    12
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
dhcp_hosts = Table('dhcp_hosts', metadata,
17
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    14
    Column('id',            Integer,    primary_key=True),
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
    # unique
14
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    17
    Column('ip',            String,     nullable=False),
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    18
    Column('mac',           String,     nullable=False),
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    19
    Column('gw',            String,     nullable=False),
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    20
    
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    21
    # updated
14
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    22
    Column('first_seen',    DateTime,   nullable=False),
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    23
    Column('last_seen',     DateTime,   nullable=False),
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    24
    
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    25
    # scalar; updated
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    26
    Column('name',          String,     nullable=True),
16
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    27
    Column('state',         String,     nullable=True),
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    28
    Column('error',         String,     nullable=True),
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    29
    
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    30
    # counters
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    31
    Column('count',         Integer,    default=1),
14
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    32
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    33
    UniqueConstraint('ip', 'mac', 'gw'),
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    34
)
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
17
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    36
dhcp_leases = Table('dhcp_leases', metadata,
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    37
    Column('id',            Integer,    primary_key=True),
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    38
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    39
    Column('ip',            String,     nullable=False),
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    40
    Column('mac',           String,     nullable=False),
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    41
    Column('hostname',      String,     nullable=True),
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    42
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    43
    Column('starts',        DateTime,   nullable=False),
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    44
    Column('ends',          DateTime,   nullable=True),  # never
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    45
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    46
    Column('state',         String,     nullable=True),
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    47
    Column('next',          String,     nullable=True),
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    48
)
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    49
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    50
# for ORM models
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    51
from sqlalchemy.orm import mapper, sessionmaker
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    52
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
Session = sessionmaker()
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    55
class Database (object) :
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
    """
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
        Our underlying database.
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    58
    """
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
    
2
b0659c867226 fixup pvl.verkko.wsgi.Application + test.py/wsgi to remove default path from pvl.verkko.db
Tero Marttila <terom@paivola.fi>
parents: 1
diff changeset
    60
    def __init__ (self, database) :
b0659c867226 fixup pvl.verkko.wsgi.Application + test.py/wsgi to remove default path from pvl.verkko.db
Tero Marttila <terom@paivola.fi>
parents: 1
diff changeset
    61
        """
b0659c867226 fixup pvl.verkko.wsgi.Application + test.py/wsgi to remove default path from pvl.verkko.db
Tero Marttila <terom@paivola.fi>
parents: 1
diff changeset
    62
            database        - sqlalchemy connection URI
b0659c867226 fixup pvl.verkko.wsgi.Application + test.py/wsgi to remove default path from pvl.verkko.db
Tero Marttila <terom@paivola.fi>
parents: 1
diff changeset
    63
        """
b0659c867226 fixup pvl.verkko.wsgi.Application + test.py/wsgi to remove default path from pvl.verkko.db
Tero Marttila <terom@paivola.fi>
parents: 1
diff changeset
    64
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
        self.engine = create_engine(database, 
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    66
            echo    = (log.isEnabledFor(logging.DEBUG)),
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    67
        )
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    68
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    69
    # ORM
16
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    70
    def session (self) :
40
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    71
        """
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    72
            Return a new ORM session bound to our engine.
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    73
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    74
            XXX: session lifetimes? Explicit close?
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    75
        """
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    76
16
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    77
        return Session(bind=self.engine)
51509b5ce1c0 request per session, move to postgres, rename columns, fixup state/name/error handling in updates
Tero Marttila <terom@paivola.fi>
parents: 14
diff changeset
    78
   
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    79
    # SQL
40
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    80
    def connect (self) :
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    81
        return self.engine.connect()
bc8ab048b208 fixfix + docdoc
Tero Marttila <terom@paivola.fi>
parents: 17
diff changeset
    82
17
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    83
    def execute (self, query) :
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    84
        return self.engine.execute(query)
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    85
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    86
    def select (self, query) :
14
02c21749cb4f pvl.verkko: re-add last_msg back to db, implement state, seen filtering in web frontend
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    87
        return self.engine.execute(query)
0
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    88
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    89
    def get (self, query) :
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    90
        """
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    91
            Fetch a single row.
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    92
            
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    93
            XXX: returning None if not found
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    94
        """
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    95
91c739202f06 initial code for dhcp hosts
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    96
        return self.select(query).fetchone()
17
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    97
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    98
    def insert (self, insert) :
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
    99
        """
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   100
            Execute given INSERT query, returning the inserted primary key.
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   101
        """
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   102
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   103
        result = self.engine.execute(insert)
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   104
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   105
        id, = result.inserted_primary_key
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   106
        
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   107
        return id
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   108
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   109
    def update (self, update) :
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   110
        """
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   111
            Execute given UPDATE query, returning the number of matched rows.
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   112
        """
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   113
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   114
        result = self.engine.execute(update)
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   115
        
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   116
        return result.rowcount
29f0cf9220e0 track dhcp leases, using pvl.verkko.dhcp.leases from pvl-collectd..
Tero Marttila <terom@paivola.fi>
parents: 16
diff changeset
   117