diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-09-17 18:15:42 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-09-24 23:13:46 -0400 |
commit | 5e7acf14a48e8ba1d57e460d686e89d49213e31b (patch) | |
tree | 7be7de147f2102c6068d84276757660f7dc67167 /lib/sqlalchemy/sql/schema.py | |
parent | 9e31cce582569dfe6fb33b33aadd43d70c2ae593 (diff) | |
download | sqlalchemy-5e7acf14a48e8ba1d57e460d686e89d49213e31b.tar.gz |
new docs WIP
This WIP is part of the final push for 1.4's docs
to fully "2.0-ize" what we can, and have it all ready.
So far this includes a rewrite of the 2.0 migration,
set up for the 1.4 /2.0 docs style, and a total redesign
of the index page using a new flex layout in zzzeeksphinx.
It also reworks some of the API reference sections
to have more subheaders. zzzeeksphinx is also enhanced
to provide automatic summaries for all api doc section.
Change-Id: I01d360cb9c8749520246b96ee6496143c6037918
Diffstat (limited to 'lib/sqlalchemy/sql/schema.py')
-rw-r--r-- | lib/sqlalchemy/sql/schema.py | 36 |
1 files changed, 16 insertions, 20 deletions
diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py index e9654fb1f..496f8d9fb 100644 --- a/lib/sqlalchemy/sql/schema.py +++ b/lib/sqlalchemy/sql/schema.py @@ -211,11 +211,12 @@ class Table(DialectKWArgs, SchemaItem, TableClause): objects that were explicitly specified. - .. versionchanged:: 1.0.0 setting the - :paramref:`_schema.Table.autoload_with` - parameter implies that :paramref:`_schema.Table.autoload` - will default - to True. + .. deprecated:: 1.4 + + The autoload parameter is deprecated and will be removed in + version 2.0. Please use the + :paramref:`_schema.Table`autoload_with` parameter, passing an + engine or connection. .. seealso:: @@ -251,18 +252,8 @@ class Table(DialectKWArgs, SchemaItem, TableClause): :func:`_sa.inspect` against one, with which this :class:`_schema.Table` object will be reflected. - When set to a non-None value, it implies that - :paramref:`_schema.Table.autoload` is ``True``. If left unset, but - :paramref:`_schema.Table.autoload` is explicitly set to ``True``, - an autoload - operation will attempt to proceed by locating an - :class:`_engine.Engine` or - :class:`_engine.Connection` bound to the underlying - :class:`_schema.MetaData` object. - - .. seealso:: - - :paramref:`_schema.Table.autoload` + When set to a non-None value, the autoload process will take place + for this table against the given engine or connection. :param extend_existing: When ``True``, indicates that if this :class:`_schema.Table` is already present in the given @@ -311,7 +302,6 @@ class Table(DialectKWArgs, SchemaItem, TableClause): Table("mytable", metadata, Column('y', Integer), extend_existing=True, - autoload=True, autoload_with=engine ) @@ -407,7 +397,7 @@ class Table(DialectKWArgs, SchemaItem, TableClause): t = Table( 'sometable', - autoload=True, + autoload_with=engine, listeners=[ ('column_reflect', listen_for_reflect) ]) @@ -488,7 +478,13 @@ class Table(DialectKWArgs, SchemaItem, TableClause): mustexist=( "1.4", "Deprecated alias of :paramref:`_schema.Table.must_exist`", - ) + ), + autoload=( + "2.0", + "The autoload parameter is deprecated and will be removed in " + "version 2.0. Please use the " + "autoload_with parameter, passing an engine or connection.", + ), ) def __new__(cls, *args, **kw): if not args: |