Skip to content

Commit

Permalink
SNOW-979340 added description how to enable Arrow (#822)
Browse files Browse the repository at this point in the history
### Description
Added description how to enable Arrow

### Checklist
- [x] Code compiles correctly
- [x] Code is formatted according to [Coding Conventions](../CodingConventions.md)
- [x] Created tests which fail without the change (if possible)
- [x] All tests passing (`dotnet test`)
- [x] Extended the README / documentation, if necessary
- [x] Provide JIRA issue id (if possible) or GitHub issue id in PR name
  • Loading branch information
sfc-gh-dstempniak authored Nov 30, 2023
1 parent 62f2206 commit 1a0809a
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,30 @@ The .NET driver supports the following mappings from .NET to Snowflake data type
| `byte` | `BINARY` |
| `datetime` | `DATE` |

Arrow data format
-----------------

The .NET connector, starting with v2.1.3, supports the [Arrow data format](https://arrow.apache.org/)
as a [preview](https://docs.snowflake.com/en/release-notes/preview-features) feature for data transfers
between Snowflake and a .NET client. The Arrow data format avoids extra
conversions between binary and textual representations of the data. The Arrow
data format can improve performance and reduce memory consumption in clients.

The data format is controlled by the
DOTNET_QUERY_RESULT_FORMAT parameter. To use Arrow format, execute:

```snowflake
-- at the session level
ALTER SESSION SET DOTNET_QUERY_RESULT_FORMAT = ARROW;
-- or at the user level
ALTER USER SET DOTNET_QUERY_RESULT_FORMAT = ARROW;
-- or at the account level
ALTER ACCOUNT SET DOTNET_QUERY_RESULT_FORMAT = ARROW;
```
The valid values for the parameter are:

- ARROW
- JSON (default)

Run a Query and Read Data
-------------------------
Expand Down

0 comments on commit 1a0809a

Please sign in to comment.