lidavidm commented on code in PR #1030: URL: https://github.com/apache/arrow-adbc/pull/1030#discussion_r1313330853
########## docs/source/driver/snowflake.rst: ########## @@ -165,7 +165,59 @@ password can be provided in the URI or via the ``username`` and ``password`` options to the :cpp:class:`AdbcDatabase`. Alternately, other types of authentication can be specified and customized. -See "Client Options" below. +See "Client Options" below for details on all the options. + +SSO Authentication +~~~~~~~~~~~~~~~~~~ + +Snowflake supports `single sign-on +<https://docs.snowflake.com/en/user-guide/admin-security-fed-auth-overview>`_. +If your account has been configured with SSO, it can be used with the +Snowflake driver by setting the following options when constructing the +:cpp:class:`AdbcDatabase`: + +- ``adbc.snowflake.sql.account``: your Snowflake account. (For example, if + you log in to ``https://foobar.snowflakecomputing.com``, then your account + identifier is ``foobar``.) +- ``adbc.snowflake.sql.auth_type``: ``auth_ext_browser``. +- ``username``: your username. (This should probably be your email, + e.g. ``[email protected]``.) + +A new browser tab or window should appear where you can continue the login. +Once this is complete, you will have a complete ADBC database/connection +object. Some users have reported needing other configuration options, such as +``adbc.snowflake.sql.region`` and ``adbc.snowflake.sql.uri.*`` (see below for +a listing). + +.. tab-set:: + + .. tab-item:: Python + :sync: python + + .. code-block:: python + + import adbc_driver_snowflake.dbapi + # This will open a new browser tab, and block until you log in. + adbc_driver_snowflake.dbapi.connect(db_kwargs={ + "adbc.snowflake.sql.account": "foobar", + "adbc.snowflake.sql.auth_type": "auth_ext_browser", + "username": "[email protected]", + }) + + .. tab-item:: R + :sync: r + + .. code-block:: r Review Comment: ```suggestion .. code-block:: r ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
