From cb0abfc47bd4f9f2f4278cd6a23dd58ff2161d76 Mon Sep 17 00:00:00 2001 From: Phillip Cloud <417981+cpcloud@users.noreply.github.com> Date: Fri, 7 Jul 2023 06:03:17 -0400 Subject: [PATCH] chore(mysql): add kwargs docstring --- ibis/backends/mysql/__init__.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/ibis/backends/mysql/__init__.py b/ibis/backends/mysql/__init__.py index d653433f44ef..51015feb5a09 100644 --- a/ibis/backends/mysql/__init__.py +++ b/ibis/backends/mysql/__init__.py @@ -31,7 +31,7 @@ def do_connect( database: str | None = None, url: str | None = None, driver: Literal["pymysql"] = "pymysql", - **kwargs + **kwargs, ) -> None: """Create an Ibis client using the passed connection parameters. @@ -52,6 +52,10 @@ def do_connect( connection arguments are ignored. driver Python MySQL database driver + kwargs + Additional keyword arguments passed to `connect_args` in + `sqlalchemy.create_engine`. Use these to pass dialect specific + arguments. Examples -------- @@ -103,7 +107,9 @@ def do_connect( self.database_name = alchemy_url.database - engine = sa.create_engine(alchemy_url, poolclass=sa.pool.StaticPool, connect_args=kwargs) + engine = sa.create_engine( + alchemy_url, poolclass=sa.pool.StaticPool, connect_args=kwargs + ) @sa.event.listens_for(engine, "connect") def connect(dbapi_connection, connection_record):