Skip to content
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

apacheGH-30622: [GAC-45] Initial Version of FlightSQL Readme #12

Merged
merged 1 commit into from
Dec 14, 2023
Merged

apacheGH-30622: [GAC-45] Initial Version of FlightSQL Readme #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 29 additions & 0 deletions cpp/src/flightsql_odbc/flightsql-odbc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# FligthSQL ODBC Driver

## Overview

ODBC driver for Apache Arrow Flight SQL.

## License

This project is licensed under the Apache-2.0 License.

## Pre-requisites
1. Visual Studio 2022 needs to be installed.
- Latest version is recommended
2. Install VCPKG and set `VCPKG_ROOT`.
- Latest version is recommended.
- To update go to the VCPKG_ROOT folder and execute `git pull` and `bootstrap-vcpkg.bat`
3. CMAKE version 3.25.1

## Driver Building (Windows)

Open Visual Studio Developer PowerShell or Powershell and run `./build_win32.bat` or `./build_win64.bat` to build the 32-bit and 64-bit driver correspondingly. The .bat file will build and install the dependencies and the driver.

### Build Troubleshoot Guide

| Error | Root Cause | Fix|
|-------|------------|----|
| CUSTOMBUILD : CMake error : The source directory "C:/<repo_folder>/build/flight_sql/ApacheArrow-prefix/src/ApacheArrow" does not appear to contain CMakeLists.txt. [C:\Dev\forked-flightsql-odbc\build\flight_sql\ApacheArrow.vcxproj] | current CMAKE version 3.28 has issues in build the project | downgrade to the 3.25 version |
| error in the `builtin-baseline` at `vcpkg.json` or issues to build and install the dependencies | vcpkg outdated | updated to the latest vcpkg version |
| vcpkg crashes error | vcpkg was not properly updated | make sure to execute `bootstrap-vcpkg.bat` in the `VCPKG_ROOT` |
Loading