Project

General

Profile

1
# SQL code generation
2

    
3
import operator
4

    
5
import objects
6
import strings
7
import util
8

    
9
##### SQL code objects
10

    
11
class MockDb:
12
    def esc_value(self, value): return repr(value)
13
    
14
    def esc_name(self, name): return '"'+name+'"'
15
mockDb = MockDb()
16

    
17
class Code(objects.BasicObject):
18
    def to_str(self, db): raise NotImplemented()
19
    
20
    def __str__(self): return self.to_str(mockDb)
21

    
22
class CustomCode(Code):
23
    def __init__(self, str_): self.str_ = str_
24
    
25
    def to_str(self, db): return self.str_
26

    
27
##### Literal values
28

    
29
class Literal(Code):
30
    def __init__(self, value): self.value = value
31
    
32
    def to_str(self, db): return db.esc_value(self.value)
33

    
34
def as_Value(value):
35
    if isinstance(value, Code): return value
36
    else: return Literal(value)
37

    
38
def is_null(value): return isinstance(value, Literal) and value.value == None
39

    
40
##### Tables
41

    
42
class Table(Code):
43
    def __init__(self, name, schema=None):
44
        '''
45
        @param schema str|None (for no schema)
46
        '''
47
        self.name = name
48
        self.schema = schema
49
    
50
    def to_str(self, db):
51
        str_ = ''
52
        if self.schema != None: str_ += db.esc_name(self.schema)+'.'
53
        str_ += db.esc_name(self.name)
54
        return str_
55
    
56
    def to_Table(self): return self
57

    
58
def as_Table(table):
59
    if table == None or isinstance(table, Code): return table
60
    else: return Table(table)
61

    
62
class NamedTable(Table):
63
    def __init__(self, name, code, cols=None):
64
        Table.__init__(self, name)
65
        
66
        if not isinstance(code, Code): code = Table(code)
67
        
68
        self.code = code
69
        self.cols = cols
70
    
71
    def to_str(self, db):
72
        str_ = self.code.to_str(db)+' AS '+Table.to_str(self, db)
73
        if self.cols != None: str_ += ' ('+(', '.join(self.cols))+')'
74
        return str_
75
    
76
    def to_Table(self): return Table(self.name)
77

    
78
##### Columns
79

    
80
class Col(Code):
81
    def __init__(self, name, table=None):
82
        '''
83
        @param table Table|None (for no table)
84
        '''
85
        if util.is_str(table): table = Table(table)
86
        assert table == None or isinstance(table, Table)
87
        
88
        self.name = name
89
        self.table = table
90
    
91
    def to_str(self, db):
92
        str_ = ''
93
        if self.table != None: str_ += self.table.to_str(db)+'.'
94
        str_ += db.esc_name(self.name)
95
        return str_
96
    
97
    def to_Col(self): return self
98

    
99
def is_table_col(col): return col.table != None
100

    
101
def as_Col(col, table=None):
102
    assert col != None
103
    
104
    if isinstance(col, Code): return col
105
    else: return Col(col, table)
106

    
107
def to_name_only_col(col, check_table=None):
108
    col = as_Col(col)
109
    
110
    if check_table != None:
111
        table = col.table
112
        assert table == None or table == check_table
113
    return Col(col.name)
114

    
115
class NamedCol(Col):
116
    def __init__(self, name, code):
117
        Col.__init__(self, name)
118
        
119
        if not isinstance(code, Code): code = Literal(code)
120
        
121
        self.code = code
122
    
123
    def to_str(self, db):
124
        return self.code.to_str(db)+' AS '+Col.to_str(self, db)
125
    
126
    def to_Col(self): return Col(self.name)
127

    
128
##### Conditions
129

    
130
class ColValueCond(Code):
131
    def __init__(self, col, value):
132
        value = as_ValueCond(value)
133
        
134
        self.col = col
135
        self.value = value
136
    
137
    def to_str(self, db): return self.value.to_str(db, self.col)
138

    
139
##### Condition column comparisons
140

    
141
class ValueCond(objects.BasicObject):
142
    def __init__(self, value):
143
        if not isinstance(value, Code): value = Literal(value)
144
        if isinstance(value, NamedCol): value = value.code
145
        
146
        self.value = value
147
    
148
    def to_str(self, db, left_value):
149
        '''
150
        @param left_value The Code object that the condition is being applied on
151
        '''
152
        raise NotImplemented()
153
    
154
    def __str__(self): return self.to_str(mockDb, '<left_value>')
155

    
156
class CompareCond(ValueCond):
157
    def __init__(self, value, operator='='):
158
        '''
159
        @param operator By default, compares NULL values literally. Use '~=' or
160
            '~!=' to pass NULLs through.
161
        '''
162
        ValueCond.__init__(self, value)
163
        self.operator = operator
164
    
165
    def to_str(self, db, left_value):
166
        if not isinstance(left_value, Code): left_value = Col(left_value)
167
        
168
        right_value = self.value
169
        left = left_value.to_str(db)
170
        right = right_value.to_str(db)
171
        
172
        # Parse operator
173
        operator = self.operator
174
        passthru_null_ref = [False]
175
        operator = strings.remove_prefix('~', operator, passthru_null_ref)
176
        neg_ref = [False]
177
        operator = strings.remove_prefix('!', operator, neg_ref)
178
        equals = operator.endswith('=')
179
        if equals and is_null(self.value): operator = 'IS'
180
        
181
        # Create str
182
        str_ = left+' '+operator+' '+right
183
        if equals and not passthru_null_ref[0] and isinstance(right_value, Col):
184
            str_ += ' OR ('+left+' IS NULL AND '+right+' IS NULL)'
185
        if neg_ref[0]: str_ = 'NOT ('+str_+')'
186
        return str_
187

    
188
# Tells as_ValueCond() to assume a non-ValueCond is a literal value
189
assume_literal = object()
190

    
191
def as_ValueCond(value, default_table=assume_literal):
192
    if not isinstance(value, ValueCond):
193
        if default_table is not assume_literal:
194
            value = as_Col(value, default_table)
195
        return CompareCond(value)
196
    else: return value
197

    
198
##### Joins
199

    
200
join_same = object() # tells Join the left and right columns have the same name
201

    
202
# Tells Join the left and right columns have the same name and are never NULL
203
join_same_not_null = object()
204

    
205
filter_out = object() # tells Join to filter out rows that match the join
206

    
207
class Join(objects.BasicObject):
208
    def __init__(self, table, mapping, type_=None):
209
        '''
210
        @param mapping dict(right_table_col=left_table_col, ...)
211
            * if left_table_col is join_same: left_table_col = right_table_col
212
              * Note that right_table_col must be a string
213
            * if left_table_col is join_same_not_null:
214
              left_table_col = right_table_col and both have NOT NULL constraint
215
              * Note that right_table_col must be a string
216
        @param type_ None (for plain join)|str (e.g. 'LEFT')|filter_out
217
            * filter_out: equivalent to 'LEFT' with the query filtered by
218
              `table_pkey IS NULL` (indicating no match)
219
        '''
220
        if util.is_str(table): table = Table(table)
221
        assert type_ == None or util.is_str(type_) or type_ is filter_out
222
        
223
        self.table = table
224
        self.mapping = mapping
225
        self.type_ = type_
226
    
227
    def to_str(self, db, left_table):
228
        # Switch order (left_table is on the right in the comparison)
229
        right_table = left_table
230
        left_table = self.table # note left_table is reassigned
231
        
232
        def join(entry):
233
            '''Parses non-USING joins'''
234
            right_table_col, left_table_col = entry
235
            
236
            # Switch order (right_table_col is on the left in the comparison)
237
            left = right_table_col
238
            right = left_table_col
239
            
240
            # Parse special values
241
            if right is join_same: right = left
242
            elif right is join_same_not_null:
243
                right = CompareCond(as_Col(left, right_table), '~=')
244
            
245
            right = as_ValueCond(right, right_table)
246
            return '('+right.to_str(db, as_Col(left, left_table))+')'
247
        
248
        # Create join condition
249
        type_ = self.type_
250
        joins = self.mapping
251
        if type_ is not filter_out and reduce(operator.and_,
252
            (v is join_same_not_null for v in joins.itervalues())):
253
            # all cols w/ USING, so can use simpler USING syntax
254
            cols = (as_Col(v).to_str(db) for v in joins.iterkeys())
255
            join_cond = 'USING ('+(', '.join(cols))+')'
256
        else: join_cond = 'ON '+(' AND '.join(map(join, joins.iteritems())))
257
        
258
        # Create join
259
        if type_ is filter_out: type_ = 'LEFT'
260
        str_ = ''
261
        if type_ != None: str_ += type_+' '
262
        str_ += 'JOIN '+left_table.to_str(db)+' '+join_cond
263
        return str_
264
    
265
    def __str__(self): return self.to_str(mockDb, '<left_table>')
266

    
267
##### Value exprs
268

    
269
row_count = CustomCode('count(*)')
(24-24/35)