lidavidm commented on code in PR #3876: URL: https://github.com/apache/arrow-adbc/pull/3876#discussion_r2696847478
########## docs/source/format/connection_profiles.rst: ########## @@ -0,0 +1,568 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + +================================== +Driver Manager Connection Profiles +================================== + +Overview +======== + +Similar to ODBC's ``odbc.ini``, the ADBC driver manager supports **connection profiles** +that specify a driver and connection options in a reusable configuration. This allows users to: + +- Define connection information in files or environment variables +- Share connection configurations across applications +- Distribute standardized connection settings +- Avoid hardcoding driver names and credentials in application code + +Profiles are loaded during ``AdbcDatabaseInit()`` before initializing the driver. Options +from the profile are applied automatically but do not override options already set via ``AdbcDatabaseSetOption()``. + +Quick Start +=========== + +Using a Profile via URI +----------------------- + +The simplest way to use a profile is through a URI: + +.. code-block:: c + + AdbcDatabase database; + AdbcDatabaseNew(&database, &error); + AdbcDatabaseSetOption(&database, "uri", "profile://my_snowflake_prod", &error); + AdbcDatabaseInit(&database, &error); + +Using a Profile via Option +--------------------------- + +Alternatively, specify the profile name directly: + +.. code-block:: c + + AdbcDatabase database; + AdbcDatabaseNew(&database, &error); + AdbcDatabaseSetOption(&database, "profile", "my_snowflake_prod", &error); Review Comment: Maybe the docstring for AdbcDatabaseSetOption in adbc.h is best. -- 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]
