Project

General

Profile

1
# SQL code generation
2

    
3
import sql
4
import strings
5
import util
6

    
7
##### SQL code objects
8

    
9
class Code:
10
    def to_str(self, db): raise NotImplemented()
11

    
12
class Literal(Code):
13
    def __init__(self, value): self.value = value
14
    
15
    def to_str(self, db): return db.esc_value(self.value)
16

    
17
def is_null(value): return isinstance(value, Literal) and value.value == None
18

    
19
class Table(Code):
20
    def __init__(self, name, schema=None):
21
        '''
22
        @param schema str|None (for no schema)
23
        '''
24
        self.name = name
25
        self.schema = schema
26
    
27
    def to_str(self, db): return sql.qual_name(db, self.schema, self.name)
28

    
29
def as_Table(table):
30
    if table == None or isinstance(table, Table): return table
31
    elif isinstance(table, tuple):
32
        schema, table = table
33
        return Table(table, schema)
34
    else: return Table(table)
35

    
36
class Col(Code):
37
    def __init__(self, name, table=None):
38
        '''
39
        @param table Table|None (for no table)
40
        '''
41
        assert table == None or isinstance(table, Table)
42
        
43
        self.name = name
44
        self.table = table
45
    
46
    def to_str(self, db):
47
        str_ = ''
48
        if self.table != None: str_ += self.table.to_str(db)+'.'
49
        str_ += sql.esc_name(db, self.name)
50
        return str_
51

    
52
class ValueCond:
53
    def __init__(self, value):
54
        if not isinstance(value, Code): value = Literal(value)
55
        
56
        self.value = value
57
    
58
    def to_str(self, db, left_value):
59
        '''
60
        @param left_value The Code object that the condition is being applied on
61
        '''
62
        raise NotImplemented()
63

    
64
class CompareCond(ValueCond):
65
    def __init__(self, value, operator='='):
66
        '''
67
        @param operator By default, compares NULL values literally. Use '~=' or
68
            '~!=' to pass NULLs through.
69
        '''
70
        ValueCond.__init__(self, value)
71
        self.operator = operator
72
    
73
    def to_str(self, db, left_value):
74
        if not isinstance(left_value, Code): left_value = Col(left_value)
75
        
76
        right_value = self.value
77
        left = left_value.to_str(db)
78
        right = right_value.to_str(db)
79
        
80
        # Parse operator
81
        operator = self.operator
82
        passthru_null_ref = [False]
83
        operator = strings.remove_prefix('~', operator, passthru_null_ref)
84
        neg_ref = [False]
85
        operator = strings.remove_prefix('!', operator, neg_ref)
86
        equals = operator.endswith('=')
87
        if equals and is_null(self.value): operator = 'IS'
88
        
89
        # Create str
90
        str_ = left+' '+operator+' '+right
91
        if equals and not passthru_null_ref[0] and isinstance(right_value, Col):
92
            str_ += ' OR ('+left+' IS NULL AND '+right+' IS NULL)'
93
        if neg_ref[0]: str_ = 'NOT ('+str_+')'
94
        return str_
95

    
96
def as_ValueCond(value):
97
    if not isinstance(value, ValueCond): return CompareCond(value)
98
    else: return value
99

    
100
##### Old-style format support
101

    
102
def unescape_table(table):
103
    '''Currently only works with PostgreSQL.'''
104
    if table == None: return table
105
    
106
    assert table.count('.') <= 1
107
    parts = tuple((v.replace('"', '') for v in table.split('"."', 2)))
108
    if len(parts) == 1: parts, = parts
109
    return parts
110

    
111
def col2sql_gen(col, default_table=None, table_is_esc=False):
112
    '''Converts old-style (tuple-based) columns to sql_gen-compatible columns.
113
    @param table_is_esc If False, assumes any table name is not escaped or that
114
        re-escaping it will produce the same value.
115
    '''
116
    if isinstance(col, Col): return col # already in sql_gen form
117
    
118
    table = default_table
119
    if isinstance(col, tuple): table, col = col
120
    if table_is_esc: table = unescape_table(table)
121
    return Col(col, as_Table(table))
122

    
123
def value2sql_gen(value, default_table=None, table_is_esc=False,
124
    assume_col=False):
125
    '''Converts old-style (tuple-based) values to sql_gen-compatible values.
126
    @param table_is_esc If False, assumes any table name is not escaped or that
127
        re-escaping it will produce the same value.
128
    '''
129
    if isinstance(value, Code): return value # already in sql_gen form
130
    
131
    is_tuple = isinstance(value, tuple)
132
    if is_tuple and len(value) == 1: return Literal(value[0])
133
    if is_tuple or (assume_col and util.is_str(value)):
134
        return col2sql_gen(value, default_table, table_is_esc)
135
    else: return Literal(value)
136

    
137
def cond2sql_gen(value, default_table=None, table_is_esc=False):
138
    '''Converts old-style (tuple-based) conditions to sql_gen-compatible values.
139
    @param table_is_esc If False, assumes any table name is not escaped or that
140
        re-escaping it will produce the same value.
141
    '''
142
    if isinstance(value, ValueCond): return value # already in sql_gen form
143
    
144
    return as_ValueCond(value2sql_gen(value, default_table, table_is_esc))
(23-23/34)