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