-
Notifications
You must be signed in to change notification settings - Fork 8
docs: document auth command, private drivers #263
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.
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
Merged
+290
−3
Merged
Changes from all commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
87b07b4
Update .gitignore
amoeba d14f97b
Add since-version badge
amoeba 5471686
add auth command to cli docs
amoeba 444959f
add note in finding drivers about auth
amoeba fc66ed6
add private drivers guide
amoeba eb7292b
fix typo in macros.py docstring and broken link in finding_drivers.md
amoeba 2d193cc
Update docs/guides/private_drivers.md
amoeba fcd6ade
Update docs/guides/private_drivers.md
amoeba 6c0df8c
Update docs/guides/private_drivers.md
amoeba 66a0f04
Update docs/guides/private_drivers.md
amoeba d79ac95
Update docs/guides/private_drivers.md
amoeba 9d3c1a4
Update docs/guides/finding_drivers.md
amoeba ebe0c51
Update docs/guides/private_drivers.md
amoeba 1b917ed
Update private_drivers.md
amoeba 8e4e304
rework private drivers
amoeba 7da9fc2
Update cli.md
amoeba b0029cd
Update cli.md
amoeba 1e166b9
Update private_drivers.md
amoeba 634d171
Update driver_registry.md
amoeba 86e3726
boop
amoeba 631b2f5
Update private_drivers.md
amoeba ce3a55e
Update private_drivers.md
amoeba 9c948d6
Update private_drivers.md
amoeba a486219
Add note about purge
amoeba 6a82908
Add API keys section
amoeba 93f1845
Update docs/guides/private_drivers.md
amoeba 59448ea
proforead
amoeba 0440ac7
Update cli.md
amoeba 57f12af
add note about account
amoeba 7d527b4
Fix broken link
ianmcook df1a6da
Add warning about purge
amoeba f0b1c2a
Update docs/reference/cli.md
amoeba 7a7d7af
Don't highlight shell built-ins
amoeba 9c6797e
Update pixi.lock
amoeba File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,3 +47,5 @@ cdn-dev | |
|
|
||
| .venv | ||
| .claude | ||
|
|
||
| __pycache__ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <!-- | ||
| Copyright 2026 Columnar Technologies Inc. | ||
|
|
||
| Licensed 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. | ||
| --> | ||
|
|
||
| # Private Drivers | ||
|
|
||
| {{ since_version('v0.2.0') }} | ||
ianmcook marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Most drivers available with dbc are hosted on Columnar's public [driver registry](../concepts/driver_registry.md). However, some of the drivers you see when you run `dbc search` may be marked with a `[private]` label. | ||
|
|
||
| To install and use these drivers, you must: | ||
|
|
||
| 1. Log in to [Columnar Cloud](https://cloud.columnar.tech) with dbc | ||
| 2. Start a trial license | ||
|
|
||
| Continue reading to learn how to log in and start a trial. | ||
|
|
||
| ## Logging In | ||
|
|
||
| To log into Columnar's private driver registry, run `dbc auth login`. This will automatically create an account for you the first time you log in. | ||
|
|
||
| You will see the following in your terminal and your default web browser will be opened: | ||
|
|
||
| ```console | ||
| $ dbc auth login | ||
| Opening https://auth.columnar.tech/activate?user_code=XXXX-XXXX in your default web browser... | ||
| ⠏ Waiting for confirmation... | ||
| ``` | ||
|
|
||
| In your browser, you will see a **Device Confirmation** prompt and, once you click **Confirm**, you will be redirected to log in with the provider of your choice. Once you log in, you will be redirected to [Columnar Cloud](https://cloud.columnar.tech/). Keep the tab open and continue on to the next step. | ||
|
|
||
| ## Starting a Trial | ||
|
|
||
| To install and use a private driver, you must start a trial and obtain a license. This is a separate step from logging in. | ||
|
|
||
| Licenses can be obtained from your [Account](https://cloud.columnar.tech/account) page on Columnar Cloud by clicking **Start Free 14-Day Trial**. Follow any instructions in the dialog that opens up and click **Accept** to create your license. | ||
|
|
||
| ### Downloading Your License | ||
|
|
||
| dbc will automatically download your license if you: | ||
|
|
||
| 1. Have an active license | ||
| 2. Run `dbc install` with a private driver | ||
|
|
||
| If you'd prefer to download the license manually, you can click **Download License File** and place the downloaded file in the appropriate location for your operating system: | ||
|
|
||
| - Windows: `%LocalAppData%/dbc/credentials` | ||
| - macOS: `~/Library/Application Support/Columnar/dbc/credentials` | ||
| - Linux: `~/.local/share/dbc/credentials` | ||
|
|
||
| You may also use a custom location by setting the environment variable `XDG_DATA_HOME` to an absolute path of your choosing. If you do this, you must ensure you set the same value of `XDG_DATA_HOME` when loading drivers with the [driver manager](../concepts/driver_manager.md) for the drivers to find your license. | ||
|
|
||
| ## Logging Out | ||
|
|
||
| To log out, run `dbc auth logout`. | ||
|
|
||
| By default, the `logout` command doesn't purge any driver licenses from your system and only removes your login credentials. If you wish remove the local copy of your license run: | ||
|
|
||
| ```console | ||
| $ dbc auth logout --purge | ||
| ``` | ||
|
|
||
| !!! note | ||
|
|
||
| Note that this command only removes the local copy of your license and does not cancel any active licenses you may have in your [Columnar Cloud](https://cloud.columnar.tech) account. | ||
|
|
||
| !!! warning | ||
|
|
||
| ADBC drivers that require a license (i.e., private drivers) will stop working after you run this command. You can re-download your license with `dbc auth login`. See [Downloading Your License](#downloading-your-license). | ||
|
|
||
|
|
||
| ## API Keys | ||
|
|
||
| dbc also supports logging in to private driver registries via API key. This is primarily intended for use in [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) systems or any system where logging in with a web browser is not possible. | ||
|
|
||
| To create an API key, open a web browser to your [API keys](https://cloud.columnar.tech/apikeys) page. | ||
|
|
||
| !!! note inline end | ||
|
|
||
| If you've already created an API key, you will see a **Create API Key** button instead. | ||
|
|
||
| If you haven't created any API keys before, you will see a **Create Your First API Key** button. After clicking it, enter a name, optionally choose an expiration, and click **Create**. On the following screen, you will see your new API key and instructions to copy it to your clipboard. | ||
|
|
||
| !!! note | ||
|
|
||
| API keys grant full access to your account so be sure to store it in a secure way. | ||
|
|
||
|
|
||
| Then to use your API key to log in, run: | ||
|
|
||
| ```console | ||
| $ dbc auth login --api-key "<YOUR_API_KEY_HERE>" | ||
| ``` | ||
|
|
||
| Once you've run this successfully, dbc is now logged in and you can install private drivers as you would normally. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Copyright 2026 Columnar Technologies Inc. | ||
| # | ||
| # Licensed 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. | ||
|
|
||
|
|
||
| def define_env(env): | ||
| @env.macro | ||
| def since_version(version): | ||
| """Create a "since v1.2.3" badge for annotation features with. | ||
| Args: | ||
| version: git tag for version | ||
| """ | ||
| return ( | ||
| f'<span class="version-badge">' | ||
| f'<a href="https://github.com/columnar-tech/dbc/releases/{version}" target="_blank">SINCE {version}</a>' | ||
| f'</span>' | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.