Skip to content

Commit

Permalink
update client docs
Browse files Browse the repository at this point in the history
  • Loading branch information
David Coe committed Sep 20, 2023
1 parent 6e945ce commit d46b854
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions csharp/src/Client/SchemaConverter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ public static Type ConvertArrowType(Field f)
{
case ArrowTypeId.Binary:
return typeof(byte[]);

case ArrowTypeId.Boolean:
return typeof(bool);

Expand Down
25 changes: 25 additions & 0 deletions csharp/src/Client/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,28 @@ Since ADO.NET is row-oriented, and ADBC is column-oriented, the row index is tra
This can be thought of as:

![Arrow to DbDataReader](/docs/Arrow-to-DbDataReader.png "Arrow to DbDataReader")

## Connection Properties
The ADO.NET Client is designed so that properties in the connection string map to the properties that are sent to the ADBC driver in the code:

```
AdbcDriver.Open(adbcConnectionParameters);
```

The connection string is parsed using the `DbConnectionStringBuilder` object and the key/value pairs are then added to the properties for the ADBC driver.

For example, when using the [Snowflake ADBC Go Driver](https://arrow.apache.org/adbc/main/driver/snowflake.html#client-options), the connection string will look similar to:

```
adbc.snowflake.sql.account={account};adbc.snowflake.sql.warehouse={warehouse};username={user};password={password}
```

if using the default user name and password authentication, but look like

```
adbc.snowflake.sql.account={account};adbc.snowflake.sql.warehouse={warehouse};username={user};password={password};adbc.snowflake.sql.auth_type=snowflake_jwt;adbc.snowflake.sql.client_option.auth_token={token}
```

when using JWT authentication.

Other ADBC drivers will have different connection parameters, so be sure to check the documentation for each driver.

0 comments on commit d46b854

Please sign in to comment.