-
Notifications
You must be signed in to change notification settings - Fork 13
/
osm_psql.py
387 lines (353 loc) · 19.9 KB
/
osm_psql.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
""" Data storage with PostgreSQL """
import gc
import getpass
import pandas as pd
import shapely.wkt
import sqlalchemy
import sqlalchemy.engine.reflection
import sqlalchemy.engine.url
import sqlalchemy_utils
from pyhelpers.ops import confirmed
from pydriosm.download_GeoFabrik import regulate_input_subregion_name
def regulate_table_name(table_name, subregion_name_as_table_name=True):
"""
:param table_name: [str]
:param subregion_name_as_table_name: [bool] (default: True)
:return: [str]
"""
if subregion_name_as_table_name:
table_name = regulate_input_subregion_name(table_name)
table_name_ = table_name[:60] + '..' if len(table_name) >= 63 else table_name
table_name_ = table_name_.replace("'", "_")
return table_name_
class OSM:
def __init__(self, username='postgres', password=None, host='localhost', port=5432, database_name='postgres',
verbose=True):
"""
It requires to be connected to the database server so as to execute the "CREATE DATABASE" command.
A default database named "postgres" exists already, which is created by the "initdb" command when the data
storage area is initialised.
Prior to create a customised database, it requires to connect "postgres" in the first instance.
"""
self.database_info = {'drivername': 'postgresql+psycopg2',
'username': username, # postgres
'password': password if password else getpass.getpass(
"Password ({}@{}:{}): ".format(username, host, port)),
'host': host, # default: localhost
'port': port, # 5432 (default by installation).
'database': database_name}
# The typical form of a database URL is: url = backend+driver://username:password@host:port/database_name
self.url = sqlalchemy.engine.url.URL(**self.database_info)
self.dialect = self.url.get_dialect()
self.backend = self.url.get_backend_name()
self.driver = self.url.get_driver_name()
self.user, self.host = self.url.username, self.url.host
self.port = self.url.port
self.database_name = self.database_info['database']
if verbose:
print("Connecting to PostgreSQL database: {}@{}:{} ... ".format(self.database_name, self.host, self.port),
end="")
try:
if not sqlalchemy_utils.database_exists(self.url):
sqlalchemy_utils.create_database(self.url)
# Create a SQLAlchemy connectable
self.engine = sqlalchemy.create_engine(self.url, isolation_level='AUTOCOMMIT')
self.connection = self.engine.connect()
print("Successfully.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\".".format(e))
# Establish a connection to the specified database (named e.g. 'osm_extracts')
def connect_db(self, database_name='OSM_Geofabrik_PBF'):
"""
:param database_name: [str] (default: 'OSM_Geofabrik_PBF') name of a database
"""
self.database_name = database_name
self.database_info['database'] = self.database_name
self.url = sqlalchemy.engine.url.URL(**self.database_info)
if not sqlalchemy_utils.database_exists(self.url):
sqlalchemy_utils.create_database(self.url)
self.engine = sqlalchemy.create_engine(self.url, isolation_level='AUTOCOMMIT')
self.connection = self.engine.connect()
# Check if a database exists
def db_exists(self, database_name):
"""
:param database_name: [str] name of a database
:return: [bool]
"""
result = self.engine.execute("SELECT EXISTS("
"SELECT datname FROM pg_catalog.pg_database "
"WHERE datname='{}');".format(database_name))
return result.fetchone()[0]
# An alternative to sqlalchemy_utils.create_database()
def create_db(self, database_name='OSM_Geofabrik_PBF', verbose=False):
"""
:param database_name: [str] (default: 'OSM_Geofabrik_PBF') name of a database
:param verbose: [bool] (default: False)
from psycopg2 import OperationalError
try:
self.engine.execute('CREATE DATABASE "{}"'.format(database_name))
except OperationalError:
self.engine.execute(
'SELECT *, pg_terminate_backend(pid) FROM pg_stat_activity WHERE username=\'postgres\';')
self.engine.execute('CREATE DATABASE "{}"'.format(database_name))
"""
if not self.db_exists(database_name):
print("Creating a database \"{}\" ... ".format(database_name), end="") if verbose else ""
self.disconnect()
self.engine.execute('CREATE DATABASE "{}";'.format(database_name))
print("Done.") if verbose else ""
else:
print("The database already exists.") if verbose else ""
self.connect_db(database_name=database_name)
# Get size of a database
def get_db_size(self, database_name=None):
"""
:param database_name: [str; None (default)] name of a database; if None, the current connected database is used
:return: [str] size of the database
"""
db_name = '\'{}\''.format(database_name) if database_name else 'current_database()'
db_size = self.engine.execute('SELECT pg_size_pretty(pg_database_size({})) AS size;'.format(db_name))
return db_size.fetchone()[0]
# Kill the connection to the specified database
def disconnect(self, database_name=None, verbose=False):
"""
:param database_name: [str; None (default)] name of database to disconnect from
:param verbose: [bool] (default: False)
Alternative way:
SELECT
pg_terminate_backend(pg_stat_activity.pid)
FROM
pg_stat_activity
WHERE
pg_stat_activity.datname = database_name AND pid <> pg_backend_pid();
"""
db_name = self.database_name if database_name is None else database_name
print("Disconnecting the database \"{}\" ... ".format(db_name), end="") if verbose else ""
try:
self.connect_db('postgres')
self.engine.execute('REVOKE CONNECT ON DATABASE {} FROM PUBLIC, postgres;'.format(db_name))
self.engine.execute(
'SELECT pg_terminate_backend(pid) '
'FROM pg_stat_activity '
'WHERE datname = \'{}\' AND pid <> pg_backend_pid();'.format(db_name))
print("Done.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))
# Kill connections to all other databases
def disconnect_all_others(self):
self.connect_db('postgres')
self.engine.execute('SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE pid <> pg_backend_pid();')
# Drop the specified database
def drop(self, database_name=None, confirmation_required=True, verbose=False):
"""
:param database_name: [str; None (default)] database to be disconnected; if None, to disconnect the current one
:param confirmation_required: [bool] (default: True)
:param verbose: [bool] (default: False)
"""
db_name = self.database_name if database_name is None else database_name
if confirmed("Confirmed to drop the database \"{}\" for {}@{}?".format(db_name, self.user, self.host),
confirmation_required=confirmation_required):
self.disconnect(db_name)
try:
print("Dropping the database \"{}\" ... ".format(db_name), end="") if verbose else ""
self.engine.execute('DROP DATABASE IF EXISTS "{}"'.format(db_name))
print("Done.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))
# Create a new schema in the database being currently connected
def create_schema(self, schema_name, verbose=False):
"""
:param schema_name: [str] name of a schema
:param verbose: [bool] (default: False)
"""
try:
print("Creating a schema \"{}\" ... ".format(schema_name), end="") if verbose else ""
self.engine.execute('CREATE SCHEMA IF NOT EXISTS "{}";'.format(schema_name))
print("Done.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))
# Formulate printing message for schemas
def multi_names_msg(self, *multi_names, desc='schema'):
"""
:param multi_names: [str; iterable]
:param desc: [str] (default: 'schema')
:return: [tuple] ([tuple, str])
"""
if multi_names:
schemas = tuple(schema_name for schema_name in multi_names)
else:
schemas = tuple(
x for x in sqlalchemy.engine.reflection.Inspector.from_engine(self.engine).get_schema_names()
if x != 'public' and x != 'information_schema')
print_plural = (("{} " if len(schemas) == 1 else "{}s ").format(desc))
print_schema = ("\"{}\", " * (len(schemas) - 1) + "\"{}\"").format(*schemas)
return schemas, print_plural + print_schema
# Drop a schema in the database being currently connected
def drop_schema(self, *schema_names, confirmation_required=True, verbose=False):
"""
:param schema_names: [str] name of one schema, or names of multiple schemas
:param confirmation_required: [bool] (default: True)
:param verbose: [bool] (default: False)
"""
schemas, schemas_msg = self.multi_names_msg(*schema_names, desc='schema')
if confirmed("Confirmed to drop the {} from the database \"{}\"".format(schemas_msg, self.database_name),
confirmation_required=confirmation_required):
try:
print("Dropping the {} ... ".format(schemas_msg), end="") if verbose else ""
self.engine.execute(
'DROP SCHEMA IF EXISTS ' + ('%s, ' * (len(schemas) - 1) + '%s') % schemas + ' CASCADE;')
print("Done.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))
# Check if a table exists
def subregion_table_exists(self, schema_name, table_name, subregion_name_as_table_name=True):
"""
:param schema_name: [str] name of a schema
:param table_name: [str] name of a table
:param subregion_name_as_table_name: [bool] (default: True) whether to use subregion name as table name
:return: [bool]
"""
table_name_ = regulate_table_name(table_name, subregion_name_as_table_name)
res = self.engine.execute("SELECT EXISTS("
"SELECT * FROM information_schema.tables "
"WHERE table_schema='{}' "
"AND table_name='{}');".format(schema_name, table_name_))
return res.fetchone()[0]
# Import data (as a pandas.DataFrame) into the database being currently connected
def dump_osm_pbf_data_by_layer(self, layer_data, schema_name, table_name, subregion_name_as_table_name=True,
parsed=True, if_exists='replace', chunk_size=None, verbose=False):
"""
:param layer_data: [pandas.DataFrame] data of one layer
:param schema_name: [str] name of the layer
:param table_name: [str] name of the targeted table
:param subregion_name_as_table_name: [bool] (default: True) whether to use subregion name as table name
:param parsed: [bool] (default: True) whether 'layer_data' has been parsed
:param if_exists: [str] 'fail', 'replace' (default), 'append'
:param chunk_size: [int; None (default)]
:param verbose: [bool] (default: False)
"""
if schema_name not in sqlalchemy.engine.reflection.Inspector.from_engine(self.engine).get_schema_names():
self.create_schema(schema_name)
table_name_ = regulate_table_name(table_name, subregion_name_as_table_name)
try:
print("Dumping the data as a table \"{}\" into {}.\"{}\"@{} ... ".format(
table_name, schema_name, self.database_name, self.host), end="") if verbose else ""
if not parsed:
layer_data.to_sql(table_name_, self.engine, schema=schema_name,
if_exists=if_exists, index=False, chunksize=chunk_size,
dtype={'geometry': sqlalchemy.types.JSON, 'properties': sqlalchemy.types.JSON})
else:
lyr_dat = layer_data.copy()
if not layer_data.empty:
lyr_dat.coordinates = layer_data.coordinates.map(lambda x: x.wkt)
lyr_dat.other_tags = layer_data.other_tags.astype(str)
# dtype={'coordinates': types.TEXT, 'other_tags': types.TEXT}
lyr_dat.to_sql(table_name_, self.engine, schema=schema_name,
if_exists=if_exists, index=False, chunksize=chunk_size)
print("Done.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))
# Import all data of a given (sub)region
def dump_osm_pbf_data(self, subregion_data, table_name, parsed=True, if_exists='replace', chunk_size=None,
subregion_name_as_table_name=True, verbose=True):
"""
:param subregion_data: [pd.DataFrame] data of a subregion
:param table_name: [str] name of a table; e.g. name of the subregion (recommended)
:param parsed: [bool] (default: True) whether 'subregion_data' has been parsed
:param if_exists: [str] 'fail', 'replace' (default), or 'append'
:param chunk_size: [int; None (default)]
:param subregion_name_as_table_name: [bool] (default: True) whether to use subregion name as table name
:param verbose: [bool] (default: True)
"""
if subregion_name_as_table_name:
table_name = regulate_input_subregion_name(table_name)
if verbose:
print("Dumping \"{}\" to {}@{}:{} ... ".format(table_name, self.database_name, self.host, self.port))
for geom_type, layer_data in subregion_data.items():
print(" {} ... ".format(geom_type), end="") if verbose else ""
if layer_data.empty and self.subregion_table_exists(geom_type, table_name, subregion_name_as_table_name):
print("The layer is empty. An empty table already exists in the database.") if verbose else ""
pass
else:
try:
self.dump_osm_pbf_data_by_layer(layer_data, geom_type, table_name, subregion_name_as_table_name,
parsed, if_exists, chunk_size)
print("Done. Total amount of features: {}".format(len(layer_data))) if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))
del layer_data
gc.collect()
# Read data for a given subregion and schema (geom type, e.g. points, lines, ...)
def read_osm_pbf_data(self, table_name, *schema_names, parsed=True, subregion_name_as_table_name=True,
chunk_size=None, sorted_by_id=True):
"""
:param table_name: [str] name of a table name; 'subregion_name' is recommended when importing the data
:param schema_names: [str] one or multiple names of layers, e.g. 'points', 'lines'
:param parsed: [bool] (default: True) whether the table data was parsed before being imported
:param subregion_name_as_table_name: [bool] (default: True) whether to use subregion name as 'table_name'
:param chunk_size: [int; None (default)] number of rows to include in each chunk
:param sorted_by_id: [bool] (default: True)
:return: [dict] e.g. {layer_name_1: layer_data_1, ...}
"""
table_name_ = regulate_table_name(table_name, subregion_name_as_table_name)
if schema_names:
geom_types = [x for x in schema_names]
else:
geom_types = [x for x in sqlalchemy.engine.reflection.Inspector.from_engine(self.engine).get_schema_names()
if x != 'public' and x != 'information_schema']
layer_data = []
for schema_name in geom_types:
sql_query = 'SELECT * FROM {}."{}";'.format(schema_name, table_name_)
lyr_dat = pd.read_sql(sql=sql_query, con=self.engine, chunksize=chunk_size)
if sorted_by_id:
lyr_dat.sort_values('id', inplace=True)
lyr_dat.index = range(len(lyr_dat))
if parsed:
lyr_dat.coordinates = lyr_dat.coordinates.map(shapely.wkt.loads)
lyr_dat.other_tags = lyr_dat.other_tags.map(eval)
layer_data.append(lyr_dat)
return dict(zip(geom_types, layer_data))
# Remove subregion data from the database being currently connected
def drop_subregion_data_by_layer(self, table_name, *schema_names, subregion_name_as_table_name=True,
confirmation_required=True, verbose=False):
"""
:param table_name: [str] name of a subregion
:param subregion_name_as_table_name: [bool] (default: True) whether to use subregion name as 'table_name'
:param schema_names: [str] one or multiple names of schemas
:param confirmation_required: [bool] (default: True)
:param verbose: [bool] (default: False)
"""
table_name_ = regulate_table_name(table_name, subregion_name_as_table_name)
geom_types, schemas_msg = self.multi_names_msg(*schema_names, desc='layer')
if confirmed("Confirmed to drop the {} for \"{}\"".format(schemas_msg, table_name_),
confirmation_required=confirmation_required):
tables = tuple(('{}.\"{}\"'.format(schema_name, table_name_) for schema_name in geom_types))
if verbose:
print(("Dropping " + "%s, "*(len(tables) - 2) + "%s and %s" + " ... ") % tables, end="")
try:
self.engine.execute(('DROP TABLE IF EXISTS ' + '%s, '*(len(tables) - 1) + '%s CASCADE;') % tables)
print("Done.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))
# Remove tables from the database being currently connected
def drop_layer_data_by_subregion(self, schema_name, *table_names, subregion_name_as_table_name=True,
confirmation_required=True, verbose=False):
"""
:param schema_name: [str] name of a layer name
:param subregion_name_as_table_name: [bool] (default: True) whether to use subregion name as 'table_name'
:param table_names: [str] one or multiple names of subregions
:param confirmation_required: [bool] (default: True)
:param verbose: [bool] (default: False)
"""
table_names_ = (regulate_table_name(table_name, subregion_name_as_table_name) for table_name in table_names)
_, tbls_msg = self.multi_names_msg(*table_names, desc='table')
if confirmed("Confirmed to drop the {} from the database \"{}\"".format(tbls_msg, self.database_name),
confirmation_required=confirmation_required):
tables = tuple(('{}.\"{}\"'.format(schema_name, table_name) for table_name in table_names_))
if verbose:
print(("Dropping " + "%s, "*(len(tables) - 2) + "%s and %s" + " ... ") % tables, end="")
try:
self.engine.execute(('DROP TABLE IF EXISTS ' + '%s, '*(len(tables) - 1) + '%s CASCADE;') % tables)
print("Done.") if verbose else ""
except Exception as e:
print("Failed. CAUSE: \"{}\"".format(e))