Add DB API 2.0 connect parameters examples

mymarilyn · Oct 21, 2020 · 78cec4f · 78cec4f
1 parent a217f96
commit 78cec4f
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/clickhouse_driver/dbapi/__init__.py b/clickhouse_driver/dbapi/__init__.py
@@ -16,14 +16,14 @@ def connect(dsn=None, user=None, password=None, host=None, port=None,
     """
     Create a new database connection.
 
-    The connection parameters can be specified via DSN:
+    The connection can be specified via DSN:
 
-        ``conn = clickhouse_driver.connect("clickhouse://localhost/test")``
+        ``conn = connect("clickhouse://localhost/test?param1=value1&...")``
 
     or using database and credentials arguments:
 
-        ``conn = clickhouse_driver.connect(database="test", user="default",
-        password="default", host="localhost")``
+        ``conn = connect(database="test", user="default", password="default",
+        host="localhost", **kwargs)``
 
     The basic connection parameters are: