summaryrefslogtreecommitdiff
path: root/alembic/context.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2011-11-08 12:16:31 -0800
committerMike Bayer <mike_mp@zzzcomputing.com>2011-11-08 12:16:31 -0800
commit0ed98936b1a30f8b2392bc7f3e87fe70b2d4e4c0 (patch)
tree5e61b309d310644b07b38191900cdf69a87c5094 /alembic/context.py
parenteb9a15c382c20fde5b358219897a08373db1796f (diff)
downloadalembic-0ed98936b1a30f8b2392bc7f3e87fe70b2d4e4c0.tar.gz
docs
Diffstat (limited to 'alembic/context.py')
-rw-r--r--alembic/context.py30
1 files changed, 23 insertions, 7 deletions
diff --git a/alembic/context.py b/alembic/context.py
index 0b33a9e..bdb67fb 100644
--- a/alembic/context.py
+++ b/alembic/context.py
@@ -132,22 +132,22 @@ class DefaultContext(object):
return self.connection
def alter_column(self, table_name, column_name,
- nullable=util.NO_VALUE,
- server_default=util.NO_VALUE,
- name=util.NO_VALUE,
- type_=util.NO_VALUE,
+ nullable=None,
+ server_default=False,
+ name=None,
+ type_=None,
schema=None,
):
- if nullable is not util.NO_VALUE:
+ if nullable is not None:
self._exec(base.ColumnNullable(table_name, column_name,
nullable, schema=schema))
- if server_default is not util.NO_VALUE:
+ if server_default is not False:
self._exec(base.ColumnDefault(
table_name, column_name, server_default,
schema=schema
))
- if type_ is not util.NO_VALUE:
+ if type_ is not None:
self._exec(base.ColumnType(
table_name, column_name, type_, schema=schema
))
@@ -187,11 +187,27 @@ def _render_literal_bindparam(element, compiler, **kw):
return compiler.render_literal_bindparam(element, **kw)
def opts(cfg, **kw):
+ """Set up options that will be used by the :func:`.configure_connection`
+ function.
+
+ This basically sets some global variables.
+
+ """
global _context_opts, config
_context_opts = kw
config = cfg
def configure_connection(connection):
+ """Configure the migration environment against a specific
+ database connection, an instance of :class:`sqlalchemy.engine.Connection`.
+
+ This function is typically called from the ``env.py``
+ script within a migration environment. It can be called
+ multiple times for an invocation. The most recent :class:`~sqlalchemy.engine.Connection`
+ for which it was called is the one that will be operated upon
+ by the next call to :func:`.run_migrations`.
+
+ """
global _context
from alembic.ddl import base
_context = _context_impls.get(