Skip to content

docs: fix minor issues in profiles and manifests docs #4007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ianmcook wants to merge 4 commits into
base: main
Choose a base branch
from
+6 −3
Open

docs: fix minor issues in profiles and manifests docs #4007

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00cb619
docs: fix bulleted lists
ianmcook Feb 18, 2026
8ad0c6e
docs: add missing curly braces
ianmcook Feb 18, 2026
4ee4730
docs: fix typo in env var name
ianmcook Feb 18, 2026
fd2d228
docs: use xdg_config_home if set
ianmcook Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/source/format/connection_profiles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,11 @@ When using a profile name (not an absolute path), the driver manager searches fo
1. **Additional Search Paths** (if configured via ``AdbcDriverManagerDatabaseSetAdditionalSearchPathList()``)
2. **ADBC_PROFILE_PATH** environment variable (colon-separated on Unix, semicolon-separated on Windows)
3. **Conda Environment** (if built with Conda support and ``CONDA_PREFIX`` is set):

- ``$CONDA_PREFIX/etc/adbc/profiles/``

4. **User Configuration Directory**:

- Linux: ``~/.config/adbc/profiles/``
Copy link
Member Author

@ianmcook ianmcook Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zeroshade I notice that in the driver manifests docs, we mention XDG_CONFIG_HOME, but here in the connection profiles docs we don't.

Does the driver manager search behavior not work consistently w.r.t. XDG_CONFIG_HOME in both cases?

Copy link
Member

@zeroshade zeroshade Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the code, it should be consistent and I just forgot to mention the XDG_CONFIG_HOME here. So you can just update this appropriately to match

Copy link
Member Author

@ianmcook ianmcook Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in fd2d228

- macOS: ``~/Library/Application Support/ADBC/Profiles/``
- Windows: ``%LOCALAPPDATA%\ADBC\Profiles\``
Expand Down Expand Up @@ -433,7 +436,7 @@ Store credentials separately from code:

[options]
adbc.snowflake.sql.account = "mycompany"
adbc.snowflake.sql.auth_token = "env_var(SNOWFLAKE_TOKEN)"
adbc.snowflake.sql.auth_token = "{{ env_var(SNOWFLAKE_TOKEN) }}"

Then set ``SNOWFLAKE_TOKEN`` via environment variable, secrets manager, or configuration service.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/format/driver_manifests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ would happen for ODBC drivers. The search for a manifest on Windows would be the
* ``entrypoint`` - the entrypoint to use for the driver if a non-default entrypoint is needed
* ``driver`` - the path to the driver shared library

* If no registry key is found, then the directory ``%LOCAL_APPDATA%\ADBC\Drivers`` is searched
* If no registry key is found, then the directory ``%LOCALAPPDATA%\ADBC\Drivers`` is searched

#. If the ``LOAD_FLAG_SEARCH_SYSTEM`` load option is set, the driver manager will search for a system-level configuration

Expand Down
Loading