Skip to content

docs: sync docs, add missing fence for a few commands #437

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

Merged
amoeba merged 3 commits into from
Jul 23, 2026
Merged

docs: sync docs, add missing fence for a few commands #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8976111
add missing fence
amoeba Jul 22, 2026
2c58127
sync docs
amoeba Jul 22, 2026
bfb5ddd
add two more missing fences
amoeba Jul 22, 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
1 change: 1 addition & 0 deletions docs/getting_started/first_steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ mysql An ADBC Driver for MySQL developed by the ADBC Driver Found
postgresql An ADBC driver for PostgreSQL developed under the Apache Software Foundation
redshift An ADBC driver for Amazon Redshift developed by Columnar
snowflake An ADBC driver for Snowflake developed under the Apache Software Foundation
spark An ADBC driver for Apache Spark developed by the ADBC Driver Foundry
sqlite An ADBC driver for SQLite developed under the Apache Software Foundation
trino An ADBC Driver for Trino developed by the ADBC Driver Foundry
oracle [private] An ADBC driver for Oracle Database developed by Columnar
Expand Down
75 changes: 61 additions & 14 deletions docs/guides/finding_drivers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ mysql An ADBC Driver for MySQL developed by the ADBC Driver Found
postgresql An ADBC driver for PostgreSQL developed under the Apache Software Foundation
redshift An ADBC driver for Amazon Redshift developed by Columnar
snowflake An ADBC driver for Snowflake developed under the Apache Software Foundation
spark An ADBC driver for Apache Spark developed by the ADBC Driver Foundry
sqlite An ADBC driver for SQLite developed under the Apache Software Foundation
trino An ADBC Driver for Trino developed by the ADBC Driver Foundry
oracle [private] An ADBC driver for Oracle Database developed by Columnar
Expand All @@ -51,6 +52,7 @@ The pattern is treated as a regular expression using Go's [regexp/syntax](https:

For example, you can find drivers with 'sql' in their name by running,

<!-- dbc-output: search sql -->
```console
$ dbc search sql
flightsql An ADBC driver for Apache Arrow Flight SQL developed under the Apache Software Foundation
Expand All @@ -59,6 +61,7 @@ mysql An ADBC Driver for MySQL developed by the ADBC Driver Foundry
postgresql An ADBC driver for PostgreSQL developed under the Apache Software Foundation
sqlite An ADBC driver for SQLite developed under the Apache Software Foundation
```
<!-- /dbc-output -->

## Private Drivers

Expand All @@ -77,6 +80,8 @@ These drivers can be [installed](./installing.md) and added to [driver lists](..
### Verbose

You can use the `--verbose` flag to show detailed information about each driver, including all versions that are available and which are installed.

<!-- dbc-output: search --verbose -->
```console
$ dbc search --verbose
• bigquery
Expand All @@ -87,13 +92,30 @@ $ dbc search --verbose
├── 1.0.0
├── 1.10.0
├── 1.11.0
╰── 1.11.2
├── 1.11.2
├── 1.12.0
╰── 1.12.1
• clickhouse
Title: ClickHouse Driver
Description: An ADBC driver for ClickHouse developed by ClickHouse, Inc.
License: MIT OR Apache-2.0
Available Versions:
╰── 0.1.0
• databricks
Title: ADBC Driver Foundry Driver for Databricks
Description: An ADBC Driver for Databricks developed by the ADBC Driver Foundry
License: Apache-2.0
Available Versions:
╰── 0.1.2
├── 0.1.2
╰── 0.1.3
• datafusion
Title: ADBC Driver Foundry Driver for Apache DataFusion
Description: An ADBC driver for Apache DataFusion developed by the ADBC Driver Foundry
License: Apache-2.0
Available Versions:
├── 0.24.1
├── 0.25.0
╰── 0.26.0
• duckdb
Title: DuckDB Driver
Description: An ADBC driver for DuckDB developed by the DuckDB Foundation
Expand All @@ -104,10 +126,12 @@ $ dbc search --verbose
├── 1.4.2
├── 1.4.3
├── 1.4.4
├── 1.4.5
├── 1.5.0
├── 1.5.1
├── 1.5.2
╰── 1.5.3
├── 1.5.3
╰── 1.5.4
• exasol
Title: Exasol Driver
Description: An ADBC driver for Exasol developed by Exasol Labs
Expand All @@ -117,7 +141,9 @@ $ dbc search --verbose
├── 0.7.0
├── 0.9.0
├── 0.12.0
╰── 0.12.6
├── 0.12.6
├── 0.12.7
╰── 0.13.0
• flightsql
Title: ASF Apache Arrow Flight SQL Driver
Description: An ADBC driver for Apache Arrow Flight SQL developed under the Apache Software Foundation
Expand All @@ -138,7 +164,8 @@ $ dbc search --verbose
├── 1.3.0
├── 1.3.1
├── 1.4.0
╰── 1.4.1
├── 1.4.1
╰── 1.5.0
• mysql
Title: ADBC Driver Foundry Driver for MySQL
Description: An ADBC Driver for MySQL developed by the ADBC Driver Foundry
Expand All @@ -147,7 +174,9 @@ $ dbc search --verbose
├── 0.1.0
├── 0.2.0
├── 0.3.0
╰── 0.3.1
├── 0.3.1
├── 0.4.0
╰── 0.5.0
• postgresql
Title: ASF PostgreSQL Driver
Description: An ADBC driver for PostgreSQL developed under the Apache Software Foundation
Expand All @@ -165,7 +194,8 @@ $ dbc search --verbose
├── 1.0.0
├── 1.1.0
├── 1.2.1
╰── 1.3.0
├── 1.3.0
╰── 1.4.0
• snowflake
Title: ASF Snowflake Driver
Description: An ADBC driver for Snowflake developed under the Apache Software Foundation
Expand All @@ -175,7 +205,14 @@ $ dbc search --verbose
├── 1.9.0
├── 1.10.0
├── 1.10.1
╰── 1.10.3
├── 1.10.3
╰── 1.11.0
• spark
Title: ADBC Driver Foundry Driver for Apache Spark
Description: An ADBC driver for Apache Spark developed by the ADBC Driver Foundry
License: Apache-2.0
Available Versions:
╰── 0.1.0
• sqlite
Title: ASF SQLite Driver
Description: An ADBC driver for SQLite developed under the Apache Software Foundation
Expand All @@ -194,21 +231,26 @@ $ dbc search --verbose
├── 0.1.0
├── 0.2.0
├── 0.3.0
╰── 0.3.1
├── 0.3.1
├── 0.4.0
╰── 0.5.0
• oracle [private]
Title: Columnar ADBC Driver for Oracle Database
Description: An ADBC driver for Oracle Database developed by Columnar
License: LicenseRef-PBL
License: LicenseRef-Columnar-Commercial
Available Versions:
├── 0.4.4
╰── 0.5.1
├── 0.5.1
├── 0.6.0
╰── 0.6.1
• teradata [private]
Title: Columnar ADBC Driver for Teradata
Description: An ADBC driver for Teradata developed by Columnar
License: LicenseRef-PBL
License: LicenseRef-Columnar-Commercial
Available Versions:
╰── 0.1.1
```
<!-- /dbc-output -->

### Pre-release Versions

Expand All @@ -234,6 +276,7 @@ With `--pre`, `dbc search` will:

For example, with `--pre --verbose`:

<!-- dbc-output: search --pre --verbose mysql -->
```console
$ dbc search --pre --verbose mysql
• mysql
Expand All @@ -242,9 +285,13 @@ $ dbc search --pre --verbose mysql
License: Apache-2.0
Available Versions:
├── 0.1.0
├── 0.2.0-beta.1
╰── 0.2.0
├── 0.2.0
├── 0.3.0
├── 0.3.1
├── 0.4.0
╰── 0.5.0
```
<!-- /dbc-output -->

!!! note
Using the `--pre` flag with `dbc search` only affects the visibility of pre-release versions in search results. To actually install a pre-release version, you need to either use `--pre` with `dbc install` or use a version constraint that unambiguously references a pre-release (by including a pre-release suffix like `-beta.1`).
1 change: 1 addition & 0 deletions docs/guides/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ mysql An ADBC Driver for MySQL developed by the ADBC Driver Found
postgresql An ADBC driver for PostgreSQL developed under the Apache Software Foundation
redshift An ADBC driver for Amazon Redshift developed by Columnar
snowflake An ADBC driver for Snowflake developed under the Apache Software Foundation
spark An ADBC driver for Apache Spark developed by the ADBC Driver Foundry
sqlite An ADBC driver for SQLite developed under the Apache Software Foundation
trino An ADBC Driver for Trino developed by the ADBC Driver Foundry
oracle [private] An ADBC driver for Oracle Database developed by Columnar
Expand Down
Loading