def add_flatten_dataset_table(self):
""" Add a flatten dataset table with all links and contacts. """
connections, message = connections_list()
if not connections:
LOGGER.critical(message)
self.set_html_content('PgMetadata', message)
return
if len(connections) > 1:
dialog = QInputDialog()
dialog.setComboBoxItems(connections)
dialog.setWindowTitle(tr("Database"))
dialog.setLabelText(tr("Choose the database to add the catalog"))
if not dialog.exec_():
return
connection_name = dialog.textValue()
else:
connection_name = connections[0]
metadata = QgsProviderRegistry.instance().providerMetadata('postgres')
connection = metadata.findConnection(connection_name)
locale = QgsSettings().value("locale/userLocale", QLocale().name())
locale = locale.split('_')[0].lower()
uri = QgsDataSourceUri(connection.uri())
uri.setTable(f'(SELECT * FROM pgmetadata.export_datasets_as_flat_table(\'{locale}\'))')
uri.setKeyColumn('uid')
layer = QgsVectorLayer(uri.uri(), '{} - {}'.format(tr("Catalog"), connection_name), 'postgres')
QgsProject.instance().addMapLayer(layer)
def initAlgorithm(self, config):
connections, _ = connections_list()
if connections:
connection_name = connections[0]
else:
connection_name = ''
label = tr("Connection to the PostgreSQL database")
tooltip = tr(
"The database where the schema '{}' is installed.").format(SCHEMA)
if Qgis.QGIS_VERSION_INT >= 31400:
param = QgsProcessingParameterProviderConnection(
self.CONNECTION_NAME,
label,
"postgres",
defaultValue=connection_name,
optional=False,
)
else:
param = QgsProcessingParameterString(
self.CONNECTION_NAME,
label,
defaultValue=connection_name,
optional=False,
)
param.setMetadata({
"widget_wrapper": {
"class":
"processing.gui.wrappers_postgis.ConnectionWidgetWrapper"
}
})
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
param = QgsProcessingParameterBoolean(
self.RUN_MIGRATIONS,
tr("Use this checkbox to upgrade."),
defaultValue=False,
)
tooltip = tr(
"For security reason, we ask that you explicitly use this checkbox."
)
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
self.addOutput(
QgsProcessingOutputString(self.DATABASE_VERSION,
tr("Database version")))
def initAlgorithm(self, config):
connections, _ = connections_list()
if connections:
connection_name = connections[0]
else:
connection_name = ''
label = tr("Connection to the PostgreSQL database")
tooltip = tr("The database where the schema '{}' will be installed.").format(SCHEMA)
if Qgis.QGIS_VERSION_INT >= 31400:
param = QgsProcessingParameterProviderConnection(
self.CONNECTION_NAME,
label,
"postgres",
defaultValue=connection_name,
optional=False,
)
else:
param = QgsProcessingParameterString(
self.CONNECTION_NAME,
label,
defaultValue=connection_name,
optional=False,
)
param.setMetadata(
{
"widget_wrapper": {
"class": "processing.gui.wrappers_postgis.ConnectionWidgetWrapper"
}
}
)
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
param = QgsProcessingParameterBoolean(
self.OVERRIDE,
tr("Erase the schema {} ?").format(SCHEMA),
defaultValue=False,
)
tooltip = tr("** Be careful ** This will remove data in the schema !")
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
self.addOutput(
QgsProcessingOutputString(self.DATABASE_VERSION, tr("Database version"))
)
def initAlgorithm(self, config):
connections, _ = connections_list()
if connections:
connection_name = connections[0]
else:
connection_name = ''
label = tr("Connection to the PostgreSQL database")
tooltip = tr("The database where the schema '{}' is installed.").format(SCHEMA)
if Qgis.QGIS_VERSION_INT >= 31400:
param = QgsProcessingParameterProviderConnection(
self.CONNECTION_NAME,
label,
"postgres",
defaultValue=connection_name,
optional=False,
)
else:
param = QgsProcessingParameterString(
self.CONNECTION_NAME,
label,
defaultValue=connection_name,
optional=False,
)
param.setMetadata(
{
"widget_wrapper": {
"class": "processing.gui.wrappers_postgis.ConnectionWidgetWrapper"
}
}
)
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
# target project file
param = QgsProcessingParameterFileDestination(
self.PROJECT_FILE,
tr('QGIS project file to create'),
defaultValue='',
optional=False,
fileFilter='QGS project (*.qgs)',
)
tooltip = tr("The destination file where to create the QGIS project.").format(SCHEMA)
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
def initAlgorithm(self, config):
connections, _ = connections_list()
if connections:
connection_name = connections[0]
else:
connection_name = ''
label = tr("Connection to the PostgreSQL database")
tooltip = tr("The database where the schema '{}' has been installed."
).format(SCHEMA)
if Qgis.QGIS_VERSION_INT >= 31400:
param = QgsProcessingParameterProviderConnection(
self.CONNECTION_NAME,
label,
"postgres",
defaultValue=connection_name,
optional=False,
)
else:
param = QgsProcessingParameterString(
self.CONNECTION_NAME,
label,
defaultValue=connection_name,
optional=False,
)
param.setMetadata({
"widget_wrapper": {
"class":
"processing.gui.wrappers_postgis.ConnectionWidgetWrapper"
}
})
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
param = QgsProcessingParameterBoolean(
self.RESET,
tr("Reset HTML templates"),
defaultValue=False,
)
tooltip = tr(
"** Be careful ** This will reset existing HTML templates !")
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
def fetchResults(self, search, context, feedback):
if len(search) < 3:
# Let's limit the number of request sent to the server
return
connections, message = connections_list()
if not connections:
self.logMessage(message, Qgis.Critical)
for connection in connections:
if not check_pgmetadata_is_installed(connection):
self.logMessage(
tr('PgMetadata is not installed on {}').format(connection),
Qgis.Critical)
continue
self.fetch_result_single_database(search, connection)
def initAlgorithm(self, config):
# Get existing connections
metadata = QgsProviderRegistry.instance().providerMetadata('postgres')
names = list(metadata.connections().keys())
existing_connections = []
for i, name in enumerate(names):
if name in connections_list()[0]:
existing_connections.append(i)
param = QgsProcessingParameterEnum(
self.DATABASES,
'List of databases to look for metadata',
options=names,
defaultValue=existing_connections,
)
param.setAllowMultiple(True)
tooltip = tr("PgMetadata can be installed on different databases.")
if Qgis.QGIS_VERSION_INT >= 31600:
param.setHelp(tooltip)
else:
param.tooltip_3liz = tooltip
self.addParameter(param)
def layer_changed(self, layer):
""" When the layer has changed in the legend, we must check this new layer. """
self.save_button.setEnabled(False)
self.current_datasource_uri = None
self.current_connection = None
if not settings_connections_names():
self.default_html_content_not_installed()
return
if not isinstance(layer, QgsVectorLayer):
self.default_html_content_not_pg_layer()
return
uri = layer.dataProvider().uri()
if not uri.schema() or not uri.table():
self.default_html_content_not_pg_layer()
return
connections, message = connections_list()
if not connections:
LOGGER.critical(message)
self.set_html_content('PgMetadata', message)
return
# TODO, find the correct connection to query according to the datasource
# The metadata HTML is wrong if there are many pgmetadata in different databases
for connection_name in connections:
connection = self.metadata.findConnection(connection_name)
if not connection:
LOGGER.critical("The global variable pgmetadata_connection_names is not correct.")
self.default_html_content_not_installed()
continue
if not check_pgmetadata_is_installed(connection_name):
LOGGER.critical(tr('PgMetadata is not installed on {}').format(connection_name))
continue
sql = self.sql_for_layer(uri, output_format=OutputFormats.HTML)
try:
data = connection.executeSql(sql)
except QgsProviderConnectionException as e:
LOGGER.critical(tr('Error when querying the database : ') + str(e))
self.default_html_content_not_installed()
return
if not data:
# Go to the next database
continue
if data[0] == NULL or data[0][0] == NULL:
continue
self.set_html_content(body=data[0][0])
self.save_button.setEnabled(True)
self.current_datasource_uri = uri
self.current_connection = connection
break
else:
origin = uri.database() if uri.database() else uri.service()
self.set_html_content(
'Missing metadata',
tr('The layer {origin} {schema}.{table} is missing metadata.').format(
origin=origin, schema=uri.schema(), table=uri.table())
)