pgadmin4/web/pgadmin/setup/db_upgrade.py

##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2024, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
##########################################################################

import os
import flask_migrate
from flask import g


def db_upgrade(app):
    from pgadmin.utils import u_encode, fs_encoding
    with app.app_context():
        migration_folder = os.path.join(
            os.path.dirname(os.path.realpath(u_encode(__file__, fs_encoding))),
            os.pardir, os.pardir,
            'migrations'
        )
        # Below line is a workaround to make Flask-Migrate>=4.0.6 work.
        g.x_arg = []
        flask_migrate.upgrade(migration_folder)
[Configuration][Migration] Use 'alembic' for migration of the SQLite based configuration file from one version to another, and also allows us to have a single path of creating the table instead of creating tables using SQLAlchemy or hand rolled SQL This allows us to run the migrations directly in the code, and it will avoid the error prone version numbering. Patched by: Sarah McAlear Revisions: Joao Pedro De Almeida Pereira, George Gelashvili. Reviewed by: Ashesh Vashi, Murtuza Zabuawala 2017-04-23 22:06:55 -05:00			`##########################################################################`
			`#`
			`# pgAdmin 4 - PostgreSQL Tools`
			`#`
Update copyright notices for 2024 2024-01-01 02:43:48 -06:00			`# Copyright (C) 2013 - 2024, The pgAdmin Development Team`
[Configuration][Migration] Use 'alembic' for migration of the SQLite based configuration file from one version to another, and also allows us to have a single path of creating the table instead of creating tables using SQLAlchemy or hand rolled SQL This allows us to run the migrations directly in the code, and it will avoid the error prone version numbering. Patched by: Sarah McAlear Revisions: Joao Pedro De Almeida Pereira, George Gelashvili. Reviewed by: Ashesh Vashi, Murtuza Zabuawala 2017-04-23 22:06:55 -05:00			`# This software is released under the PostgreSQL Licence`
			`#`
			`##########################################################################`

			`import os`
			`import flask_migrate`
Add a workaround in pgAdmin code to make Flask-Migrat>=4.0.6 work 2024-03-11 06:47:25 -05:00			`from flask import g`
[Configuration][Migration] Use 'alembic' for migration of the SQLite based configuration file from one version to another, and also allows us to have a single path of creating the table instead of creating tables using SQLAlchemy or hand rolled SQL This allows us to run the migrations directly in the code, and it will avoid the error prone version numbering. Patched by: Sarah McAlear Revisions: Joao Pedro De Almeida Pereira, George Gelashvili. Reviewed by: Ashesh Vashi, Murtuza Zabuawala 2017-04-23 22:06:55 -05:00

			`def db_upgrade(app):`
Fixed convention related issues reported by SonarQube. 2020-07-09 08:25:33 -05:00			`from pgadmin.utils import u_encode, fs_encoding`
[Configuration][Migration] Use 'alembic' for migration of the SQLite based configuration file from one version to another, and also allows us to have a single path of creating the table instead of creating tables using SQLAlchemy or hand rolled SQL This allows us to run the migrations directly in the code, and it will avoid the error prone version numbering. Patched by: Sarah McAlear Revisions: Joao Pedro De Almeida Pereira, George Gelashvili. Reviewed by: Ashesh Vashi, Murtuza Zabuawala 2017-04-23 22:06:55 -05:00			`with app.app_context():`
			`migration_folder = os.path.join(`
Fixed convention related issues reported by SonarQube. 2020-07-09 08:25:33 -05:00			`os.path.dirname(os.path.realpath(u_encode(__file__, fs_encoding))),`
Fix PEP8 issues in various modules. Fixes #3121 2018-02-19 05:12:35 -06:00			`os.pardir, os.pardir,`
Change the following to replace Python 2 code with Python 3: 1) Replace the deprecated unit test method. 2) Wraps filter usage in a list call. 3) Converts the old metaclass syntax to new. 4) Use range instead of xrange method. 5) Change Unicode to str. 6) Several other transformations. 7) Fixed change password test cases. 8) Use simplejson instead of plain JSON. 2020-08-31 06:15:31 -05:00			`'migrations'`
Fix PEP8 issues in various modules. Fixes #3121 2018-02-19 05:12:35 -06:00			`)`
Add a workaround in pgAdmin code to make Flask-Migrat>=4.0.6 work 2024-03-11 06:47:25 -05:00			`# Below line is a workaround to make Flask-Migrate>=4.0.6 work.`
			`g.x_arg = []`
[Configuration][Migration] Use 'alembic' for migration of the SQLite based configuration file from one version to another, and also allows us to have a single path of creating the table instead of creating tables using SQLAlchemy or hand rolled SQL This allows us to run the migrations directly in the code, and it will avoid the error prone version numbering. Patched by: Sarah McAlear Revisions: Joao Pedro De Almeida Pereira, George Gelashvili. Reviewed by: Ashesh Vashi, Murtuza Zabuawala 2017-04-23 22:06:55 -05:00			`flask_migrate.upgrade(migration_folder)`