/
connector.py
1749 lines (1462 loc) · 59.4 KB
/
connector.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""
/***************************************************************************
Name : DB Manager
Description : Database manager plugin for QGIS (Oracle)
Date : Aug 27, 2014
copyright : (C) 2014 by Médéric RIBREUX
email : mederic.ribreux@gmail.com
The content of this file is based on
- PG_Manager by Martin Dobias <wonder.sk@gmail.com> (GPLv2 license)
- DB Manager by Giuseppe Sucameli <brush.tyler@gmail.com> (GPLv2 license)
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
"""
from builtins import str
from builtins import range
from qgis.PyQt.QtSql import QSqlDatabase
from ..connector import DBConnector
from ..plugin import ConnectionError, DbError, Table
import os
from qgis.core import Qgis, QgsApplication, NULL, QgsWkbTypes
from . import QtSqlDB
import sqlite3
from functools import cmp_to_key
def classFactory():
if QSqlDatabase.isDriverAvailable("QOCISPATIAL"):
return OracleDBConnector
else:
return None
class OracleDBConnector(DBConnector):
ORGeomTypes = {
2001: QgsWkbTypes.Point,
2002: QgsWkbTypes.LineString,
2003: QgsWkbTypes.Polygon,
2005: QgsWkbTypes.MultiPoint,
2006: QgsWkbTypes.MultiLineString,
2007: QgsWkbTypes.MultiPolygon,
3001: QgsWkbTypes.Point25D,
3002: QgsWkbTypes.LineString25D,
3003: QgsWkbTypes.Polygon25D,
3005: QgsWkbTypes.MultiPoint25D,
3006: QgsWkbTypes.MultiLineString25D,
3007: QgsWkbTypes.MultiPolygon25D
}
def __init__(self, uri, connName):
DBConnector.__init__(self, uri)
self.connName = connName
self.user = uri.username() or os.environ.get('USER')
self.passwd = uri.password()
self.host = uri.host()
if self.host != "":
self.dbname = self.host
if uri.port() != "" and uri.port() != "1521":
self.dbname += ":" + uri.port()
if uri.database() != "":
self.dbname += "/" + uri.database()
elif uri.database() != "":
self.dbname = uri.database()
# Connection options
self.useEstimatedMetadata = uri.useEstimatedMetadata()
self.userTablesOnly = uri.param('userTablesOnly').lower() == "true"
self.geometryColumnsOnly = uri.param(
'geometryColumnsOnly').lower() == "true"
self.allowGeometrylessTables = uri.param(
'allowGeometrylessTables').lower() == "true"
self.onlyExistingTypes = uri.param(
'onlyExistingTypes').lower() == "true"
self.includeGeoAttributes = uri.param(
'includeGeoAttributes').lower() == "true"
# For refreshing
self.populated = False
try:
self.connection = QtSqlDB.connect(
"QOCISPATIAL", self.dbname, self.user, self.passwd)
except self.connection_error_types() as e:
raise ConnectionError(e)
# Find if we can connect to data_sources_cache.db
sqlite_cache_file = os.path.join(
QgsApplication.qgisSettingsDirPath(), u"data_sources_cache.db")
if (os.path.isfile(sqlite_cache_file)):
try:
self.cache_connection = sqlite3.connect(sqlite_cache_file)
except sqlite3.Error:
self.cache_connection = False
# Find if there is cache for our connection:
if self.cache_connection:
try:
cache_c = self.cache_connection.cursor()
query = (u"SELECT COUNT(*) FROM meta_oracle WHERE"
u" conn = '{}'".format(self.connName))
cache_c.execute(query)
has_cached = cache_c.fetchone()[0]
cache_c.close()
if not has_cached:
self.cache_connection = False
except sqlite3.Error:
self.cache_connection = False
self._checkSpatial()
self._checkGeometryColumnsTable()
def _connectionInfo(self):
return str(self._uri.connectionInfo(True))
def _checkSpatial(self):
"""Check whether Oracle Spatial is present in catalog."""
query = (u"SELECT count(*) FROM v$option WHERE parameter = "
u" 'Spatial' AND value = 'TRUE'")
c = self._execute(None, query)
self.has_spatial = self._fetchone(c)[0] > 0
c.close()
return self.has_spatial
def _checkGeometryColumnsTable(self):
"""Check if user can read *_SDO_GEOM_METADATA view."""
# First check if user can read ALL_SDO_GEOM_METADATA
privs = self.getRawTablePrivileges('ALL_SDO_GEOM_METADATA',
'MDSYS', 'PUBLIC')
# Otherwise, try with USER_SDO_GEOM_METADATA
if not privs[0]:
privs = self.getRawTablePrivileges('USER_SDO_GEOM_METADATA',
'MDSYS', 'PUBLIC')
if privs[0]:
self.has_geometry_columns = True
self.has_geometry_columns_access = True
self.is_geometry_columns_view = True
return True
else:
self.has_geometry_columns = False
self.has_geometry_columns_access = False
self.is_geometry_columns_view = False
return False
def getInfo(self):
"""Returns Oracle Database server version."""
c = self._execute(None, u"SELECT * FROM V$VERSION WHERE ROWNUM < 2")
res = self._fetchone(c)
c.close()
return res
def hasCache(self):
"""Returns self.cache_connection."""
if self.cache_connection:
return True
return False
def getSpatialInfo(self):
"""Returns Oracle Spatial version."""
if not self.has_spatial:
return
try:
c = self._execute(None, u"SELECT SDO_VERSION FROM DUAL")
except DbError:
return
res = self._fetchone(c)
c.close()
return res
def hasSpatialSupport(self):
"""Find if there is Spatial support."""
return self.has_spatial
def hasRasterSupport(self):
"""No raster support for the moment!"""
# return self.has_raster
return False
def hasCustomQuerySupport(self):
"""From Qgis v2.2 Oracle custom queries are supported."""
return Qgis.QGIS_VERSION_INT >= 20200
def hasTableColumnEditingSupport(self):
"""Tables can always be edited."""
return True
def hasCreateSpatialViewSupport(self):
"""We can create Spatial Views."""
return True
def fieldTypes(self):
"""From
http://docs.oracle.com/cd/B28359_01/server.111/b28318/datatype.htm#CNCPT1828
"""
return [
"number", "number(9)", # integers
"number(9,2)", "number(*,4)", "binary_float",
"binary_double", # floats
"varchar2(255)", "char(20)", "nvarchar2(255)",
"nchar(20)", # strings
"date", "timestamp" # date/time
]
def getSchemaPrivileges(self, schema):
"""
Schema privileges:
(can create new objects, can access objects in schema)
"""
# TODO: find the best way in Oracle do determine schema privileges
schema = self.user if not schema else schema
# In Oracle world, rights seems quite simple: only schema_owner can
# create table in the schema
if schema == self.user:
return (True, True)
# getSchemas request only extract schemas where user has access
return (False, True)
def getRawTablePrivileges(self, table, owner, grantee):
"""
Retrieve privileges on a table in a schema for a specific
user.
"""
result = [False, False, False, False]
# Inspect in all tab privs
sql = u"""
SELECT DISTINCT PRIVILEGE
FROM ALL_TAB_PRIVS_RECD
WHERE PRIVILEGE IN ('SELECT','INSERT','UPDATE','DELETE')
AND TABLE_NAME = {0}
AND OWNER = {1}
AND GRANTEE IN ({2}, {3})
""".format(self.quoteString(table),
self.quoteString(owner),
self.quoteString(grantee),
self.quoteString(grantee.upper()))
c = self._execute(None, sql)
res = self._fetchall(c)
c.close()
# Find which privilege is returned
for line in res:
if line[0] == u"SELECT":
result[0] = True
if line[0] == u"INSERT":
result[1] = True
if line[0] == u"UPDATE":
result[2] = True
if line[0] == u"DELETE":
result[3] = True
return result
def getTablePrivileges(self, table):
"""Retrieve table privileges: (select, insert, update, delete)."""
schema, tablename = self.getSchemaTableName(table)
if self.user == schema:
return [True, True, True, True]
return self.getRawTablePrivileges(tablename, schema, self.user)
def getSchemasCache(self):
"""Get the list of schemas from the cache."""
sql = u"""
SELECT DISTINCT ownername
FROM "oracle_{}"
ORDER BY ownername
""".format(self.connName)
c = self.cache_connection.cursor()
c.execute(sql)
res = c.fetchall()
c.close()
return res
def getSchemas(self):
"""Get list of schemas in tuples:
(oid, name, owner, perms, comment).
"""
if self.userTablesOnly:
return [(self.user,)]
if self.hasCache():
return self.getSchemasCache()
# Use cache if avalaible:
metatable = (u"all_objects WHERE object_type IN "
u"('TABLE','VIEW','SYNONYM')")
if self.geometryColumnsOnly:
metatable = u"all_sdo_geom_metadata"
sql = u"""SELECT DISTINCT owner FROM {} ORDER BY owner""".format(
metatable)
c = self._execute(None, sql)
res = self._fetchall(c)
c.close()
return res
def getTables(self, schema=None, add_sys_tables=False):
"""Get list of tables."""
if self.hasCache() and not self.populated:
self.populated = True
return self.getTablesCache(schema)
tablenames = []
items = []
try:
vectors = self.getVectorTables(schema)
for tbl in vectors:
tablenames.append((tbl[2], tbl[1]))
items.append(tbl)
except DbError:
pass
if self.allowGeometrylessTables:
# get all non geographic tables and views
prefix = u"ALL"
owner = u"o.owner"
where = u""
if self.userTablesOnly:
prefix = u"USER"
owner = u"user As OWNER"
if schema and not self.userTablesOnly:
where = u"AND o.owner = {} ".format(
self.quoteString(schema))
sql = u"""
SELECT o.OBJECT_NAME, {0},
CASE o.OBJECT_TYPE
WHEN 'VIEW' THEN 1
ELSE 0 END As isView
FROM {1}_OBJECTS o
WHERE o.object_type IN ('TABLE','VIEW','SYNONYM')
{2} {3}
ORDER BY o.OBJECT_NAME
""".format(owner, prefix, where,
u"" if add_sys_tables
else u"AND o.OBJECT_NAME NOT LIKE 'MDRT_%'")
c = self._execute(None, sql)
for tbl in self._fetchall(c):
if tablenames.count((tbl[1], tbl[0])) <= 0:
item = list(tbl)
item.insert(0, Table.TableType)
items.append(item)
c.close()
self.populated = True
listTables = sorted(items, key=cmp_to_key(lambda x, y: (x[1] > y[1]) - (x[1] < y[1])))
if self.hasCache():
self.updateCache(listTables, schema)
return self.getTablesCache(schema)
return listTables
def getTablesCache(self, schema=None):
"""Get list of tables from SQLite cache."""
tablenames = []
items = []
try:
vectors = self.getVectorTablesCache(schema)
for tbl in vectors:
tablenames.append((tbl[2], tbl[1]))
items.append(tbl)
except DbError:
pass
if not self.allowGeometrylessTables:
return sorted(items, key=cmp_to_key(lambda x, y: (x[1] > y[1]) - (x[1] < y[1])))
# get all non geographic tables and views
schema_where = u""
if self.userTablesOnly:
schema_where = u"AND ownername = '{}'".format(
self.user)
if schema and not self.userTablesOnly:
schema_where = u"AND ownername = '{}'".format(
schema)
sql = u"""
SELECT tablename, ownername, isview
FROM "oracle_{0}"
WHERE geometrycolname IS '' {1}
ORDER BY tablename
""".format(self.connName, schema_where)
c = self.cache_connection.cursor()
c.execute(sql)
for tbl in c.fetchall():
if tablenames.count((tbl[1], tbl[0])) <= 0:
item = list(tbl)
item.insert(0, Table.TableType)
items.append(item)
c.close()
return sorted(items, key=cmp_to_key(lambda x, y: (x[1] > y[1]) - (x[1] < y[1])))
def updateCache(self, tableList, schema=None):
"""Update the SQLite cache of table list for a schema."""
data = []
# First, we treat the list
for table in tableList:
line = ()
# if the table is a view bring pkCols
pkCols = None
if int(table[3]) == 1:
pkCols = self.pkCols((schema, table[1]))
# Deals with non-geographic tables
if table[0] == Table.TableType:
line = (table[1], table[2], int(table[3]),
u"",
u",".join(pkCols) if pkCols else u"",
100, 0, u"")
# Deals with vector tables
elif table[0] == Table.VectorType:
line = (table[1], table[2], int(table[3]),
table[4],
u",".join(pkCols) if pkCols else u"",
table[9],
table[8] if table[10] == u"-1" else table[10],
u"")
else:
continue
data.append(line)
# Then, empty the cache list
sql = u"""
DELETE FROM "oracle_{0}" {1}
""".format(self.connName,
u"WHERE ownername = '{}'".format(schema) if schema else u"")
self.cache_connection.execute(sql)
self.cache_connection.commit()
# Then we insert into SQLite database
sql = u"""
INSERT INTO "oracle_{}"(tablename, ownername, isview,
geometrycolname, pkcols, geomtypes, geomsrids, sql)
VALUES (?, ?, ?, ?, ?, ?, ?, ?)
""".format(self.connName)
c = self.cache_connection.cursor()
c.executemany(sql, data)
c.close()
self.cache_connection.commit()
def singleGeomTypes(self, geomtypes, srids):
"""Intelligent wkbtype grouping (multi with non multi)"""
if (QgsWkbTypes.Polygon in geomtypes and
QgsWkbTypes.MultiPolygon in geomtypes):
srids.pop(geomtypes.index(QgsWkbTypes.Polygon))
geomtypes.pop(geomtypes.index(QgsWkbTypes.Polygon))
if (QgsWkbTypes.Point in geomtypes and
QgsWkbTypes.MultiPoint in geomtypes):
srids.pop(geomtypes.index(QgsWkbTypes.Point))
geomtypes.pop(geomtypes.index(QgsWkbTypes.Point))
if (QgsWkbTypes.LineString in geomtypes and
QgsWkbTypes.MultiLineString in geomtypes):
srids.pop(geomtypes.index(QgsWkbTypes.LineString))
geomtypes.pop(geomtypes.index(QgsWkbTypes.LineString))
if QgsWkbTypes.Unknown in geomtypes and len(geomtypes) > 1:
srids.pop(geomtypes.index(QgsWkbTypes.Unknown))
geomtypes.pop(geomtypes.index(QgsWkbTypes.Unknown))
return geomtypes, srids
def getVectorTablesCache(self, schema=None):
"""Get list of table with a geometry column from SQLite cache
it returns:
name (table name)
namespace (schema)
type = 'view' (is a view?)
geometry_column
geometry_types (as WKB type)
srids
"""
schema_where = u""
if self.userTablesOnly:
schema_where = u"AND ownername = '{}'".format(
self.user)
if schema and not self.userTablesOnly:
schema_where = u"AND ownername = '{}'".format(
schema)
sql = u"""
SELECT tablename, ownername, isview,
geometrycolname,
geomtypes, geomsrids
FROM "oracle_{0}"
WHERE geometrycolname IS NOT '' {1}
ORDER BY tablename
""".format(self.connName, schema_where)
items = []
c = self.cache_connection.cursor()
c.execute(sql)
lst_tables = c.fetchall()
c.close()
# Handle multiple geometries tables
for i, tbl in enumerate(lst_tables):
item = list(tbl)
srids = item.pop()
geomtypes = item.pop()
item.insert(0, Table.VectorType)
if len(geomtypes) > 0 and len(srids) > 0:
geomtypes = [int(l) for l in str(geomtypes).split(u",")]
srids = [int(l) for l in str(srids).split(u",")]
geomtypes, srids = self.singleGeomTypes(geomtypes, srids)
for j in range(len(geomtypes)):
buf = list(item)
geomtype = geomtypes[j]
srid = srids[j]
datatype = QgsWkbTypes.displayString(QgsWkbTypes.flatType(QgsWkbTypes.singleType(geomtype)))
geo = datatype.upper()
buf.append(geo)
buf.append(geomtype)
buf.append(QgsWkbTypes.coordDimensions(geomtype)) # Dimensions
buf.append(srid)
buf.append(None) # To respect ORTableVector row
buf.append(None) # To respect ORTableVector row
items.append(buf)
return items
def getVectorTables(self, schema=None):
"""Get list of table with a geometry column
it returns a table of tuples:
name (table name)
namespace (schema/owner)
isView (is a view?)
geometry_column
srid
"""
if not self.has_spatial:
return []
# discovery of all geographic tables
prefix = u"all"
owner = u"c.owner"
where = None
if not self.geometryColumnsOnly:
where = u"WHERE c.data_type = 'SDO_GEOMETRY'"
if schema and not self.userTablesOnly:
where = u"{0} c.owner = {1}".format(
u"{} AND".format(where) if where else u"WHERE",
self.quoteString(schema))
if self.userTablesOnly:
prefix = u"user"
owner = u"user As owner"
if self.geometryColumnsOnly:
where = u""
sql = u"""
SELECT c.table_name, {0},
CASE o.OBJECT_TYPE
WHEN 'VIEW' THEN 1
ELSE 0 END As isView,
c.column_name,
{1}
FROM {2}_{3} c
JOIN {2}_objects o ON c.table_name = o.object_name
AND o.object_type IN ('TABLE','VIEW','SYNONYM') {4} {5}
ORDER BY TABLE_NAME
""".format(owner,
u"c.srid" if self.geometryColumnsOnly
else u"NULL as srid",
prefix,
u"sdo_geom_metadata" if self.geometryColumnsOnly
else u"tab_columns",
u"" if self.userTablesOnly
else u"AND c.owner = o.owner",
where)
# For each table, get all of the details
items = []
c = self._execute(None, sql)
lst_tables = self._fetchall(c)
c.close()
for i, tbl in enumerate(lst_tables):
item = list(tbl)
detectedSrid = item.pop()
if detectedSrid == NULL:
detectedSrid = u"-1"
else:
detectedSrid = int(detectedSrid)
if schema:
table_name = u"{0}.{1}".format(self.quoteId(schema),
self.quoteId(item[0]))
else:
table_name = self.quoteId(item[0])
geocol = self.quoteId(item[3])
geomMultiTypes, multiSrids = self.getTableGeomTypes(
table_name, geocol)
geomtypes = list(geomMultiTypes)
srids = list(multiSrids)
item.insert(0, Table.VectorType)
geomtypes, srids = self.singleGeomTypes(geomtypes, srids)
for j in range(len(geomtypes)):
buf = list(item)
geomtype = geomtypes[j]
datatype = QgsWkbTypes.displayString(QgsWkbTypes.flatType(QgsWkbTypes.singleType(geomtype)))
geo = datatype.upper()
buf.append(geo) # Geometry type as String
buf.append(geomtype) # Qgis.WkbType
buf.append(QgsWkbTypes.coordDimensions(geomtype)) # Dimensions
buf.append(detectedSrid) # srid
if not self.onlyExistingTypes:
geomMultiTypes.append(0)
multiSrids.append(multiSrids[0])
buf.append(u",".join([str(x) for x in
geomMultiTypes]))
buf.append(u",".join([str(x) for x in multiSrids]))
items.append(buf)
if self.allowGeometrylessTables and buf[-6] != u"UNKNOWN":
copybuf = list(buf)
copybuf[4] = u""
copybuf[-6] = u"UNKNOWN"
copybuf[-5] = QgsWkbTypes.NullGeometry
copybuf[-2] = QgsWkbTypes.NullGeometry
copybuf[-1] = u"0"
items.append(copybuf)
return items
def getTableComment(self, table, objectType):
"""Return the general comment for the object"""
schema, tablename = self.getSchemaTableName(table)
data_prefix = u"ALL" if schema else u"USER"
where = u"AND OWNER = {}".format(
self.quoteString(schema)) if schema else u""
if objectType in [u"TABLE", u"VIEW"]:
data_table = u"{}_TAB_COMMENTS"
table = u"TABLE"
elif objectType == u"MATERIALIZED VIEW":
data_table = u"{}_MVIEW_COMMENTS"
table = u"MVIEW"
else:
return None
data_table = data_table.format(data_prefix)
sql = u"""
SELECT COMMENTS FROM {0} WHERE {1}_NAME = {2}
{3}
""".format(data_table, table,
self.quoteString(tablename),
where)
c = self._execute(None, sql)
res = self._fetchone(c)
c.close()
if res:
return res[0]
return None
def getTableType(self, table):
"""Return the type of a table between the following:
* Table
* View
* Materialized view
"""
schema, tablename = self.getSchemaTableName(table)
sql = u"""
SELECT OBJECT_TYPE FROM {0} WHERE OBJECT_NAME = {1} {2}
"""
if schema:
sql = sql.format(u"ALL_OBJECTS",
self.quoteString(tablename),
u"AND OWNER = {}".format(
self.quoteString(schema)))
else:
sql = sql.format(u"USER_OBJECTS",
self.quoteString(tablename),
u"")
c = self._execute(None, sql)
res = self._fetchall(c)
c.close()
# Analyze return values
if not res:
return False
else:
types = [x[0] for x in res]
if u"MATERIALIZED VIEW" in types:
return u"MATERIALIZED VIEW"
elif u"VIEW" in types:
return u"VIEW"
else:
return u"TABLE"
def pkCols(self, table):
"""Return the primary keys candidates for a view."""
schema, tablename = self.getSchemaTableName(table)
sql = u"""
SELECT column_name
FROM all_tab_columns
WHERE owner={0}
AND table_name={1}
ORDER BY column_id
""".format(self.quoteString(schema) if schema else self.user,
self.quoteString(tablename))
c = self._execute(None, sql)
res = self._fetchall(c)
c.close()
return [x[0] for x in res] if res else None
def getTableGeomTypes(self, table, geomCol):
"""Return all the wkbTypes for a table by requesting geometry
column.
"""
estimated = u""
if self.useEstimatedMetadata:
estimated = u"AND ROWNUM < 100"
# Grab all of geometry types from the layer
query = u"""
SELECT DISTINCT a.{0}.SDO_GTYPE As gtype,
a.{0}.SDO_SRID
FROM {1} a
WHERE a.{0} IS NOT NULL {2}
ORDER BY a.{0}.SDO_GTYPE
""".format(geomCol, table, estimated)
try:
c = self._execute(None, query)
except DbError: # handle error views or other problems
return [QgsWkbTypes.Unknown], [-1]
rows = self._fetchall(c)
c.close()
# Handle results
if len(rows) == 0:
return [QgsWkbTypes.Unknown], [-1]
# A dict to store the geomtypes
geomtypes = []
srids = []
for row in rows:
if row[1] == NULL:
srids.append(-1)
else:
srids.append(int(row[1]))
if int(row[0]) in list(OracleDBConnector.ORGeomTypes.keys()):
geomtypes.append(OracleDBConnector.ORGeomTypes[int(row[0])])
else:
geomtypes.append(QgsWkbTypes.Unknown)
return geomtypes, srids
def getTableMainGeomType(self, table, geomCol):
"""Return the best wkbType for a table by requesting geometry
column.
"""
geomTypes, srids = self.getTableGeomTypes(table, geomCol)
# Make the decision:
wkbType = QgsWkbTypes.Unknown
srid = -1
order = [QgsWkbTypes.MultiPolygon25D, QgsWkbTypes.Polygon25D,
QgsWkbTypes.MultiPolygon, QgsWkbTypes.Polygon,
QgsWkbTypes.MultiLineString25D, QgsWkbTypes.LineString25D,
QgsWkbTypes.MultiLineString, QgsWkbTypes.LineString,
QgsWkbTypes.MultiPoint25D, QgsWkbTypes.Point25D,
QgsWkbTypes.MultiPoint, QgsWkbTypes.Point]
for geomType in order:
if geomType in geomTypes:
wkbType = geomType
srid = srids[geomTypes.index(geomType)]
break
return wkbType, srid
def getTableRowEstimation(self, table):
""" Find the estimated number of rows of a table. """
schema, tablename = self.getSchemaTableName(table)
prefix = u"ALL" if schema else u"USER"
where = u"AND OWNER = {}".format(
self.quoteString(schema)) if schema else u""
sql = u"""
SELECT NUM_ROWS FROM {0}_ALL_TABLES
WHERE TABLE_NAME = {1}
{2}
""".format(prefix, self.quoteString(tablename), where)
c = self._execute(None, sql)
res = self._fetchone(c)
c.close()
if not res or res[0] == NULL:
return 0
else:
return int(res[0])
def getTableDates(self, table):
""" Returns the modification/creation dates of an object"""
schema, tablename = self.getSchemaTableName(table)
prefix = u"ALL" if schema else u"USER"
where = u"AND OWNER = {}".format(
self.quoteString(schema)) if schema else u""
sql = u"""
SELECT CREATED, LAST_DDL_TIME FROM {0}_OBJECTS
WHERE OBJECT_NAME = {1}
{2}
""".format(prefix, self.quoteString(tablename), where)
c = self._execute(None, sql)
res = self._fetchone(c)
c.close()
if not res:
return None, None
return res[0], res[1]
def getTableRowCount(self, table):
"""Returns the number of rows of the table."""
c = self._execute(
None, u"SELECT COUNT(*) FROM {}".format(self.quoteId(table)))
res = self._fetchone(c)[0]
c.close()
return res
def getTableFields(self, table):
"""Returns list of columns in table."""
schema, tablename = self.getSchemaTableName(table)
schema_where = u" AND a.OWNER={}".format(
self.quoteString(schema) if schema else "")
sql = u"""
SELECT a.COLUMN_ID As ordinal_position,
a.COLUMN_NAME As column_name,
a.DATA_TYPE As data_type,
CASE a.DATA_TYPE
WHEN 'NUMBER' THEN a.DATA_PRECISION
ELSE a.DATA_LENGTH END As char_max_len,
a.DATA_SCALE As modifier,
a.NULLABLE As nullable,
a.DEFAULT_LENGTH As hasdefault,
a.DATA_DEFAULT As default_value,
a.DATA_TYPE As formatted_type,
c.COMMENTS
FROM ALL_TAB_COLUMNS a
JOIN ALL_COL_COMMENTS c ON
a.TABLE_NAME = c.TABLE_NAME
AND a.COLUMN_NAME = c.COLUMN_NAME
AND a.OWNER = c.OWNER
WHERE a.TABLE_NAME = {0} {1}
ORDER BY a.COLUMN_ID
""".format(self.quoteString(tablename), schema_where)
c = self._execute(None, sql)
res = self._fetchall(c)
c.close()
return res
def getSpatialFields(self, table):
"""Returns the list of geometric columns"""
fields = self.getTableFields(table)
geomFields = []
for field in fields:
if field[2] == u"SDO_GEOMETRY":
geomFields.append(field[1])
return geomFields
def getTableIndexes(self, table):
"""Get info about table's indexes."""
schema, tablename = self.getSchemaTableName(table)
schema_where = u" AND i.OWNER = {} ".format(
self.quoteString(schema) if schema else "")
sql = u"""
SELECT i.INDEX_NAME, c.COLUMN_NAME, i.ITYP_NAME,
i.STATUS, i.LAST_ANALYZED, i.COMPRESSION,
i.UNIQUENESS
FROM ALL_INDEXES i
INNER JOIN ALL_IND_COLUMNS c ON i.index_name = c.index_name
WHERE i.table_name = {0} {1}
""".format(self.quoteString(tablename), schema_where)
c = self._execute(None, sql)
res = self._fetchall(c)
c.close()
return res
def getMViewInfo(self, table):
"""Find some information about materialized views"""
schema, tablename = self.getSchemaTableName(table)
where = u" AND a.OWNER = {} ".format(
self.quoteString(schema)) if schema else u""
prefix = u"ALL" if schema else u"USER"
sql = u"""
SELECT a.REFRESH_MODE,
a.REFRESH_METHOD, a.BUILD_MODE, a.FAST_REFRESHABLE,
a.LAST_REFRESH_TYPE, a.LAST_REFRESH_DATE, a.STALENESS,
a.STALE_SINCE, a.COMPILE_STATE, a.USE_NO_INDEX
FROM {0}_MVIEWS a
WHERE MVIEW_NAME = {1}
{2}
""".format(prefix, self.quoteString(tablename), where)
c = self._execute(None, sql)
res = self._fetchone(c)
c.close()
return res
def getTableConstraints(self, table):
"""Find all the constraints for a table."""
schema, tablename = self.getSchemaTableName(table)
schema_where = u" AND c.OWNER={} ".format(
self.quoteString(schema)) if schema else u""
sql = u"""
SELECT a.CONSTRAINT_NAME, a.CONSTRAINT_TYPE,
c.COLUMN_NAME, a.VALIDATED, a.GENERATED, a.STATUS,
a.SEARCH_CONDITION, a.DELETE_RULE,
CASE WHEN b.TABLE_NAME IS NULL THEN NULL
ELSE b.OWNER || '.' || b.TABLE_NAME END
As F_TABLE, b.COLUMN_NAME As F_COLUMN
FROM ALL_CONS_COLUMNS c
INNER JOIN ALL_CONSTRAINTS a ON
a.CONSTRAINT_NAME = c.CONSTRAINT_NAME
LEFT OUTER JOIN ALL_CONS_COLUMNS b ON
b.CONSTRAINT_NAME = a.R_CONSTRAINT_NAME
AND a.R_OWNER = b.OWNER
AND b.POSITION = c.POSITION
WHERE c.TABLE_NAME = {0} {1}
""".format(self.quoteString(tablename), schema_where)
c = self._execute(None, sql)
res = self._fetchall(c)
c.close()
return res
def getTableTriggers(self, table):
"""Find all the triggers of the table."""
schema, tablename = self.getSchemaTableName(table)
sql = u"""
SELECT TRIGGER_NAME, TRIGGERING_EVENT, TRIGGER_TYPE, STATUS
FROM ALL_TRIGGERS
WHERE TABLE_OWNER = {0}
AND TABLE_NAME = {1}
""".format(self.quoteString(schema), self.quoteString(tablename))
c = self._execute(None, sql)
res = self._fetchall(c)