diff --git a/docs/guides/driver_manager.md b/docs/guides/driver_manager.md index 09e30e3d..987297f2 100644 --- a/docs/guides/driver_manager.md +++ b/docs/guides/driver_manager.md @@ -59,6 +59,20 @@ The best place to find detailed information on driver manager installation is al ``` +=== "C#/.NET" + + ===+ ".NET ≤ 9" + + ```console + $ dotnet add package Apache.Arrow.Adbc + ``` + + === ".NET ≥ 10" + + ```console + $ dotnet package add Apache.Arrow.Adbc + ``` + === "Go" ```console diff --git a/docs/index.md b/docs/index.md index 453aa5e7..b781f8ec 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,7 +22,9 @@ limitations under the License. dbc is the command-line tool for installing and managing [ADBC](https://arrow.apache.org/adbc) drivers. Get up and running with ADBC in just three steps: -
1. Install dbc (see [Installation](./getting_started/installation.md) for more options): +
+ +
1 Install dbc (see [Installation](./getting_started/installation.md) for more options): === "Linux/macOS shell" @@ -73,7 +75,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ brew install columnar-tech/tap/dbc ``` -
2. Use dbc to install drivers: +
2 Use dbc to install drivers: === "BigQuery" @@ -81,7 +83,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install bigquery ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -91,6 +93,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "bigquery", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("bigquery"); + ``` + === "Go" ```go @@ -165,7 +175,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install --pre cassandra ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -175,6 +185,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "cassandra", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("cassandra"); + ``` + === "Go" ```go @@ -249,7 +267,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install chdb ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -259,6 +277,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "chdb", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("chdb"); + ``` + === "Go" ```go @@ -333,7 +359,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install clickhouse ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -343,6 +369,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "clickhouse", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("clickhouse"); + ``` + === "Go" ```go @@ -417,7 +451,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install databricks ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -427,6 +461,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "databricks", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("databricks"); + ``` + === "Go" ```go @@ -501,7 +543,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install datafusion ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -511,6 +553,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "datafusion", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("datafusion"); + ``` + === "Go" ```go @@ -585,7 +635,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install duckdb ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -595,6 +645,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "duckdb", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("duckdb"); + ``` + === "Go" ```go @@ -669,7 +727,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install exasol ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -679,6 +737,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "exasol", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("exasol"); + ``` + === "Go" ```go @@ -753,7 +819,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install flightsql ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -763,6 +829,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "flightsql", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("flightsql"); + ``` + === "Go" ```go @@ -837,7 +911,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install mssql ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -847,6 +921,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "mssql", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("mssql"); + ``` + === "Go" ```go @@ -921,7 +1003,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install mysql ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -931,6 +1013,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "mysql", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("mysql"); + ``` + === "Go" ```go @@ -1009,7 +1099,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap Oracle is currently available as a private driver. Before installing and using it, run `dbc auth login` and start a trial license in Columnar Console. See [Private Drivers](./guides/private_drivers.md) for details. -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1019,6 +1109,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "oracle", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("oracle"); + ``` + === "Go" ```go @@ -1093,7 +1191,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install postgresql ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1103,6 +1201,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "postgresql", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("postgresql"); + ``` + === "Go" ```go @@ -1177,7 +1283,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install --pre presto ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1187,6 +1293,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "presto", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("presto"); + ``` + === "Go" ```go @@ -1261,7 +1375,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install --pre quack ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1271,6 +1385,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "quack", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("quack"); + ``` + === "Go" ```go @@ -1345,7 +1467,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install redshift ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1355,6 +1477,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "redshift", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("redshift"); + ``` + === "Go" ```go @@ -1429,7 +1559,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install --pre singlestore ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1439,6 +1569,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "singlestore", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("singlestore"); + ``` + === "Go" ```go @@ -1513,7 +1651,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install snowflake ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1523,6 +1661,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "snowflake", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("snowflake"); + ``` + === "Go" ```go @@ -1597,7 +1743,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install spark ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1607,6 +1753,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "spark", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("spark"); + ``` + === "Go" ```go @@ -1681,7 +1835,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install sqlite ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1691,6 +1845,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "sqlite", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("sqlite"); + ``` + === "Go" ```go @@ -1769,7 +1931,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap Teradata is currently available as a private driver. Before installing and using it, run `dbc auth login` and start a trial license in Columnar Console. See [Private Drivers](./guides/private_drivers.md) for details. -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1779,6 +1941,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "teradata", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("teradata"); + ``` + === "Go" ```go @@ -1853,7 +2023,7 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap $ dbc install trino ``` -
3. [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: +
3 [Install a driver manager](./guides/driver_manager.md) and load drivers in any supported language: === "C++" @@ -1863,6 +2033,14 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap AdbcDatabaseSetOption(&database, "driver", "trino", &error) ``` + === "C#" + + ```csharp + using Apache.Arrow.Adbc.DriverManager; + + using var driver = AdbcDriverManager.FindLoadDriver("trino"); + ``` + === "Go" ```go @@ -1931,7 +2109,9 @@ dbc is the command-line tool for installing and managing [ADBC](https://arrow.ap let mut driver = ManagedDriver::load_from_name("trino", ... ) ``` -
For a more detailed walkthrough on how to use dbc, check out our [First Steps](./getting_started/first_steps.md) page or any of our [Guides](./guides/index.md). +
+ +For a more detailed walkthrough on how to use dbc, check out our [First Steps](./getting_started/first_steps.md) page or any of our [Guides](./guides/index.md). ## Features diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 323d84cb..eeb62379 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,6 +1,91 @@ +[data-md-color-scheme="default"] { + --dbc-quickstart-bg-color: rgb(249, 250, 251); + --dbc-quickstart-border-color: rgb(229, 231, 235); + --dbc-quickstart-code-bg-color: rgb(236, 239, 242); +} + [data-md-color-scheme="slate"] { --md-default-bg-color: rgb(33, 33, 33); --md-code-bg-color: rgb(45, 45, 45); + --dbc-quickstart-bg-color: rgb(38, 38, 38); + --dbc-quickstart-border-color: rgb(57, 57, 57); + --dbc-quickstart-code-bg-color: rgb(52, 52, 52); +} + +.quickstart-panel { + --dbc-quickstart-inline-padding: 1.1rem; + --dbc-quickstart-step-content-inset: 0rem; + --md-code-bg-color: var(--dbc-quickstart-code-bg-color); + background-color: var(--dbc-quickstart-bg-color); + border: 0.05rem solid var(--dbc-quickstart-border-color); + border-radius: 0.3rem; + margin: 1.4rem 0 1.8rem; + padding: 1rem var(--dbc-quickstart-inline-padding) 1.1rem; +} + +.quickstart-panel > :first-child { + margin-top: 0; +} + +.quickstart-panel > :last-child { + margin-bottom: 0; +} + +.quickstart-panel p > br:first-child { + display: none; +} + +.quickstart-panel .tabbed-control { + background: linear-gradient( + to right, + var(--dbc-quickstart-bg-color) 60%, + transparent + ); +} + +.quickstart-panel .tabbed-control--next { + background: linear-gradient( + to left, + var(--dbc-quickstart-bg-color) 60%, + transparent + ); +} + +.quickstart-panel > .tabbed-set + p, +.quickstart-panel > .tabbed-set:last-child > .tabbed-content > .tabbed-block > p { + --dbc-quickstart-step-content-inset: var(--dbc-quickstart-inline-padding); + border-top: 0.05rem solid var(--dbc-quickstart-border-color); + margin-inline: calc(0rem - var(--dbc-quickstart-inline-padding)); + margin-top: 0.8rem; + padding-inline: var(--dbc-quickstart-inline-padding); + padding-top: 0.8rem; +} + +.quickstart-panel > p:first-child, +.quickstart-panel > .tabbed-set + p, +.quickstart-panel > .tabbed-set:last-child > .tabbed-content > .tabbed-block > p { + font-weight: 400; + padding-inline-start: calc( + var(--dbc-quickstart-step-content-inset) + 1.75rem + ); +} + +.quickstart-step-number { + align-items: center; + background-color: var(--dbc-quickstart-border-color); + border-radius: 50%; + color: var(--md-default-fg-color); + display: inline-flex; + font-size: 0.72rem; + font-weight: 700; + height: 1.2rem; + justify-content: center; + line-height: 1; + margin-inline-end: 0.35rem; + margin-inline-start: -1.75rem; + transform: translateY(-0.05rem); + vertical-align: middle; + width: 1.2rem; } /* since_version badge styling. see macros.py */ @@ -31,6 +116,36 @@ and won't show up highlighted as purple. */ color: inherit; } +/* Material for MkDocs only ships tab selectors for the first 20 tabs. The +driver picker has 22, so extend the theme rules for Teradata and Trino. */ +@media screen { + .md-typeset .tabbed-set > input:nth-child(21):checked ~ .tabbed-labels > :nth-child(21), + .md-typeset .tabbed-set > input:nth-child(22):checked ~ .tabbed-labels > :nth-child(22) { + color: var(--md-default-fg-color); + } + + .md-typeset .no-js .tabbed-set > input:nth-child(21):checked ~ .tabbed-labels > :nth-child(21), + .md-typeset .no-js .tabbed-set > input:nth-child(22):checked ~ .tabbed-labels > :nth-child(22), + .md-typeset [role="dialog"] .tabbed-set > input:nth-child(21):checked ~ .tabbed-labels > :nth-child(21), + .md-typeset [role="dialog"] .tabbed-set > input:nth-child(22):checked ~ .tabbed-labels > :nth-child(22), + .no-js .md-typeset .tabbed-set > input:nth-child(21):checked ~ .tabbed-labels > :nth-child(21), + .no-js .md-typeset .tabbed-set > input:nth-child(22):checked ~ .tabbed-labels > :nth-child(22), + [role="dialog"] .md-typeset .tabbed-set > input:nth-child(21):checked ~ .tabbed-labels > :nth-child(21), + [role="dialog"] .md-typeset .tabbed-set > input:nth-child(22):checked ~ .tabbed-labels > :nth-child(22) { + border-color: var(--md-default-fg-color); + } +} + +.md-typeset .tabbed-set > input:nth-child(21).focus-visible ~ .tabbed-labels > :nth-child(21), +.md-typeset .tabbed-set > input:nth-child(22).focus-visible ~ .tabbed-labels > :nth-child(22) { + color: var(--md-accent-fg-color); +} + +.md-typeset .tabbed-set > input:nth-child(21):checked ~ .tabbed-content > :nth-child(21), +.md-typeset .tabbed-set > input:nth-child(22):checked ~ .tabbed-content > :nth-child(22) { + display: block; +} + /* Hide the site name in the header... */ .md-header__title .md-header__topic:first-of-type { display: none !important; diff --git a/mkdocs.yml b/mkdocs.yml index 5483dc00..8b818b2f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,6 +22,7 @@ copyright: Copyright © 2026 Columnar Techno markdown_extensions: - admonition - def_list + - md_in_html - pymdownx.highlight: anchor_linenums: true line_spans: __span