Project

General

Profile

1 2211 aaronmk
# SQL code generation
2
3 2748 aaronmk
import copy
4 2276 aaronmk
import operator
5 3158 aaronmk
from ordereddict import OrderedDict
6 2568 aaronmk
import re
7 2653 aaronmk
import UserDict
8 2953 aaronmk
import warnings
9 2276 aaronmk
10 2667 aaronmk
import dicts
11 2953 aaronmk
import exc
12 2701 aaronmk
import iters
13
import lists
14 2360 aaronmk
import objects
15 2222 aaronmk
import strings
16 2227 aaronmk
import util
17 2211 aaronmk
18 2587 aaronmk
##### Names
19 2499 aaronmk
20 2608 aaronmk
identifier_max_len = 63 # works for both PostgreSQL and MySQL
21 2587 aaronmk
22 2932 aaronmk
def concat(str_, suffix):
23 2609 aaronmk
    '''Preserves version so that it won't be truncated off the string, leading
24
    to collisions.'''
25 2613 aaronmk
    # Preserve version
26 2995 aaronmk
    match = re.match(r'^(.*?)((?:(?:#\d+)?\)?)*(?:\.\w+)?(?:::[\w ]+)*)$', str_)
27 2985 aaronmk
    if match:
28
        str_, old_suffix = match.groups()
29
        suffix = old_suffix+suffix
30 2613 aaronmk
31 2932 aaronmk
    return strings.concat(str_, suffix, identifier_max_len)
32 2587 aaronmk
33 2932 aaronmk
def truncate(str_): return concat(str_, '')
34 2842 aaronmk
35 2575 aaronmk
def is_safe_name(name):
36 2583 aaronmk
    '''A name is safe *and unambiguous* if it:
37
    * contains only *lowercase* word (\w) characters
38
    * doesn't start with a digit
39
    * contains "_", so that it's not a keyword
40 2984 aaronmk
    '''
41
    return re.match(r'^(?=.*_)(?!\d)[^\WA-Z]+$', name)
42 2568 aaronmk
43 2499 aaronmk
def esc_name(name, quote='"'):
44
    return quote + name.replace(quote, quote+quote) + quote
45
        # doubling an embedded quote escapes it in both PostgreSQL and MySQL
46
47 3320 aaronmk
def unesc_name(name, quote='"'):
48
    removed_ref = [False]
49
    name = strings.remove_prefix(quote, name, removed_ref)
50
    if removed_ref[0]:
51
        name = strings.remove_suffix(quote, name, removed_ref)
52
        assert removed_ref[0]
53
        name = name.replace(quote+quote, quote)
54
    return name
55
56 2513 aaronmk
def clean_name(name): return name.replace('"', '').replace('`', '')
57
58 3041 aaronmk
def esc_comment(comment): return '/*'+comment.replace('*/', '* /')+'*/'
59
60 3182 aaronmk
def lstrip(str_):
61
    '''Also removes comments.'''
62
    if str_.startswith('/*'): comment, sep, str_ = str_.partition('*/')
63
    return str_.lstrip()
64
65 2659 aaronmk
##### General SQL code objects
66 2219 aaronmk
67 2349 aaronmk
class MockDb:
68 2503 aaronmk
    def esc_value(self, value): return strings.repr_no_u(value)
69 2349 aaronmk
70 2499 aaronmk
    def esc_name(self, name): return esc_name(name)
71 2859 aaronmk
72
    def col_info(self, col):
73
        return TypedCol(col.name, '<type>', CustomCode('<default>'), True)
74
75 2349 aaronmk
mockDb = MockDb()
76
77 2514 aaronmk
class BasicObject(objects.BasicObject):
78
    def __init__(self, value): self.value = value
79
80
    def __str__(self): return clean_name(strings.repr_no_u(self))
81
82 2659 aaronmk
##### Unparameterized code objects
83
84 2514 aaronmk
class Code(BasicObject):
85 2658 aaronmk
    def to_str(self, db): raise NotImplementedError()
86 2349 aaronmk
87 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb)
88 2211 aaronmk
89 2269 aaronmk
class CustomCode(Code):
90 2256 aaronmk
    def __init__(self, str_): self.str_ = str_
91
92
    def to_str(self, db): return self.str_
93
94 2815 aaronmk
def as_Code(value, db=None):
95
    '''
96
    @param db If set, runs db.std_code() on the value.
97
    '''
98
    if util.is_str(value):
99
        if db != None: value = db.std_code(value)
100
        return CustomCode(value)
101 2659 aaronmk
    else: return Literal(value)
102
103 2540 aaronmk
class Expr(Code):
104
    def __init__(self, expr): self.expr = expr
105
106
    def to_str(self, db): return '('+self.expr.to_str(db)+')'
107
108 3086 aaronmk
##### Names
109
110
class Name(Code):
111 3087 aaronmk
    def __init__(self, name):
112
        name = truncate(name)
113
114
        self.name = name
115 3086 aaronmk
116
    def to_str(self, db): return db.esc_name(self.name)
117
118
def as_Name(value):
119
    if isinstance(value, Code): return value
120
    else: return Name(value)
121
122 2335 aaronmk
##### Literal values
123
124 2216 aaronmk
class Literal(Code):
125 2211 aaronmk
    def __init__(self, value): self.value = value
126 2213 aaronmk
127
    def to_str(self, db): return db.esc_value(self.value)
128 2211 aaronmk
129 2400 aaronmk
def as_Value(value):
130
    if isinstance(value, Code): return value
131
    else: return Literal(value)
132
133 3429 aaronmk
def is_literal(value): return isinstance(value, Literal)
134 2216 aaronmk
135 3429 aaronmk
def is_null(value): return is_literal(value) and value.value == None
136
137 2711 aaronmk
##### Derived elements
138
139
src_self = object() # tells Col that it is its own source column
140
141
class Derived(Code):
142
    def __init__(self, srcs):
143 2712 aaronmk
        '''An element which was derived from some other element(s).
144 2711 aaronmk
        @param srcs See self.set_srcs()
145
        '''
146
        self.set_srcs(srcs)
147
148 2713 aaronmk
    def set_srcs(self, srcs, overwrite=True):
149 2711 aaronmk
        '''
150
        @param srcs (self_type...)|src_self The element(s) this is derived from
151
        '''
152 2713 aaronmk
        if not overwrite and self.srcs != (): return # already set
153
154 2711 aaronmk
        if srcs == src_self: srcs = (self,)
155
        srcs = tuple(srcs) # make Col hashable
156
        self.srcs = srcs
157
158
    def _compare_on(self):
159
        compare_on = self.__dict__.copy()
160
        del compare_on['srcs'] # ignore
161
        return compare_on
162
163
def cols_srcs(cols): return lists.uniqify(iters.flatten((v.srcs for v in cols)))
164
165 2335 aaronmk
##### Tables
166
167 2712 aaronmk
class Table(Derived):
168 2991 aaronmk
    def __init__(self, name, schema=None, srcs=(), is_temp=False):
169 2211 aaronmk
        '''
170
        @param schema str|None (for no schema)
171 2712 aaronmk
        @param srcs (Table...)|src_self See Derived.set_srcs()
172 2211 aaronmk
        '''
173 2712 aaronmk
        Derived.__init__(self, srcs)
174
175 3091 aaronmk
        if util.is_str(name): name = truncate(name)
176 2843 aaronmk
177 2211 aaronmk
        self.name = name
178
        self.schema = schema
179 2991 aaronmk
        self.is_temp = is_temp
180 3000 aaronmk
        self.index_cols = {}
181 2211 aaronmk
182 2348 aaronmk
    def to_str(self, db):
183
        str_ = ''
184 3088 aaronmk
        if self.schema != None: str_ += as_Name(self.schema).to_str(db)+'.'
185
        str_ += as_Name(self.name).to_str(db)
186 2348 aaronmk
        return str_
187 2336 aaronmk
188
    def to_Table(self): return self
189 3000 aaronmk
190
    def _compare_on(self):
191
        compare_on = Derived._compare_on(self)
192
        del compare_on['index_cols'] # ignore
193
        return compare_on
194 2211 aaronmk
195 2835 aaronmk
def is_underlying_table(table):
196
    return isinstance(table, Table) and table.to_Table() is table
197 2832 aaronmk
198 2902 aaronmk
class NoUnderlyingTableException(Exception): pass
199
200
def underlying_table(table):
201
    table = remove_table_rename(table)
202
    if not is_underlying_table(table): raise NoUnderlyingTableException
203
    return table
204
205 2776 aaronmk
def as_Table(table, schema=None):
206 2270 aaronmk
    if table == None or isinstance(table, Code): return table
207 2776 aaronmk
    else: return Table(table, schema)
208 2219 aaronmk
209 3101 aaronmk
def suffixed_table(table, suffix):
210 3128 aaronmk
    table = copy.copy(table) # don't modify input!
211
    table.name = concat(table.name, suffix)
212
    return table
213 2707 aaronmk
214 2336 aaronmk
class NamedTable(Table):
215
    def __init__(self, name, code, cols=None):
216
        Table.__init__(self, name)
217
218 3016 aaronmk
        code = as_Table(code)
219 2741 aaronmk
        if not isinstance(code, (Table, FunctionCall, Expr)): code = Expr(code)
220 3020 aaronmk
        if cols != None: cols = [to_name_only_col(c).to_Col() for c in cols]
221 2336 aaronmk
222
        self.code = code
223
        self.cols = cols
224
225
    def to_str(self, db):
226 3026 aaronmk
        str_ = self.code.to_str(db)
227
        if str_.find('\n') >= 0: whitespace = '\n'
228
        else: whitespace = ' '
229
        str_ += whitespace+'AS '+Table.to_str(self, db)
230 2742 aaronmk
        if self.cols != None:
231
            str_ += ' ('+(', '.join((c.to_str(db) for c in self.cols)))+')'
232 2336 aaronmk
        return str_
233
234
    def to_Table(self): return Table(self.name)
235
236 2753 aaronmk
def remove_table_rename(table):
237
    if isinstance(table, NamedTable): table = table.code
238
    return table
239
240 2335 aaronmk
##### Columns
241
242 2711 aaronmk
class Col(Derived):
243 2701 aaronmk
    def __init__(self, name, table=None, srcs=()):
244 2211 aaronmk
        '''
245
        @param table Table|None (for no table)
246 2711 aaronmk
        @param srcs (Col...)|src_self See Derived.set_srcs()
247 2211 aaronmk
        '''
248 2711 aaronmk
        Derived.__init__(self, srcs)
249
250 3091 aaronmk
        if util.is_str(name): name = truncate(name)
251 2241 aaronmk
        if util.is_str(table): table = Table(table)
252 2211 aaronmk
        assert table == None or isinstance(table, Table)
253
254
        self.name = name
255
        self.table = table
256
257 2989 aaronmk
    def to_str(self, db, for_str=False):
258 3088 aaronmk
        str_ = as_Name(self.name).to_str(db)
259 2989 aaronmk
        if for_str: str_ = clean_name(str_)
260 2933 aaronmk
        if self.table != None:
261 2989 aaronmk
            table = self.table.to_Table()
262
            if for_str: str_ = concat(str(table), '.'+str_)
263
            else: str_ = table.to_str(db)+'.'+str_
264 2211 aaronmk
        return str_
265 2314 aaronmk
266 2989 aaronmk
    def __str__(self): return self.to_str(mockDb, for_str=True)
267 2933 aaronmk
268 2314 aaronmk
    def to_Col(self): return self
269 2211 aaronmk
270 2767 aaronmk
def is_table_col(col): return isinstance(col, Col) and col.table != None
271 2393 aaronmk
272 3000 aaronmk
def index_col(col):
273
    if not is_table_col(col): return None
274 3104 aaronmk
275
    table = col.table
276
    try: name = table.index_cols[col.name]
277
    except KeyError: return None
278
    else: return Col(name, table, col.srcs)
279 2999 aaronmk
280 3024 aaronmk
def is_temp_col(col): return is_table_col(col) and col.table.is_temp
281 2996 aaronmk
282 2563 aaronmk
def as_Col(col, table=None, name=None):
283
    '''
284
    @param name If not None, any non-Col input will be renamed using NamedCol.
285
    '''
286
    if name != None:
287
        col = as_Value(col)
288
        if not isinstance(col, Col): col = NamedCol(name, col)
289 2333 aaronmk
290
    if isinstance(col, Code): return col
291 2260 aaronmk
    else: return Col(col, table)
292
293 3093 aaronmk
def with_table(col, table):
294 3105 aaronmk
    if isinstance(col, NamedCol): pass # doesn't take a table
295
    elif isinstance(col, FunctionCall):
296
        col = copy.deepcopy(col) # don't modify input!
297
        col.args[0].table = table
298
    else:
299 3098 aaronmk
        col = copy.copy(col) # don't modify input!
300
        col.table = table
301 3093 aaronmk
    return col
302
303 3100 aaronmk
def with_default_table(col, table):
304 2747 aaronmk
    col = as_Col(col)
305 3100 aaronmk
    if col.table == None: col = with_table(col, table)
306 2747 aaronmk
    return col
307
308 2744 aaronmk
def set_cols_table(table, cols):
309
    table = as_Table(table)
310
311
    for i, col in enumerate(cols):
312
        col = cols[i] = as_Col(col)
313
        col.table = table
314
315 2401 aaronmk
def to_name_only_col(col, check_table=None):
316
    col = as_Col(col)
317 3020 aaronmk
    if not is_table_col(col): return col
318 2401 aaronmk
319
    if check_table != None:
320
        table = col.table
321
        assert table == None or table == check_table
322
    return Col(col.name)
323
324 2993 aaronmk
def suffixed_col(col, suffix):
325
    return Col(concat(col.name, suffix), col.table, col.srcs)
326
327 2323 aaronmk
class NamedCol(Col):
328 2229 aaronmk
    def __init__(self, name, code):
329 2310 aaronmk
        Col.__init__(self, name)
330
331 3016 aaronmk
        code = as_Value(code)
332 2229 aaronmk
333
        self.code = code
334
335
    def to_str(self, db):
336 2310 aaronmk
        return self.code.to_str(db)+' AS '+Col.to_str(self, db)
337 2314 aaronmk
338
    def to_Col(self): return Col(self.name)
339 2229 aaronmk
340 2462 aaronmk
def remove_col_rename(col):
341
    if isinstance(col, NamedCol): col = col.code
342
    return col
343
344 2830 aaronmk
def underlying_col(col):
345
    col = remove_col_rename(col)
346 2849 aaronmk
    if not isinstance(col, Col): raise NoUnderlyingTableException
347
348 2902 aaronmk
    return Col(col.name, underlying_table(col.table), col.srcs)
349 2830 aaronmk
350 2703 aaronmk
def wrap(wrap_func, value):
351
    '''Wraps a value, propagating any column renaming to the returned value.'''
352
    if isinstance(value, NamedCol):
353
        return NamedCol(value.name, wrap_func(value.code))
354
    else: return wrap_func(value)
355
356 2667 aaronmk
class ColDict(dicts.DictProxy):
357 2564 aaronmk
    '''A dict that automatically makes inserted entries Col objects'''
358
359 2645 aaronmk
    def __init__(self, db, keys_table, dict_={}):
360 3158 aaronmk
        dicts.DictProxy.__init__(self, OrderedDict())
361 2667 aaronmk
362 2645 aaronmk
        keys_table = as_Table(keys_table)
363
364 2642 aaronmk
        self.db = db
365 2641 aaronmk
        self.table = keys_table
366 2653 aaronmk
        self.update(dict_) # after setting vars because __setitem__() needs them
367 2641 aaronmk
368 2667 aaronmk
    def copy(self): return ColDict(self.db, self.table, self.inner.copy())
369 2655 aaronmk
370 2667 aaronmk
    def __getitem__(self, key):
371
        return dicts.DictProxy.__getitem__(self, self._key(key))
372 2653 aaronmk
373 2564 aaronmk
    def __setitem__(self, key, value):
374 2642 aaronmk
        key = self._key(key)
375 2819 aaronmk
        if value == None: value = self.db.col_info(key).default
376 2667 aaronmk
        dicts.DictProxy.__setitem__(self, key, as_Col(value, name=key.name))
377 2564 aaronmk
378 2641 aaronmk
    def _key(self, key): return as_Col(key, self.table)
379 2564 aaronmk
380 2524 aaronmk
##### Functions
381
382 2912 aaronmk
Function = Table
383 2911 aaronmk
as_Function = as_Table
384
385 2691 aaronmk
class InternalFunction(CustomCode): pass
386
387 2941 aaronmk
class NamedArg(NamedCol):
388
    def __init__(self, name, value):
389
        NamedCol.__init__(self, name, value)
390
391
    def to_str(self, db):
392
        return Col.to_str(self, db)+' := '+self.code.to_str(db)
393
394 2524 aaronmk
class FunctionCall(Code):
395 2941 aaronmk
    def __init__(self, function, *args, **kw_args):
396 2524 aaronmk
        '''
397 2690 aaronmk
        @param args [Code|literal-value...] The function's arguments
398 2524 aaronmk
        '''
399 3016 aaronmk
        function = as_Function(function)
400 2941 aaronmk
        def filter_(arg): return remove_col_rename(as_Value(arg))
401
        args = map(filter_, args)
402
        args += [NamedArg(k, filter_(v)) for k, v in kw_args.iteritems()]
403 2524 aaronmk
404
        self.function = function
405
        self.args = args
406
407
    def to_str(self, db):
408
        args_str = ', '.join((v.to_str(db) for v in self.args))
409
        return self.function.to_str(db)+'('+args_str+')'
410
411 2533 aaronmk
def wrap_in_func(function, value):
412
    '''Wraps a value inside a function call.
413
    Propagates any column renaming to the returned value.
414
    '''
415 2703 aaronmk
    return wrap(lambda v: FunctionCall(function, v), value)
416 2533 aaronmk
417 2561 aaronmk
def unwrap_func_call(func_call, check_name=None):
418
    '''Unwraps any function call to its first argument.
419
    Also removes any column renaming.
420
    '''
421
    func_call = remove_col_rename(func_call)
422
    if not isinstance(func_call, FunctionCall): return func_call
423
424
    if check_name != None:
425
        name = func_call.function.name
426
        assert name == None or name == check_name
427
    return func_call.args[0]
428
429 2986 aaronmk
##### Casts
430
431
class Cast(FunctionCall):
432
    def __init__(self, type_, value):
433
        value = as_Value(value)
434
435
        self.type_ = type_
436
        self.value = value
437
438
    def to_str(self, db):
439
        return 'CAST('+self.value.to_str(db)+' AS '+self.type_+')'
440
441 3354 aaronmk
def cast_literal(value):
442 3429 aaronmk
    if not is_literal(value): return value
443 3354 aaronmk
444
    if util.is_str(value.value): value = Cast('text', value)
445
    return value
446
447 2335 aaronmk
##### Conditions
448 2259 aaronmk
449 3350 aaronmk
class NotCond(Code):
450
    def __init__(self, cond):
451
        self.cond = cond
452
453
    def to_str(self, db): return 'NOT '+self.cond.to_str(db)
454
455 2398 aaronmk
class ColValueCond(Code):
456
    def __init__(self, col, value):
457
        value = as_ValueCond(value)
458
459
        self.col = col
460
        self.value = value
461
462
    def to_str(self, db): return self.value.to_str(db, self.col)
463
464 2577 aaronmk
def combine_conds(conds, keyword=None):
465
    '''
466
    @param keyword The keyword to add before the conditions, if any
467
    '''
468
    str_ = ''
469
    if keyword != None:
470
        if conds == []: whitespace = ''
471
        elif len(conds) == 1: whitespace = ' '
472
        else: whitespace = '\n'
473
        str_ += keyword+whitespace
474
475
    str_ += '\nAND '.join(conds)
476
    return str_
477
478 2398 aaronmk
##### Condition column comparisons
479
480 2514 aaronmk
class ValueCond(BasicObject):
481 2213 aaronmk
    def __init__(self, value):
482 2858 aaronmk
        value = remove_col_rename(as_Value(value))
483 2213 aaronmk
484
        self.value = value
485 2214 aaronmk
486 2216 aaronmk
    def to_str(self, db, left_value):
487 2214 aaronmk
        '''
488 2216 aaronmk
        @param left_value The Code object that the condition is being applied on
489 2214 aaronmk
        '''
490
        raise NotImplemented()
491 2228 aaronmk
492 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb, '<left_value>')
493 2211 aaronmk
494
class CompareCond(ValueCond):
495
    def __init__(self, value, operator='='):
496 2222 aaronmk
        '''
497
        @param operator By default, compares NULL values literally. Use '~=' or
498
            '~!=' to pass NULLs through.
499
        '''
500 2211 aaronmk
        ValueCond.__init__(self, value)
501
        self.operator = operator
502
503 2216 aaronmk
    def to_str(self, db, left_value):
504 2858 aaronmk
        left_value = remove_col_rename(as_Col(left_value))
505 2216 aaronmk
506 2222 aaronmk
        right_value = self.value
507
508
        # Parse operator
509 2216 aaronmk
        operator = self.operator
510 2222 aaronmk
        passthru_null_ref = [False]
511
        operator = strings.remove_prefix('~', operator, passthru_null_ref)
512
        neg_ref = [False]
513
        operator = strings.remove_prefix('!', operator, neg_ref)
514 2844 aaronmk
        equals = operator.endswith('=') # also includes <=, >=
515 2222 aaronmk
516 2825 aaronmk
        # Handle nullable columns
517
        check_null = False
518 2844 aaronmk
        if not passthru_null_ref[0]: # NULLs compare equal
519 2857 aaronmk
            try: left_value = ensure_not_null(db, left_value)
520 2844 aaronmk
            except ensure_not_null_excs: # fall back to alternate method
521
                check_null = equals and isinstance(right_value, Col)
522 2837 aaronmk
            else:
523 2857 aaronmk
                if isinstance(left_value, EnsureNotNull):
524
                    right_value = ensure_not_null(db, right_value,
525
                        left_value.type) # apply same function to both sides
526 2825 aaronmk
527 2844 aaronmk
        if equals and is_null(right_value): operator = 'IS'
528
529 2825 aaronmk
        left = left_value.to_str(db)
530
        right = right_value.to_str(db)
531
532 2222 aaronmk
        # Create str
533
        str_ = left+' '+operator+' '+right
534 2825 aaronmk
        if check_null:
535 2578 aaronmk
            str_ = '('+str_+' OR ('+left+' IS NULL AND '+right+' IS NULL))'
536
        if neg_ref[0]: str_ = 'NOT '+str_
537 2222 aaronmk
        return str_
538 2216 aaronmk
539 2260 aaronmk
# Tells as_ValueCond() to assume a non-ValueCond is a literal value
540
assume_literal = object()
541
542
def as_ValueCond(value, default_table=assume_literal):
543
    if not isinstance(value, ValueCond):
544
        if default_table is not assume_literal:
545 2748 aaronmk
            value = with_default_table(value, default_table)
546 2260 aaronmk
        return CompareCond(value)
547 2216 aaronmk
    else: return value
548 2219 aaronmk
549 2335 aaronmk
##### Joins
550
551 2352 aaronmk
join_same = object() # tells Join the left and right columns have the same name
552 2260 aaronmk
553 2353 aaronmk
# Tells Join the left and right columns have the same name and are never NULL
554
join_same_not_null = object()
555
556 2260 aaronmk
filter_out = object() # tells Join to filter out rows that match the join
557
558 2514 aaronmk
class Join(BasicObject):
559 2746 aaronmk
    def __init__(self, table, mapping={}, type_=None):
560 2260 aaronmk
        '''
561
        @param mapping dict(right_table_col=left_table_col, ...)
562 2352 aaronmk
            * if left_table_col is join_same: left_table_col = right_table_col
563 2353 aaronmk
              * Note that right_table_col must be a string
564
            * if left_table_col is join_same_not_null:
565
              left_table_col = right_table_col and both have NOT NULL constraint
566
              * Note that right_table_col must be a string
567 2260 aaronmk
        @param type_ None (for plain join)|str (e.g. 'LEFT')|filter_out
568
            * filter_out: equivalent to 'LEFT' with the query filtered by
569
              `table_pkey IS NULL` (indicating no match)
570
        '''
571
        if util.is_str(table): table = Table(table)
572
        assert type_ == None or util.is_str(type_) or type_ is filter_out
573
574
        self.table = table
575
        self.mapping = mapping
576
        self.type_ = type_
577
578 2749 aaronmk
    def to_str(self, db, left_table_):
579 2260 aaronmk
        def join(entry):
580
            '''Parses non-USING joins'''
581
            right_table_col, left_table_col = entry
582
583 2353 aaronmk
            # Switch order (right_table_col is on the left in the comparison)
584
            left = right_table_col
585
            right = left_table_col
586 2749 aaronmk
            left_table = self.table
587
            right_table = left_table_
588 2353 aaronmk
589 2747 aaronmk
            # Parse left side
590 2748 aaronmk
            left = with_default_table(left, left_table)
591 2747 aaronmk
592 2260 aaronmk
            # Parse special values
593 2747 aaronmk
            left_on_right = Col(left.name, right_table)
594
            if right is join_same: right = left_on_right
595 2353 aaronmk
            elif right is join_same_not_null:
596 2747 aaronmk
                right = CompareCond(left_on_right, '~=')
597 2260 aaronmk
598 2747 aaronmk
            # Parse right side
599 2353 aaronmk
            right = as_ValueCond(right, right_table)
600 2747 aaronmk
601
            return right.to_str(db, left)
602 2260 aaronmk
603 2265 aaronmk
        # Create join condition
604
        type_ = self.type_
605 2276 aaronmk
        joins = self.mapping
606 2746 aaronmk
        if joins == {}: join_cond = None
607
        elif type_ is not filter_out and reduce(operator.and_,
608 2460 aaronmk
            (v is join_same_not_null for v in joins.itervalues())):
609 2260 aaronmk
            # all cols w/ USING, so can use simpler USING syntax
610 2747 aaronmk
            cols = map(to_name_only_col, joins.iterkeys())
611
            join_cond = 'USING ('+(', '.join((c.to_str(db) for c in cols)))+')'
612 2757 aaronmk
        else: join_cond = combine_conds(map(join, joins.iteritems()), 'ON')
613 2260 aaronmk
614 2757 aaronmk
        if isinstance(self.table, NamedTable): whitespace = '\n'
615
        else: whitespace = ' '
616
617 2260 aaronmk
        # Create join
618
        if type_ is filter_out: type_ = 'LEFT'
619 2266 aaronmk
        str_ = ''
620
        if type_ != None: str_ += type_+' '
621 2757 aaronmk
        str_ += 'JOIN'+whitespace+self.table.to_str(db)
622
        if join_cond != None: str_ += whitespace+join_cond
623 2266 aaronmk
        return str_
624 2349 aaronmk
625 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb, '<left_table>')
626 2424 aaronmk
627
##### Value exprs
628
629 3089 aaronmk
all_cols = CustomCode('*')
630
631 2737 aaronmk
default = CustomCode('DEFAULT')
632
633 3090 aaronmk
row_count = FunctionCall(InternalFunction('COUNT'), all_cols)
634 2674 aaronmk
635 3061 aaronmk
class Coalesce(FunctionCall):
636
    def __init__(self, *args):
637
        FunctionCall.__init__(self, InternalFunction('COALESCE'), *args)
638 3060 aaronmk
639 3062 aaronmk
class Nullif(FunctionCall):
640
    def __init__(self, *args):
641
        FunctionCall.__init__(self, InternalFunction('NULLIF'), *args)
642
643 2850 aaronmk
# See <http://www.postgresql.org/docs/8.3/static/datatype-numeric.html>
644 2958 aaronmk
null_sentinels = {
645
    'character varying': r'\N',
646
    'double precision': 'NaN',
647
    'integer': 2147483647,
648
    'text': r'\N',
649
    'timestamp with time zone': 'infinity'
650
}
651 2692 aaronmk
652 3061 aaronmk
class EnsureNotNull(Coalesce):
653 2850 aaronmk
    def __init__(self, value, type_):
654 3061 aaronmk
        Coalesce.__init__(self, as_Col(value),
655 2988 aaronmk
            Cast(type_, null_sentinels[type_]))
656 2850 aaronmk
657
        self.type = type_
658 3001 aaronmk
659
    def to_str(self, db):
660
        col = self.args[0]
661
        index_col_ = index_col(col)
662
        if index_col_ != None: return index_col_.to_str(db)
663 3061 aaronmk
        return Coalesce.to_str(self, db)
664 2850 aaronmk
665 2737 aaronmk
##### Table exprs
666
667
class Values(Code):
668
    def __init__(self, values):
669 2739 aaronmk
        '''
670
        @param values [...]|[[...], ...] Can be one or multiple rows.
671
        '''
672
        rows = values
673
        if len(values) >= 1 and not lists.is_seq(values[0]): # only one row
674
            rows = [values]
675
        for i, row in enumerate(rows):
676
            rows[i] = map(remove_col_rename, map(as_Value, row))
677 2737 aaronmk
678 2739 aaronmk
        self.rows = rows
679 2737 aaronmk
680
    def to_str(self, db):
681 2739 aaronmk
        def row_str(row):
682
            return '('+(', '.join((v.to_str(db) for v in row)))+')'
683
        return 'VALUES '+(', '.join(map(row_str, self.rows)))
684 2737 aaronmk
685 2740 aaronmk
def NamedValues(name, cols, values):
686 2745 aaronmk
    '''
687 3048 aaronmk
    @param cols None|[...]
688 2745 aaronmk
    @post `cols` will be changed to Col objects with the table set to `name`.
689
    '''
690 2834 aaronmk
    table = NamedTable(name, Values(values), cols)
691 3048 aaronmk
    if cols != None: set_cols_table(table, cols)
692 2834 aaronmk
    return table
693 2740 aaronmk
694 2674 aaronmk
##### Database structure
695
696
class TypedCol(Col):
697 2871 aaronmk
    def __init__(self, name, type_, default=None, nullable=True,
698
        constraints=None):
699 2818 aaronmk
        assert default == None or isinstance(default, Code)
700
701 2674 aaronmk
        Col.__init__(self, name)
702
703
        self.type = type_
704 2818 aaronmk
        self.default = default
705
        self.nullable = nullable
706 2871 aaronmk
        self.constraints = constraints
707 2674 aaronmk
708 2818 aaronmk
    def to_str(self, db):
709
        str_ = Col.to_str(self, db)+' '+self.type
710
        if not self.nullable: str_ += ' NOT NULL'
711
        if self.default != None: str_ += ' DEFAULT '+self.default.to_str(db)
712 2871 aaronmk
        if self.constraints != None: str_ += ' '+self.constraints
713 2818 aaronmk
        return str_
714 2674 aaronmk
715
    def to_Col(self): return Col(self.name)
716 2822 aaronmk
717 2840 aaronmk
ensure_not_null_excs = (NoUnderlyingTableException, KeyError)
718
719 2851 aaronmk
def ensure_not_null(db, col, type_=None):
720 2840 aaronmk
    '''
721 2855 aaronmk
    @param col If type_ is not set, must have an underlying column.
722 2851 aaronmk
    @param type_ If set, overrides the underlying column's type.
723 2840 aaronmk
    @return EnsureNotNull|Col
724
    @throws ensure_not_null_excs
725
    '''
726 2855 aaronmk
    nullable = True
727
    try: typed_col = db.col_info(underlying_col(col))
728
    except NoUnderlyingTableException:
729 3355 aaronmk
        col = remove_col_rename(col)
730 3429 aaronmk
        if is_literal(col) and not is_null(col): nullable = False
731 3355 aaronmk
        elif type_ == None: raise
732 2855 aaronmk
    else:
733
        if type_ == None: type_ = typed_col.type
734
        nullable = typed_col.nullable
735
736 2953 aaronmk
    if nullable:
737
        try: col = EnsureNotNull(col, type_)
738
        except KeyError, e:
739
            # Warn of no null sentinel for type, even if caller catches error
740
            warnings.warn(UserWarning(exc.str_(e)))
741
            raise
742
743 2840 aaronmk
    return col