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

[AD-651] update ReadMe #43

Merged
merged 7 commits into from
Mar 10, 2022
Merged

[AD-651] update ReadMe #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8e4999c
[AD-651] update .gitignore to include *DS_Store
alinaliBQ Mar 9, 2022
768ac49
[AD-651] update readme
alinaliBQ Mar 9, 2022
e96b135
[AD-651] add command to register the ODBC driver on MacOS
alinaliBQ Mar 10, 2022
9168e11
[AD-651] add instructions for setting DOCUMENTDB_HOME
alinaliBQ Mar 10, 2022
7e8bb18
[AD-651] add example for JAVA_HOME for clarity
alinaliBQ Mar 10, 2022
83b914b
[AD-651] resolve code review feedback
alinaliBQ Mar 10, 2022
e16e19d
[AD-651] change command for downloading mongo cxx driver
alinaliBQ Mar 10, 2022
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 .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
*.aps
*.DS_Store
*.obj
*.iobj
*.ipdb
Expand Down
28 changes: 20 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Example:
2. Install the test data
1. `cd src/odbc-test/scripts`
2. `.\import_test_data.ps1` (Windows) or `./import_test_data.sh` (MacOS or Linux)
If receiving permission errors on MacOS while importing the test data,
use `chmod +x ./reinstall_mongodb_mac.sh` and try again.

### Windows

Expand All @@ -57,9 +59,10 @@ Example:
1. Ensure to add path to WiX executables (e.g. `C:\Program Files (x86)\WiX Toolset v3.11\bin`)
4. [Java](https://www.oracle.com/java/technologies/downloads/) **JDK** (version 8+ - 17 recommended)
1. Ensure to set `JAVA_HOME`. (e.g. C:\Program Files\Java\jdk-17.0.2)
2. Ensure to save Java `\bin` and `\server` directories to the User `PATH` variable. (e.g. C:\Program Files\Java\jdk1.8.0_321\jre\bin\server)
5. Boost Test Framework
1. Install via [VCPKG](https://vcpkg.io/en/getting-started.html) using `.\vcpkg install openssl:x64-windows boost-test:x64-windows boost-asio:x64-windows boost-chrono:x64-windows boost-interprocess:x64-windows boost-regex:x64-windows boost-system:x64-windows boost-thread:x64-windows`
2. Ensure to save Java `\bin` and `\server` directories to the User `PATH` variable.
Example: C:\Program Files\Java\jdk1.8.0_321\jre\bin\server
5. Boost Test Framework and Mondodb Driver
1. Install via [VCPKG](https://vcpkg.io/en/getting-started.html) using `.\vcpkg install openssl:x64-windows boost-test:x64-windows boost-asio:x64-windows boost-chrono:x64-windows boost-interprocess:x64-windows boost-regex:x64-windows boost-system:x64-windows boost-thread:x64-windows mongo-cxx-driver:x64-windows`
6. Run one of the build scripts to create an initial compilation.
1. E.g.: `.\build_win_debug64.ps1`
2. Navigate to the `build\odbc\cmake` folder to use the generated solution file, `Ignite.C++.sln` to work on
Expand All @@ -70,7 +73,7 @@ Example:
```
<repo-folder>\src\odbc\src\install\install_amd64.cmd <repo-folder>\buildbuild\odbc\cmake\Debug\ignite.odbc.dll
```
8. More details in [`src\DEVNOTES.txt`](src/DEVNOTES.txt).
9. More details in [`src\DEVNOTES.txt`](src/DEVNOTES.txt).

### MacOS

Expand All @@ -80,17 +83,26 @@ Example:
3. `brew install unixodbc`
- You may need to unlink `libiodbc` if you already have this installed. Use `brew unlink libiodbc`.
4. `brew install boost`
5. Install Java **JDK** (version 8+ - 17 recommended)
5. `brew install mongodb-community`
6. `brew install mongo-cxx-driver`
7. Install Java **JDK** (version 8+ - 17 recommended)
- This can be done through Homebrew using `brew install --cask temurin<version>`.
- Ensure to set `JAVA_HOME`.
- Ensure to set `JAVA_HOME`. Make sure it is set to temurin. Other JDK package may cause test errors
such as `Unable to get initialized JVM` at run time.
Example: /Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home
- Ensure to save Java `/bin` and `/server` directories to the User `PATH` variable.
6. If creating a debug build (`./build_mac_debug64.sh`), LLVM is required.
Example: /Library/Java/JavaVirtualMachines/jdk-17.0.2.jdk/Contents/Home/lib/server/
/Library/Java/JavaVirtualMachines/jdk-17.0.2.jdk/Contents/Home/bin/
8. If creating a debug build (`./build_mac_debug64.sh`), LLVM is required.
- If you only have XCode Command Line Tools, use the LLVM included with XCode by modifying the PATH with `export PATH=/Library/Developer/CommandLineTools/usr/bin/:$PATH`. Ensure this XCode path comes first in $PATH. If error occurs, check that clang and llvm are under folder Library/Developer/CommandLineTools/usr/bin.
- If you have XCode application, to ensure LLVM and CMake are compatible, use the LLVM included with XCode by modifying the PATH with `export PATH=/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/:$PATH`.
2. Run one of the build scripts to create an initial compilation.
1. E.g.: `./build_mac_release64.sh`
2. Navigate to the `build/odbc/lib` folder to use the generated files.
3. More details in [`src\DEVNOTES.txt`](src/DEVNOTES.txt).
3. Set the environment variable `DOCUMENTDB_HOME`. On a developer's machine, set it to `<repo-folder>/build/odbc/bin`
4. Run the following command to register the ODBC driver.
`./scripts/register_driver_macos.sh`
5. More details in [`src\DEVNOTES.txt`](src/DEVNOTES.txt).

### Linux

Expand Down