summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/create.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2021-02-14 14:36:27 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2021-02-14 14:36:27 -0500
commitf6188d31998321a857078d6a61672aae1f98e312 (patch)
treeae236ed8f17c7e89b010c2bdf16c4ff255a12266 /lib/sqlalchemy/engine/create.py
parent996a8ca9bbf0cb9c9caea7926bc160d0c1fd7648 (diff)
downloadsqlalchemy-f6188d31998321a857078d6a61672aae1f98e312.tar.gz
Add emphasis to URL documentation re: URL encoding
Fixes: #5715 Change-Id: I2ac16541d34f49b25070e00c43596bcd71aff72d
Diffstat (limited to 'lib/sqlalchemy/engine/create.py')
-rw-r--r--lib/sqlalchemy/engine/create.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/sqlalchemy/engine/create.py b/lib/sqlalchemy/engine/create.py
index dd732a09a..381e0879d 100644
--- a/lib/sqlalchemy/engine/create.py
+++ b/lib/sqlalchemy/engine/create.py
@@ -45,13 +45,18 @@ from ..sql import compiler
def create_engine(url, **kwargs):
"""Create a new :class:`_engine.Engine` instance.
- The standard calling form is to send the URL as the
+ The standard calling form is to send the :ref:`URL <database_urls>` as the
first positional argument, usually a string
that indicates database dialect and connection arguments::
-
engine = create_engine("postgresql://scott:tiger@localhost/test")
+ .. note::
+
+ Please review :ref:`database_urls` for general guidelines in composing
+ URL strings. In particular, special characters, such as those often
+ part of passwords, must be URL encoded to be properly parsed.
+
Additional keyword arguments may then follow it which
establish various options on the resulting :class:`_engine.Engine`
and its underlying :class:`.Dialect` and :class:`_pool.Pool`