Using environtment variables inide .ini file #1149
-
|
Hi There! I have 3 files in the root directory alembic.ini env.py .env When I changed url to But when running migrations got What Im doing wrong? |
Beta Was this translation helpful? Give feedback.
Replies: 6 comments 12 replies
-
|
sqlalchemy.url = f"postgresql://{DB_USER}:{DB_PASS}@{DB_HOST}/{DB_NAME}" |
Beta Was this translation helpful? Give feedback.
-
|
Try this
and got
|
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
oh this is in your config file, sorry, was not clear |
Beta Was this translation helpful? Give feedback.
-
|
without the $ same result Also try this form And got
|
Beta Was this translation helpful? Give feedback.
-
|
if you want to set keys in a config that can be re-used, you need to use config_args and these are then referenced as config = context.config
config.config_args.update({
"DB_USER": os.getenv("DB_USER"),
"DB_PASS": os.getenv("DB_PASS"),
"DB_HOST": os.getenv("DB_HOST"),
"DB_NAME": os.getenv("DB_NAME")
})config file: |
Beta Was this translation helpful? Give feedback.
-
|
My goal is to make the After So my current config alembic.ini env.py |
Beta Was this translation helpful? Give feedback.
-
|
config is already consumed by the time you get to env.py so you would need to build a custom frontend to alembic to achieve this (NOTE: this is not the correct way to do this use case overall, see next answer coming up) import os
from alembic.config import CommandLine, Config
class MyCommandLine(CommandLine):
def main(self, argv=None):
options = self.parser.parse_args(argv)
if not hasattr(options, "cmd"):
self.parser.error("too few arguments")
else:
cfg = Config(
file_=options.config,
ini_section=options.name,
cmd_opts=options,
config_args={ # type: ignore # note there's a typing error in alembic
"DB_USER": os.getenv("DB_USER", ""),
"DB_PASS": os.getenv("DB_PASS", ""),
"DB_HOST": os.getenv("DB_HOST", ""),
"DB_NAME": os.getenv("DB_NAME", "")
}
)
self.run_cmd(cfg, options)
if __name__ == "__main__":
MyCommandLine().main() |
Beta Was this translation helpful? Give feedback.
-
|
The correct way to do this pattern is to construct the URL inside of env.py this is tested and works def run_migrations_online() -> None:
from sqlalchemy import create_engine
import re
import os
url_tokens = {
"DB_USER": os.getenv("DB_USER", ""),
"DB_PASS": os.getenv("DB_PASS", ""),
"DB_HOST": os.getenv("DB_HOST", ""),
"DB_NAME": os.getenv("DB_NAME", "")
}
url = config.get_main_option("sqlalchemy.url")
url = re.sub(r"\${(.+?)}", lambda m: url_tokens[m.group(1)], url)
connectable = create_engine(url)
with connectable.connect() as connection:
context.configure(
connection=connection, target_metadata=target_metadata,
compare_type=True,
compare_server_default=True,
)
with context.begin_transaction():
context.run_migrations()config file: |
Beta Was this translation helpful? Give feedback.
-
|
@Lepiloff can you mark this question as "answered" so that others (like me, as an example) who stumbled across this thread through a Google Search can find the solution quickly? This little help would be much appreciated. |
Beta Was this translation helpful? Give feedback.
-
|
Marked |
Beta Was this translation helpful? Give feedback.
-
|
I guess this would be the same if I leave the .ini file as it is by default and then, use a way to construct the URL using environment variables in the env.py file? Like this: def get_url():
"""Generate a URL from the environment variables.
"""
return "postgresql://%s:%s@%s:%s/%s" % (
os.environ["POSTGRES_USER"],
os.environ["POSTGRES_PASSWORD"],
os.environ["POSTGRES_HOST"],
os.environ["POSTGRES_PORT"],
os.environ["POSTGRES_DB"],
)
def run_migrations_offline() -> None:
"""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 = get_url()
context.configure(
url=url,
target_metadata=target_metadata,
literal_binds=True,
dialect_opts={"paramstyle": "named"},
)
with context.begin_transaction():
context.run_migrations()
def run_migrations_online() -> None:
"""Run migrations in 'online' mode.
In this scenario we need to create an Engine
and associate a connection with the context.
"""
url = get_url()
connectable = create_engine(url)
with connectable.connect() as connection:
context.configure(
connection=connection, target_metadata=target_metadata,
ompare_type=True,
compare_server_default=True,
)
with context.begin_transaction():
context.run_migrations()
if context.is_offline_mode():
run_migrations_offline()
else:
run_migrations_online() |
Beta Was this translation helpful? Give feedback.
-
|
Sure, you can remove the url from the ini file and obtain it in some other way |
Beta Was this translation helpful? Give feedback.
-
|
Thank you for your quick help! |
Beta Was this translation helpful? Give feedback.
-
|
this is in my alembic.py sqlalchemy.url = ${db_uri} this is in my .env this is my env.py file from logging.config import fileConfig
from sqlalchemy import engine_from_config
from sqlalchemy import pool
import os
import re
from dotenv import load_dotenv
from alembic import context
# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config
load_dotenv()
db_uri = os.environ.get("DATABASE_URI")
print(f"Database URI: {db_uri}")
# Interpret the config file for Python logging.
# This line sets up loggers basically.
if config.config_file_name is not None:
fileConfig(config.config_file_name)
# add your model's MetaData object here
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
target_metadata = None
# 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() -> None:
"""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")
# url = db_uri
context.configure(
url=url,
target_metadata=target_metadata,
literal_binds=True,
dialect_opts={"paramstyle": "named"},
)
with context.begin_transaction():
context.run_migrations()
def run_migrations_online() -> None:
"""Run migrations in 'online' mode.
In this scenario we need to create an Engine
and associate a connection with the context.
"""
connectable = engine_from_config(
config.get_section(config.config_ini_section, {}),
prefix="sqlalchemy.",
poolclass=pool.NullPool,
)
with connectable.connect() as connection:
context.configure(
connection=connection, target_metadata=target_metadata
)
with context.begin_transaction():
context.run_migrations()
if context.is_offline_mode():
run_migrations_offline()
else:
run_migrations_online()it is not wokring |
Beta Was this translation helpful? Give feedback.
-
|
This solution is not working for the async engine. |
Beta Was this translation helpful? Give feedback.
-
|
You can't blindly copy a sync env end expect it to work using asyncio. |
Beta Was this translation helpful? Give feedback.
-
|
I just solved the issue. See the code below. It is working successfully. |
Beta Was this translation helpful? Give feedback.
The correct way to do this pattern is to construct the URL inside of env.py
this is tested and works