Project

General

Profile

1
# XML-database conversion
2

    
3
import copy
4
import re
5
from xml.dom import Node
6

    
7
import exc
8
import Parser
9
import sql
10
import sql_io
11
import sql_gen
12
import strings
13
import util
14
import xml_dom
15
import xml_func
16
import xpath
17

    
18
def name_of(node): return re.sub(r'^.*\.', r'', node.tagName)
19

    
20
ptr_suffix = '_id'
21

    
22
def is_ptr(node_name): return node_name.lower().endswith(ptr_suffix)
23

    
24
def ptr_type_guess(node_name):
25
    assert is_ptr(node_name)
26
    return node_name[:-len(ptr_suffix)]
27

    
28
def ptr_target(node):
29
    assert is_ptr(name_of(node))
30
    return xml_dom.value_node(node)
31

    
32
def find_by_name(node, name):
33
    for parent in xml_dom.NodeParentIter(node):
34
        if name_of(parent) == name: return parent
35
        else:
36
            for child in xml_dom.NodeElemIter(parent):
37
                child_name = name_of(child)
38
                if is_ptr(child_name):
39
                    target = ptr_target(child)
40
                    if target.tagName == name: return target
41
                elif child_name == name: return child
42
    return None
43

    
44
def get(db, node, limit=None, start=None):
45
    def pkey(table): return sql.pkey(db, table)
46
    
47
    node = node.firstChild
48
    table = name_of(node)
49
    pkey_ = pkey(table)
50
    
51
    fields = []
52
    conds = {}
53
    for child in xml_dom.NodeElemIter(node):
54
        child_name = name_of(child)
55
        if xml_dom.is_empty(child): fields.append(child_name)
56
        elif xml_dom.is_text(child): conds[child_name] = xml_dom.value(child)
57
        else: raise Exception('Joins not supported yet')
58
    id_ = xml_dom.get_id(node)
59
    if id_ != None: conds[pkey(table)] = id_ # replace any existing pkey value
60
    if fields == []: fields.append(pkey_)
61
    
62
    return sql.select(db, table, fields, conds, limit, start)
63

    
64
def put(db, node, row_ct_ref=None, on_error=exc.raise_, pool=None,
65
    store_ids=False, parent_id=None):
66
    '''store_ids enables searching the tree for missing fields'''
67
    def pkey(table): return sql.pkey(db, table, True)
68
    
69
    def put_(node, parent_id=None):
70
        args = (db, node, row_ct_ref, on_error, pool, store_ids, parent_id)
71
        if parent_id != None and pool != None: pool.apply_async(put, args)
72
        else: return put(*args)
73
    
74
    def on_error_(e):
75
        exc.add_msg(e, 'node:\n'+str(node))
76
        on_error(e)
77
    
78
    table = name_of(node)
79
    try: pkey_ = pkey(table)
80
    except sql.DatabaseErrors, e: on_error_(e); return None
81
    row = {}
82
    children = []
83
    
84
    # Divide children into fields and children with fkeys to parent
85
    for child in xml_dom.NodeElemIter(node):
86
        child_name = name_of(child)
87
        if xml_dom.is_empty(child): row[child_name] = None
88
        elif xml_dom.is_text(child):
89
            row[child_name] = strings.to_unicode(xml_dom.value(child))
90
        elif is_ptr(child_name): row[child_name] = put_(ptr_target(child))
91
        else: children.append(child)
92
    
93
    # Add fkey to parent
94
    if parent_id != None:
95
        parent_ptr = node.getAttribute('fkey')
96
        if parent_ptr == '': parent_ptr = pkey(name_of(node.parentNode))
97
        row[parent_ptr] = parent_id
98
    
99
    # Insert node
100
    try:
101
        for try_num in xrange(2):
102
            try:
103
                id_ = sql_io.put(db, table, row, pkey_, row_ct_ref)
104
                if store_ids: xml_dom.set_id(node, id_)
105
                break
106
            except sql.NullValueException, e:
107
                col = e.cols[0]
108
                if try_num > 0: raise # exception still raised after retry
109
                if store_ids and is_ptr(col):
110
                    # Search for required column in ancestors and their children
111
                    target = find_by_name(node, ptr_type_guess(col))
112
                    if target == None: raise
113
                    row[col] = xml_dom.get_id(target)
114
                else: raise
115
    except sql.DatabaseErrors, e: on_error_(e); return None
116
    
117
    # Insert children with fkeys to parent
118
    for child in children: put_(child, id_)
119
    
120
    return id_
121

    
122
class ColRef:
123
    '''A reference to a table column'''
124
    def __init__(self, name, idx):
125
        self.name = name
126
        self.idx = idx
127
    
128
    def __str__(self): return self.name
129

    
130
# Controls when and how put_table() will partition the input table
131
partition_size = 500000 # rows
132

    
133
input_col_prefix = '$'
134

    
135
put_table_special_funcs = set(['_simplifyPath'])
136

    
137
def put_table(db, node, in_table, in_row_ct_ref=None, row_ins_ct_ref=None,
138
    limit=None, start=0, on_error=exc.raise_, col_defaults={}):
139
    '''
140
    @param node The XML tree that transforms the input to the output. Similar to
141
        put()'s node param, but with the input column name prefixed by
142
        input_col_prefix in place of the column value.
143
    @return sql_gen.Col Where the pkeys (from INSERT RETURNING) are made
144
        available
145
    '''
146
    in_table = sql_gen.as_Table(in_table)
147
    in_table.set_srcs([in_table], overwrite=False)
148
    db.src = str(in_table)
149
    
150
    db.autoanalyze = True # but don't do this in row-based import
151
    db.autoexplain = True # but don't do this in row-based import
152
    
153
    full_in_table = in_table
154
    
155
    # Subset and partition in_table
156
    # OK to do even if table already the right size because it takes <1 sec.
157
    total = 0
158
    while limit == None or total < limit:
159
        # Adjust partition size if last partition
160
        this_limit = partition_size
161
        if limit != None: this_limit = min(this_limit, limit - total)
162
        
163
        # Row # is interally 0-based, but 1-based to the user
164
        db.log_debug('********** Partition: rows '+str(start+1)+'-'
165
            +str(start+this_limit)+' **********', level=1.2)
166
        
167
        # Subset in_table
168
        in_table = copy.copy(full_in_table) # don't modify input!
169
        in_table.name = str(in_table) # prepend schema
170
        cur = sql.run_query_into(db, sql.mk_select(db, full_in_table,
171
            limit=this_limit, start=start), into=in_table, add_pkey_=True)
172
            # full_in_table will be shadowed (hidden) by created temp table
173
        
174
        this_ct = cur.rowcount
175
        total += this_ct
176
        start += this_ct # advance start to fetch next set
177
        if this_ct == 0: break # in_table size is multiple of partition_size
178
        
179
        # Recurse
180
        pkeys_loc = _put_table_part(db, node, in_table, row_ins_ct_ref,
181
            on_error, col_defaults)
182
        if in_row_ct_ref != None: in_row_ct_ref[0] += this_ct
183
        
184
        sql.empty_temp(db, in_table)
185
        
186
        if this_ct < partition_size: break # partial partition = last
187
        
188
        # Work around PostgreSQL's temp table disk space leak
189
        db.reconnect()
190
    
191
    return pkeys_loc
192

    
193
def _put_table_part(db, node, in_table, row_ins_ct_ref, on_error, col_defaults,
194
    parent_ids_loc=None, next=None):
195
    '''Helper function for put_table() only; should not be called directly'''
196
    def put_table_(node, in_row_ct_ref=None):
197
        return _put_table_part(db, node, in_table, row_ins_ct_ref, on_error,
198
            col_defaults, parent_ids_loc, next)
199
    
200
    is_func = xml_func.is_func(node)
201
    out_table = name_of(node)
202
    
203
    # Divide children into fields and children with fkeys to parent
204
    row = {}
205
    children = []
206
    for child in xml_dom.NodeElemIter(node):
207
        child_name = name_of(child)
208
        if xml_dom.is_empty(child): row[child_name] = None
209
        elif xml_dom.is_text(child):
210
            row[child_name] = strings.to_unicode(xml_dom.value(child))
211
        else:
212
            child_value = xml_dom.value_node(child)
213
            if is_func or is_ptr(child_name) or xml_func.is_func(child_value):
214
                row[child_name] = child_value
215
            else: children.append(child)
216
    
217
    # Special handling for structural XML functions
218
    if out_table == '_simplifyPath':
219
        # Parse args
220
        def wrap_e(e): raise xml_func.SyntaxError(e)
221
        try:
222
            next = row['next'] # modifies outer next var used by put_table_()
223
            require = row['require']
224
            path = row['path']
225
        except KeyError, e: wrap_e(e)
226
        try: next = xpath.parse(next)
227
        except Parser.SyntaxError, e: wrap_e(e)
228
        try: next = next[0].name
229
        except IndexError, e: wrap_e(e)
230
        
231
        return put_table_(path)
232
    
233
    no_empty = set([in_table])
234
    
235
    def pkey(table): return sql.pkey(db, table, True)
236
    
237
    # Add fkey to parent
238
    if parent_ids_loc != None:
239
        if sql_gen.is_table_col(parent_ids_loc):
240
            no_empty.add(parent_ids_loc.table)
241
        parent_ptr = node.getAttribute('fkey')
242
        if parent_ptr == '': parent_ptr = pkey(name_of(node.parentNode))
243
        row[parent_ptr] = parent_ids_loc
244
    
245
    # Divide fields into input columns and literal values
246
    parent_ids_loc = None # applies to this section
247
    in_tables = [in_table]
248
    for out_col, value in row.iteritems():
249
        # Handle forward pointers
250
        if xml_dom.is_node(value): row[out_col] = value = put_table_(value)
251
        
252
        # Translate values
253
        if isinstance(value, sql_gen.Col): # value is temp table column
254
            in_tables.append(value.table)
255
        elif util.is_str(value) and value.startswith(input_col_prefix):
256
            # value is input column
257
            row[out_col] = sql_gen.Col(strings.remove_prefix(input_col_prefix,
258
                value), in_table)
259
        else: # value is literal value
260
            row[out_col] = sql_gen.NamedCol(out_col, value)
261
    
262
    # Insert node
263
    pkeys_loc = sql_io.put_table(db, out_table, in_tables, row, row_ins_ct_ref,
264
        None, next, col_defaults, on_error)
265
    
266
    sql.empty_temp(db, set(in_tables) - no_empty)
267
    
268
    # Insert children with fkeys to parent
269
    parent_ids_loc = pkeys_loc # applies to this section
270
    for child in children: put_table_(child)
271
    
272
    return pkeys_loc
(9-9/37)