diff options
| author | mike bayer <mike_mp@zzzcomputing.com> | 2022-03-30 21:02:59 +0000 |
|---|---|---|
| committer | Gerrit Code Review <gerrit@ci3.zzzcomputing.com> | 2022-03-30 21:02:59 +0000 |
| commit | 12b67ae68309e715e3ab1b3d533f5a329dd5b6c6 (patch) | |
| tree | 9c7963ffd4a33cf51d8bab1f107063f207b9190e /lib | |
| parent | b7ca7ed1b1e9dc67e1c6498a838e03880ad5e8c6 (diff) | |
| parent | 8550d182a803bf6acca9a2729a008f0a505ddf21 (diff) | |
| download | sqlalchemy-12b67ae68309e715e3ab1b3d533f5a329dd5b6c6.tar.gz | |
Merge "Add links to database url section from URL docs" into main
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/sqlalchemy/engine/url.py | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/lib/sqlalchemy/engine/url.py b/lib/sqlalchemy/engine/url.py index 306989e0b..5558b397c 100644 --- a/lib/sqlalchemy/engine/url.py +++ b/lib/sqlalchemy/engine/url.py @@ -52,7 +52,7 @@ class URL(NamedTuple): format of the URL is an RFC-1738-style string. To create a new :class:`_engine.URL` object, use the - :func:`_engine.url.make_url` function. To construct a :class:`_engine.URL` + :func:`.make_url` function. To construct a :class:`_engine.URL` programmatically, use the :meth:`_engine.URL.create` constructor. .. versionchanged:: 1.4 @@ -66,6 +66,10 @@ class URL(NamedTuple): :class:`_engine.URL` object with modifications. See notes for this change at :ref:`change_5526`. + .. seealso:: + + :ref:`database_urls` + :class:`_engine.URL` contains the following attributes: * :attr:`_engine.URL.drivername`: database backend and driver name, such as @@ -109,6 +113,10 @@ class URL(NamedTuple): ) -> URL: """Create a new :class:`_engine.URL` object. + .. seealso:: + + :ref:`database_urls` + :param drivername: the name of the database backend. This name will correspond to a module in sqlalchemy/databases or a third party plug-in. @@ -773,6 +781,10 @@ def make_url(name_or_url: Union[str, URL]) -> URL: The given string is parsed according to the RFC 1738 spec. If an existing URL object is passed, just returns the object. + .. seealso:: + + :ref:`database_urls` + """ if isinstance(name_or_url, str): |
