mirror of
https://gitlab.com/SIGBUS/nyaa.git
synced 2024-12-22 19:30:00 +00:00
Add flask-Migrate + alembic for automated database migrations.
Update some dependencies to their latest version. Make executable scripts executable (chmod +x).
This commit is contained in:
parent
740be1a40a
commit
152e547ac5
|
@ -78,6 +78,12 @@
|
||||||
- Set up `sync_es.py` as a service and run it, preferably as the system/root
|
- Set up `sync_es.py` as a service and run it, preferably as the system/root
|
||||||
- Make sure `sync_es.py` runs within venv with the right dependencies
|
- Make sure `sync_es.py` runs within venv with the right dependencies
|
||||||
|
|
||||||
|
## Database migrations
|
||||||
|
- Uses [flask-Migrate](https://flask-migrate.readthedocs.io/)
|
||||||
|
- Run `./db_migrate.py db migrate` to generate the migration script after database model changes.
|
||||||
|
- Take a look at the result in `migrations/versions/...` to make sure nothing went wrong.
|
||||||
|
- Run `./db_migrate.py db upgrade` to upgrade your database.
|
||||||
|
|
||||||
## Good to go!
|
## Good to go!
|
||||||
- After that, enable the `USE_ELASTIC_SEARCH` flag and restart the webapp and you're good to go
|
- After that, enable the `USE_ELASTIC_SEARCH` flag and restart the webapp and you're good to go
|
||||||
|
|
||||||
|
|
6
db_create.py
Normal file → Executable file
6
db_create.py
Normal file → Executable file
|
@ -33,9 +33,3 @@ if not existing_cats:
|
||||||
db.session.add(main_cat)
|
db.session.add(main_cat)
|
||||||
|
|
||||||
db.session.commit()
|
db.session.commit()
|
||||||
|
|
||||||
# Create fulltext index
|
|
||||||
|
|
||||||
if app.config['USE_MYSQL']:
|
|
||||||
db.engine.execute('ALTER TABLE ' + app.config['TABLE_PREFIX'] + 'torrents ADD FULLTEXT KEY (display_name)')
|
|
||||||
|
|
||||||
|
|
13
db_migrate.py
Executable file
13
db_migrate.py
Executable file
|
@ -0,0 +1,13 @@
|
||||||
|
#!/usr/bin/python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
from nyaa import app, db
|
||||||
|
from flask_script import Manager
|
||||||
|
from flask_migrate import Migrate, MigrateCommand
|
||||||
|
|
||||||
|
migrate = Migrate(app, db)
|
||||||
|
|
||||||
|
manager = Manager(app)
|
||||||
|
manager.add_command("db", MigrateCommand)
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
manager.run()
|
0
import_to_es.py
Normal file → Executable file
0
import_to_es.py
Normal file → Executable file
1
migrations/README
Executable file
1
migrations/README
Executable file
|
@ -0,0 +1 @@
|
||||||
|
Generic single-database configuration.
|
45
migrations/alembic.ini
Normal file
45
migrations/alembic.ini
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
# A generic, single database configuration.
|
||||||
|
|
||||||
|
[alembic]
|
||||||
|
# template used to generate migration files
|
||||||
|
# file_template = %%(rev)s_%%(slug)s
|
||||||
|
|
||||||
|
# set to 'true' to run the environment during
|
||||||
|
# the 'revision' command, regardless of autogenerate
|
||||||
|
# revision_environment = false
|
||||||
|
|
||||||
|
|
||||||
|
# Logging configuration
|
||||||
|
[loggers]
|
||||||
|
keys = root,sqlalchemy,alembic
|
||||||
|
|
||||||
|
[handlers]
|
||||||
|
keys = console
|
||||||
|
|
||||||
|
[formatters]
|
||||||
|
keys = generic
|
||||||
|
|
||||||
|
[logger_root]
|
||||||
|
level = WARN
|
||||||
|
handlers = console
|
||||||
|
qualname =
|
||||||
|
|
||||||
|
[logger_sqlalchemy]
|
||||||
|
level = WARN
|
||||||
|
handlers =
|
||||||
|
qualname = sqlalchemy.engine
|
||||||
|
|
||||||
|
[logger_alembic]
|
||||||
|
level = INFO
|
||||||
|
handlers =
|
||||||
|
qualname = alembic
|
||||||
|
|
||||||
|
[handler_console]
|
||||||
|
class = StreamHandler
|
||||||
|
args = (sys.stderr,)
|
||||||
|
level = NOTSET
|
||||||
|
formatter = generic
|
||||||
|
|
||||||
|
[formatter_generic]
|
||||||
|
format = %(levelname)-5.5s [%(name)s] %(message)s
|
||||||
|
datefmt = %H:%M:%S
|
87
migrations/env.py
Executable file
87
migrations/env.py
Executable file
|
@ -0,0 +1,87 @@
|
||||||
|
from __future__ import with_statement
|
||||||
|
from alembic import context
|
||||||
|
from sqlalchemy import engine_from_config, pool
|
||||||
|
from logging.config import fileConfig
|
||||||
|
import logging
|
||||||
|
|
||||||
|
# this is the Alembic Config object, which provides
|
||||||
|
# access to the values within the .ini file in use.
|
||||||
|
config = context.config
|
||||||
|
|
||||||
|
# Interpret the config file for Python logging.
|
||||||
|
# This line sets up loggers basically.
|
||||||
|
fileConfig(config.config_file_name)
|
||||||
|
logger = logging.getLogger('alembic.env')
|
||||||
|
|
||||||
|
# add your model's MetaData object here
|
||||||
|
# for 'autogenerate' support
|
||||||
|
# from myapp import mymodel
|
||||||
|
# target_metadata = mymodel.Base.metadata
|
||||||
|
from flask import current_app
|
||||||
|
config.set_main_option('sqlalchemy.url',
|
||||||
|
current_app.config.get('SQLALCHEMY_DATABASE_URI'))
|
||||||
|
target_metadata = current_app.extensions['migrate'].db.metadata
|
||||||
|
|
||||||
|
# other values from the config, defined by the needs of env.py,
|
||||||
|
# can be acquired:
|
||||||
|
# my_important_option = config.get_main_option("my_important_option")
|
||||||
|
# ... etc.
|
||||||
|
|
||||||
|
|
||||||
|
def run_migrations_offline():
|
||||||
|
"""Run migrations in 'offline' mode.
|
||||||
|
|
||||||
|
This configures the context with just a URL
|
||||||
|
and not an Engine, though an Engine is acceptable
|
||||||
|
here as well. By skipping the Engine creation
|
||||||
|
we don't even need a DBAPI to be available.
|
||||||
|
|
||||||
|
Calls to context.execute() here emit the given string to the
|
||||||
|
script output.
|
||||||
|
|
||||||
|
"""
|
||||||
|
url = config.get_main_option("sqlalchemy.url")
|
||||||
|
context.configure(url=url)
|
||||||
|
|
||||||
|
with context.begin_transaction():
|
||||||
|
context.run_migrations()
|
||||||
|
|
||||||
|
|
||||||
|
def run_migrations_online():
|
||||||
|
"""Run migrations in 'online' mode.
|
||||||
|
|
||||||
|
In this scenario we need to create an Engine
|
||||||
|
and associate a connection with the context.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# this callback is used to prevent an auto-migration from being generated
|
||||||
|
# when there are no changes to the schema
|
||||||
|
# reference: http://alembic.readthedocs.org/en/latest/cookbook.html
|
||||||
|
def process_revision_directives(context, revision, directives):
|
||||||
|
if getattr(config.cmd_opts, 'autogenerate', False):
|
||||||
|
script = directives[0]
|
||||||
|
if script.upgrade_ops.is_empty():
|
||||||
|
directives[:] = []
|
||||||
|
logger.info('No changes in schema detected.')
|
||||||
|
|
||||||
|
engine = engine_from_config(config.get_section(config.config_ini_section),
|
||||||
|
prefix='sqlalchemy.',
|
||||||
|
poolclass=pool.NullPool)
|
||||||
|
|
||||||
|
connection = engine.connect()
|
||||||
|
context.configure(connection=connection,
|
||||||
|
target_metadata=target_metadata,
|
||||||
|
process_revision_directives=process_revision_directives,
|
||||||
|
**current_app.extensions['migrate'].configure_args)
|
||||||
|
|
||||||
|
try:
|
||||||
|
with context.begin_transaction():
|
||||||
|
context.run_migrations()
|
||||||
|
finally:
|
||||||
|
connection.close()
|
||||||
|
|
||||||
|
if context.is_offline_mode():
|
||||||
|
run_migrations_offline()
|
||||||
|
else:
|
||||||
|
run_migrations_online()
|
24
migrations/script.py.mako
Executable file
24
migrations/script.py.mako
Executable file
|
@ -0,0 +1,24 @@
|
||||||
|
"""${message}
|
||||||
|
|
||||||
|
Revision ID: ${up_revision}
|
||||||
|
Revises: ${down_revision | comma,n}
|
||||||
|
Create Date: ${create_date}
|
||||||
|
|
||||||
|
"""
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
${imports if imports else ""}
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision = ${repr(up_revision)}
|
||||||
|
down_revision = ${repr(down_revision)}
|
||||||
|
branch_labels = ${repr(branch_labels)}
|
||||||
|
depends_on = ${repr(depends_on)}
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade():
|
||||||
|
${upgrades if upgrades else "pass"}
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade():
|
||||||
|
${downgrades if downgrades else "pass"}
|
|
@ -1,3 +1,4 @@
|
||||||
|
alembic==0.9.2
|
||||||
appdirs==1.4.3
|
appdirs==1.4.3
|
||||||
argon2-cffi==16.3.0
|
argon2-cffi==16.3.0
|
||||||
autopep8==1.3.1
|
autopep8==1.3.1
|
||||||
|
@ -5,9 +6,14 @@ blinker==1.4
|
||||||
cffi==1.10.0
|
cffi==1.10.0
|
||||||
click==6.7
|
click==6.7
|
||||||
dominate==2.3.1
|
dominate==2.3.1
|
||||||
Flask==0.12.1
|
elasticsearch==5.3.0
|
||||||
|
elasticsearch-dsl==5.2.0
|
||||||
|
Flask==0.12.2
|
||||||
Flask-Assets==0.12
|
Flask-Assets==0.12
|
||||||
Flask-DebugToolbar==0.10.1
|
Flask-DebugToolbar==0.10.1
|
||||||
|
Flask-Migrate==2.0.3
|
||||||
|
flask-paginate==0.4.5
|
||||||
|
Flask-Script==2.0.5
|
||||||
Flask-SQLAlchemy==2.2
|
Flask-SQLAlchemy==2.2
|
||||||
Flask-WTF==0.14.2
|
Flask-WTF==0.14.2
|
||||||
gevent==1.2.1
|
gevent==1.2.1
|
||||||
|
@ -15,27 +21,29 @@ greenlet==0.4.12
|
||||||
itsdangerous==0.24
|
itsdangerous==0.24
|
||||||
Jinja2==2.9.6
|
Jinja2==2.9.6
|
||||||
libsass==0.12.3
|
libsass==0.12.3
|
||||||
|
Mako==1.0.6
|
||||||
MarkupSafe==1.0
|
MarkupSafe==1.0
|
||||||
|
mysql-replication==0.13
|
||||||
mysqlclient==1.3.10
|
mysqlclient==1.3.10
|
||||||
orderedset==2.0
|
orderedset==2.0
|
||||||
packaging==16.8
|
packaging==16.8
|
||||||
passlib==1.7.1
|
passlib==1.7.1
|
||||||
|
progressbar2==3.20.0
|
||||||
pycodestyle==2.3.1
|
pycodestyle==2.3.1
|
||||||
pycparser==2.17
|
pycparser==2.17
|
||||||
|
PyMySQL==0.7.11
|
||||||
pyparsing==2.2.0
|
pyparsing==2.2.0
|
||||||
|
python-dateutil==2.6.0
|
||||||
|
python-editor==1.0.3
|
||||||
|
python-utils==2.1.0
|
||||||
six==1.10.0
|
six==1.10.0
|
||||||
SQLAlchemy==1.1.9
|
SQLAlchemy==1.1.10
|
||||||
SQLAlchemy-FullText-Search==0.2.3
|
SQLAlchemy-FullText-Search==0.2.3
|
||||||
SQLAlchemy-Utils==0.32.14
|
SQLAlchemy-Utils==0.32.14
|
||||||
|
statsd==3.2.1
|
||||||
|
urllib3==1.21.1
|
||||||
uWSGI==2.0.15
|
uWSGI==2.0.15
|
||||||
visitor==0.1.3
|
visitor==0.1.3
|
||||||
webassets==0.12.1
|
webassets==0.12.1
|
||||||
Werkzeug==0.12.1
|
Werkzeug==0.12.2
|
||||||
WTForms==2.1
|
WTForms==2.1
|
||||||
## elasticsearch dependencies
|
|
||||||
elasticsearch==5.3.0
|
|
||||||
elasticsearch-dsl==5.2.0
|
|
||||||
progressbar2==3.20.0
|
|
||||||
mysql-replication==0.13
|
|
||||||
flask-paginate==0.4.5
|
|
||||||
statsd==3.2.1
|
|
||||||
|
|
0
sync_es.py
Normal file → Executable file
0
sync_es.py
Normal file → Executable file
Loading…
Reference in a new issue