/[thuban]/branches/WIP-pyshapelib-bramz/Thuban/Model/postgisdb.py
ViewVC logotype

Contents of /branches/WIP-pyshapelib-bramz/Thuban/Model/postgisdb.py

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1955 - (show annotations)
Tue Nov 18 15:37:31 2003 UTC (21 years, 3 months ago) by bh
Original Path: trunk/thuban/Thuban/Model/postgisdb.py
File MIME type: text/x-python
File size: 15650 byte(s)
(PostGISConnection.MatchesParameters):
New. Test whether the connection matches a set of connection
parameters

1 # Copyright (C) 2003 by Intevation GmbH
2 # Authors:
3 # Martin Mueller <[email protected]>
4 # Bernhard Herzog <[email protected]>
5 #
6 # This program is free software under the GPL (>=v2)
7 # Read the file COPYING coming with the software for details.
8
9 """Basic interface to a PostGIS database"""
10
11 from __future__ import generators
12
13 try:
14 import psycopg
15 except ImportError:
16 psycopg = None
17
18 import table
19 import wellknowntext
20
21 from data import SHAPETYPE_POLYGON, SHAPETYPE_ARC, SHAPETYPE_POINT, RAW_WKT
22
23 def has_postgis_support():
24 """Return whether this Thuban instance supports PostGIS connections
25
26 Having PostGIS support means that the psycopg module can be
27 imported.
28 """
29 return psycopg is not None
30
31 def psycopg_version():
32 return psycopg.__version__
33
34 if psycopg is not None:
35 type_map = [(psycopg.STRING, table.FIELDTYPE_STRING),
36 (psycopg.INTEGER, table.FIELDTYPE_INT),
37 (psycopg.FLOAT, table.FIELDTYPE_DOUBLE)]
38
39
40 def quote_identifier(ident):
41 """Return a quoted version of the identifier ident.
42
43 The return value is a string that can be put directly into an SQL
44 statement. The quoted identifier is surrounded by double quotes and
45 any double quotes alread in the input value are converted to two
46 double quotes. Examples:
47
48 >>> quote_identifier("abc\"def")
49 '"abc""def"'
50 >>> quote_identifier("abc def")
51 '"abc def"'
52 """
53 return '"' + '""'.join(ident.split('"')) + '"'
54
55
56 class ConnectionError(Exception):
57
58 """Class for exceptions occurring when establishing a Databse connection"""
59
60
61 class PostGISConnection:
62
63 """Represent a PostGIS database
64
65 A PostGISConnection instance has the following public attributes:
66
67 dbname -- The name of the database
68 host, port -- Host and port to connect to
69 user -- The user name to connect as.
70
71 All of these attributes are strings and may be empty strings to
72 indicate default values.
73 """
74
75 def __init__(self, dbname, host="", user="", password="", dbtype="",
76 port=""):
77 self.dbname = dbname
78 self.host = host
79 self.port = port
80 self.user = user
81 self.password = password
82 self.dbtype = dbtype
83 self.connect()
84
85 def connect(self):
86 """Internal: Establish the database connection"""
87 params = []
88 for name in ("host", "port", "dbname", "user", "password"):
89 val = getattr(self, name)
90 if val:
91 params.append("%s=%s" % (name, val))
92 try:
93 self.connection = psycopg.connect(" ".join(params))
94 except psycopg.OperationalError, val:
95 raise ConnectionError(str(val))
96
97 # determine the OID for the geometry type. This is PostGIS
98 # specific.
99 cursor = self.connection.cursor()
100 cursor.execute("SELECT OID, typname FROM pg_type WHERE"
101 +" typname = 'geometry'")
102 row = cursor.fetchone()
103 self.connection.commit()
104 if row is not None:
105 self.geometry_type = row[0]
106 else:
107 raise ValueError("Can't determine postgres type of geometries")
108
109 def BriefDescription(self):
110 """Return a brief, one-line description of the connection
111
112 The return value is suitable for a list box of all database
113 connections.
114 """
115 return ("postgis://%(user)s@%(host)s:%(port)s/%(dbname)s"
116 % self.__dict__)
117
118 def MatchesParameters(self, parameters):
119 """Return whether the connection matches the dictionary of parameters
120
121 Return whether instatiating the connection with the given
122 parameters would establish essentially the same connection as
123 self. The connection is essentially the same if the same
124 database (identified by host, port and databasename) is accessed
125 as the same user.
126 """
127 return (parameters["host"] == self.host
128 and parameters["port"] == self.port
129 and parameters["dbname"] == self.dbname
130 and parameters["user"] == self.user)
131
132 def Close(self):
133 """Close the database connection"""
134 self.connection.close()
135
136 def GeometryTables(self):
137 """Return a list with the names of all tables with a geometry column"""
138 cursor = self.connection.cursor()
139 cursor.execute("SELECT f_table_name FROM geometry_columns;")
140 result = [row[0] for row in cursor.fetchall()]
141 self.connection.commit()
142 return result
143
144 def cursor(self):
145 """Return a DB API 2.0 cursor for the database"""
146 return self.connection.cursor()
147
148
149
150 class PostGISColumn:
151
152 """Column description for a PostGISTable
153
154 In addition to the normal column object attributes name, type and
155 index, PostGISColumn objects have a quoted_name attribute which
156 contains a quoted version of name for use in SQL statements. The
157 quoted_name attribute is mainly intended for internal use by the
158 PostGISTable class.
159 """
160
161 def __init__(self, name, type, index):
162 self.name = name
163 self.quoted_name = quote_identifier(name)
164 self.type = type
165 self.index = index
166
167
168 class PostGISTable:
169
170 """A Table in a PostGIS database
171
172 A PostgreSQL table may contain columns with types not (yet)
173 supported by Thuban. Instances of this class ignore those columns
174 and pretend they don't exist, i.e. they won't show up in the column
175 descriptions returned by Columns() and other methods.
176 """
177
178 def __init__(self, db, tablename):
179 """Initialize the PostGISTable.
180
181 The db parameter should be an instance of PostGISConnection and
182 tablename the name of a table in the database represented by db.
183 """
184 self.db = db
185 self.tablename = tablename
186 # Tablename quoted for use in SQL statements.
187 self.quoted_tablename = quote_identifier(tablename)
188
189 # Map column names and indices to column objects.
190 self.column_map = {}
191
192 self._fetch_table_information()
193
194 def _fetch_table_information(self):
195 """Internal: Update information about the table"""
196 self.columns = []
197 cursor = self.db.cursor()
198 cursor.execute("SELECT * FROM %s WHERE 0=1" % self.quoted_tablename)
199 description = cursor.description
200
201 for i in range(len(description)):
202 for pgtyp, tabletyp in type_map:
203 if pgtyp == description[i][1]:
204 col = PostGISColumn(description[i][0], tabletyp,
205 len(self.columns))
206 break
207 else:
208 if description[i][1] == self.db.geometry_type:
209 self.geometry_column = description[i][0]
210 self.quoted_geo_col =quote_identifier(self.geometry_column)
211 # No matching table type. Ignore the column.
212 # FIXME: We should at least print a warning about
213 # ignored columns
214 continue
215 self.columns.append(col)
216
217 for col in self.columns:
218 self.column_map[col.name] = col
219 self.column_map[col.index] = col
220
221 # Build query string for ReadRowAsDict
222 self.query_stmt = ("SELECT %s from %s"
223 % (", ".join([col.quoted_name
224 for col in self.columns]),
225 self.quoted_tablename))
226
227 def DBConnection(self):
228 """Return the dbconnection used by the table"""
229 return self.db
230
231 def TableName(self):
232 """Return the name of the table in the database"""
233 return self.tablename
234
235 def Title(self):
236 """Return the title of the table.
237
238 The title is currently fixed and equal to the tablename
239 """
240 return self.tablename
241
242 def Dependencies(self):
243 """Return an empty tuple because a PostGISTable depends on nothing else
244 """
245 return ()
246
247 def NumColumns(self):
248 return len(self.columns)
249
250 def Columns(self):
251 return self.columns
252
253 def Column(self, col):
254 return self.column_map[col]
255
256 def HasColumn(self, col):
257 return self.column_map.has_key(col)
258
259 def NumRows(self):
260 cursor = self.db.cursor()
261 cursor.execute("SELECT count(*) FROM %s" % self.quoted_tablename)
262 return cursor.fetchone()[0]
263
264 def RowIdToOrdinal(self, gid):
265 """Return the row ordinal given its id"""
266 cursor = self.db.cursor()
267 cursor.execute("SELECT count(*) FROM %s WHERE gid < %d;"
268 % (self.quoted_tablename, gid))
269 return cursor.fetchone()[0]
270
271 def RowOrdinalToId(self, num):
272 """Return the rowid for given its ordinal"""
273 cursor = self.db.cursor()
274 cursor.execute("SELECT gid FROM %s LIMIT 1 OFFSET %d;"
275 % (self.quoted_tablename, num))
276 return cursor.fetchone()[0]
277
278 def ReadRowAsDict(self, row, row_is_ordinal = 0):
279 cursor = self.db.cursor()
280 if row_is_ordinal:
281 stmt = self.query_stmt + " LIMIT 1 OFFSET %d" % row
282 else:
283 stmt = self.query_stmt + " WHERE gid = %d" % row
284 cursor.execute(stmt)
285 result = {}
286 for col, value in zip(self.columns, cursor.fetchone()):
287 result[col.name] = value
288 return result
289
290 def ReadValue(self, row, col, row_is_ordinal = 0):
291 cursor = self.db.cursor()
292 if row_is_ordinal:
293 stmt = ("SELECT %s FROM %s LIMIT 1 OFFSET %d" %
294 (self.column_map[col].quoted_name, self.quoted_tablename,
295 row))
296 else:
297 stmt = ("SELECT %s FROM %s WHERE gid = %d" %
298 (self.column_map[col].quoted_name, self.quoted_tablename,
299 row))
300 cursor.execute(stmt)
301 return cursor.fetchone()[0]
302
303 def ValueRange(self, col):
304 cursor = self.db.cursor()
305 name = self.column_map[col].quoted_name
306 cursor.execute("SELECT min(%s), max(%s) FROM %s" %
307 (name, name, self.quoted_tablename))
308 return tuple(cursor.fetchone())
309
310 def UniqueValues(self, col):
311 cursor = self.db.cursor()
312 name = self.column_map[col].quoted_name
313 cursor.execute("SELECT %s FROM %s GROUP BY %s" %
314 (name, self.quoted_tablename, name))
315 return [row[0] for row in cursor.fetchall()]
316
317 def SimpleQuery(self, left, comparison, right):
318 if comparison not in ("==", "!=", "<", "<=", ">=", ">"):
319 raise ValueError("Comparison operator %r not allowed" % comparison)
320
321 if comparison == "==":
322 comparison = "="
323
324 if isinstance(right, PostGISColumn):
325 right_template = right.quoted_name
326 params = ()
327 else:
328 right_template = "%s"
329 params = (right,)
330
331 query = "SELECT gid FROM %s WHERE %s %s %s ORDER BY gid;" \
332 % (self.quoted_tablename, left.quoted_name, comparison,
333 right_template)
334
335 cursor = self.db.cursor()
336 cursor.execute(query, params)
337 result = []
338 while 1:
339 row = cursor.fetchone()
340 if row is None:
341 break
342 result.append(row[0])
343 return result
344
345
346 class PostGISShape:
347
348 def __init__(self, shapeid, data):
349 self.shapeid = shapeid
350 self.data = data
351
352 def compute_bbox(self):
353 """
354 Return the bounding box of the shape as a tuple (minx,miny,maxx,maxy)
355 """
356 xs = []
357 ys = []
358 for part in self.Points():
359 for x, y in part:
360 xs.append(x)
361 ys.append(y)
362 return (min(xs), min(ys), max(xs), max(ys))
363
364 def ShapeID(self):
365 return self.shapeid
366
367 def Points(self):
368 return wellknowntext.parse_wkt_thuban(self.data)
369
370 def RawData(self):
371 return self.data
372
373
374 shapetype_map = {"POLYGON": SHAPETYPE_POLYGON,
375 "MULTIPOLYGON": SHAPETYPE_POLYGON,
376 "MULTILINESTRING": SHAPETYPE_ARC,
377 "POINT": SHAPETYPE_POINT}
378
379
380 class PostGISShapeStore(PostGISTable):
381
382 """Shapestore interface to a table in a PostGIS database"""
383
384 def Table(self):
385 """Return self since a PostGISShapeStore is its own table."""
386 return self
387
388 def OrigShapeStore(self):
389 """Return None since the PostGISShapeStore is not derived from another
390 """
391 return None
392
393 def ShapeType(self):
394 """Return the type of the shapes in the shapestore."""
395 cursor = self.db.cursor()
396 cursor.execute("SELECT type FROM geometry_columns WHERE"
397 " f_table_name=%s", (self.tablename,))
398 result = cursor.fetchone()[0]
399 cursor.close()
400 return shapetype_map[result]
401
402 def RawShapeFormat(self):
403 """Return the raw data format of the shape data.
404
405 For the PostGISShapeStore this is RAW_WKT.
406 """
407 return RAW_WKT
408
409 def NumShapes(self):
410 # The number of shapes is the same as the number of rows,
411 # assuming that the geometry can't be NULL.
412 return self.NumRows()
413
414 def BoundingBox(self):
415 """Return the bounding box of all shapes in the postgis table"""
416 minx = miny = maxx = maxy = None
417 x=[]
418 y=[]
419 cursor = self.db.cursor()
420 try:
421 # Using the extent function is postgis specific. An OGC
422 # Simple Features compliant solution would be to use a query
423 # like "SELECT AsText(Envelope(the_geom)) FROM mytable;" and
424 # calculate the bounding box by hand from that
425 cursor.execute("SELECT extent(%s) FROM %s;"
426 % (self.quoted_geo_col, self.quoted_tablename))
427 result = cursor.fetchone()
428 if result:
429 (minx, miny), (maxx, maxy) \
430 = wellknowntext.parse_wkt_thuban(result[0])[0]
431 return (minx, miny, maxx, maxy)
432 finally:
433 cursor.close()
434
435 def Shape(self, shapeid):
436 cursor = self.db.cursor()
437 cursor.execute("SELECT AsText(%s) FROM %s WHERE gid=%d"
438 % (self.quoted_geo_col, self.quoted_tablename, shapeid))
439 wkt = cursor.fetchone()[0]
440 cursor.close()
441 return PostGISShape(shapeid, wkt)
442
443 def AllShapes(self):
444 cursor = self.db.cursor()
445 cursor.execute("SELECT gid, AsText(%s) FROM %s ORDER BY gid"
446 % (self.quoted_geo_col, self.quoted_tablename))
447 while 1:
448 result = cursor.fetchone()
449 if result is None:
450 return
451 yield PostGISShape(result[0], result[1])
452
453
454 def ShapesInRegion(self, bbox):
455 """Generate all shapes overlapping the region given by bbox."""
456 # IMPORTANT:This will work for PostGIS < 0.8
457 left, bottom, right, top = bbox
458 geom = (("POLYGON((" + ", ".join(["%f %f"] * 5) + "))")
459 % (left, bottom, left, top, right, top, right, bottom,
460 left, bottom))
461 cursor = self.db.cursor()
462 cursor.execute("SELECT gid, AsText(%s) FROM %s"
463 " WHERE %s && GeometryFromText('%s', -1) ORDER BY gid"
464 % (self.quoted_geo_col, self.quoted_tablename,
465 self.quoted_geo_col, geom))
466 while 1:
467 result = cursor.fetchone()
468 if result is None:
469 return
470 yield PostGISShape(result[0], result[1])

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26