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
class ColRef:
45
    '''A reference to a table column'''
46
    def __init__(self, name, idx):
47
        self.name = name
48
        self.idx = idx
49
    
50
    def __str__(self): return self.name
51

    
52
put_special_funcs = set(['_simplifyPath'])
53

    
54
def put(db, node, row_ins_ct_ref=None, on_error=exc.reraise,
55
    col_defaults={}, in_table=None, parent_ids_loc=None, next=None):
56
    '''
57
    @param node To use an entire XML document, pass root.firstChild.
58
    '''
59
    if node == None: return None # when no rows, root.firstChild == None
60
    
61
    def put_(node):
62
        return put(db, node, row_ins_ct_ref, on_error, col_defaults, in_table,
63
            parent_ids_loc, next)
64
    
65
    def augment_error(e): exc.add_msg(e, 'node:\n'+str(node))
66
    def on_error_(e):
67
        augment_error(e)
68
        on_error(e)
69
    
70
    is_func = xml_func.is_func(node)
71
    out_table = name_of(node)
72
    
73
    # Divide children into fields and children with fkeys to parent
74
    row = {}
75
    children = []
76
    for child in xml_dom.NodeElemIter(node):
77
        child_name = name_of(child)
78
        if xml_dom.is_empty(child): row[child_name] = None
79
        elif xml_dom.is_text(child):
80
            row[child_name] = strings.to_unicode(xml_dom.value(child))
81
        else:
82
            child_value = xml_dom.value_node(child)
83
            if is_func or is_ptr(child_name) or xml_func.is_func(child_value):
84
                row[child_name] = child_value
85
            else: children.append(child)
86
    
87
    # Special handling for structural XML functions
88
    if out_table == '_simplifyPath':
89
        # Parse args
90
        def wrap_e(e): raise xml_func.SyntaxError(e)
91
        try:
92
            next = row['next'] # modifies outer next var used by put_()
93
            require = row['require']
94
            path = row['path']
95
        except KeyError, e: wrap_e(e)
96
        try: next = xpath.parse(next)
97
        except Parser.SyntaxError, e: wrap_e(e)
98
        try: next = next[0].name
99
        except IndexError, e: wrap_e(e)
100
        
101
        return put_(path)
102
    
103
    is_literals = in_table == None
104
    in_tables = []
105
    no_empty = set()
106
    if not is_literals:
107
        in_tables.append(in_table)
108
        no_empty.add(in_table)
109
    
110
    def pkey(table): return sql.pkey(db, table, True)
111
    
112
    # Add fkey to parent
113
    if parent_ids_loc != None:
114
        if sql_gen.is_table_col(parent_ids_loc):
115
            no_empty.add(parent_ids_loc.table)
116
        parent_ptr = node.getAttribute('fkey')
117
        if parent_ptr == '': parent_ptr = pkey(name_of(node.parentNode))
118
        row[parent_ptr] = parent_ids_loc
119
    
120
    # Divide fields into input columns and literal values
121
    parent_ids_loc = None # applies to this section
122
    for out_col, value in row.iteritems():
123
        # Handle forward pointers
124
        if xml_dom.is_node(value): row[out_col] = value = put_(value)
125
        
126
        # Translate values
127
        if isinstance(value, sql_gen.Col): # value is temp table column
128
            assert sql_gen.is_table_col(value)
129
            in_tables.append(value.table)
130
        elif (not is_literals and util.is_str(value)
131
            and value.startswith(input_col_prefix)): # value is input column
132
            row[out_col] = sql_gen.Col(strings.remove_prefix(input_col_prefix,
133
                value), in_table)
134
        else: # value is literal value
135
            row[out_col] = sql_gen.NamedCol(out_col, value)
136
    
137
    # Insert node
138
    try: pkeys_loc = sql_io.put_table(db, out_table, in_tables, row,
139
        row_ins_ct_ref, next, col_defaults, on_error_)
140
    except Exception, e:
141
        augment_error(e)
142
        raise
143
    
144
    sql.empty_temp(db, set(in_tables) - no_empty)
145
    
146
    # Insert children with fkeys to parent
147
    parent_ids_loc = pkeys_loc # applies to this section
148
    for child in children: put_(child)
149
    
150
    return pkeys_loc
151

    
152
def get(db, node, limit=None, start=None):
153
    def pkey(table): return sql.pkey(db, table)
154
    
155
    node = node.firstChild
156
    table = name_of(node)
157
    pkey_ = pkey(table)
158
    
159
    fields = []
160
    conds = {}
161
    for child in xml_dom.NodeElemIter(node):
162
        child_name = name_of(child)
163
        if xml_dom.is_empty(child): fields.append(child_name)
164
        elif xml_dom.is_text(child): conds[child_name] = xml_dom.value(child)
165
        else: raise Exception('Joins not supported yet')
166
    id_ = xml_dom.get_id(node)
167
    if id_ != None: conds[pkey(table)] = id_ # replace any existing pkey value
168
    if fields == []: fields.append(pkey_)
169
    
170
    return sql.select(db, table, fields, conds, limit, start)
171

    
172
# Controls when and how put_table() will partition the input table
173
partition_size = 500000 # rows
174

    
175
input_col_prefix = '$'
176

    
177
def put_table(db, node, in_table, in_row_ct_ref=None, row_ins_ct_ref=None,
178
    limit=None, start=0, on_error=exc.reraise, col_defaults={}):
179
    '''
180
    @param node The XML tree that transforms the input to the output. Similar to
181
        put()'s node param, but with the input column name prefixed by
182
        input_col_prefix in place of the column value.
183
    @return sql_gen.Col Where the pkeys (from INSERT RETURNING) are made
184
        available
185
    '''
186
    in_table = sql_gen.as_Table(in_table)
187
    in_table.set_srcs([in_table], overwrite=False)
188
    db.src = str(in_table)
189
    
190
    db.autoanalyze = True # but don't do this in row-based import
191
    db.autoexplain = True # but don't do this in row-based import
192
    
193
    # Subset and partition in_table
194
    # OK to do even if table already the right size because it takes <1 sec.
195
    full_in_table = in_table
196
    total = 0
197
    while limit == None or total < limit:
198
        # Adjust partition size if last partition
199
        this_limit = partition_size
200
        if limit != None: this_limit = min(this_limit, limit - total)
201
        
202
        # Row # is interally 0-based, but 1-based to the user
203
        db.log_debug('********** Partition: rows '+str(start+1)+'-'
204
            +str(start+this_limit)+' **********', level=1.2)
205
        
206
        # Subset in_table
207
        in_table = copy.copy(full_in_table) # don't modify input!
208
        in_table.name = str(in_table) # prepend schema
209
        cur = sql.run_query_into(db, sql.mk_select(db, full_in_table,
210
            limit=this_limit, start=start), into=in_table, add_pkey_=True)
211
            # full_in_table will be shadowed (hidden) by created temp table
212
        
213
        this_ct = cur.rowcount
214
        total += this_ct
215
        start += this_ct # advance start to fetch next set
216
        if this_ct == 0: break # in_table size is multiple of partition_size
217
        
218
        # Recurse
219
        pkeys_loc = put(db, node, row_ins_ct_ref, on_error,
220
            col_defaults, in_table)
221
        if in_row_ct_ref != None: in_row_ct_ref[0] += this_ct
222
        
223
        sql.empty_temp(db, in_table)
224
        
225
        if this_ct < partition_size: break # partial partition = last
226
        
227
        # Work around PostgreSQL's temp table disk space leak
228
        db.reconnect()
229
    
230
    return pkeys_loc
(10-10/39)