README.md 2.4 KB
Newer Older
G
groot 已提交
1
### Build C++ SDK
G
groot 已提交
2

G
groot 已提交
3 4
The C++ SDK source code is under milvus/core/src/sdk. Build entire milvus project will also build the C++ SDK project. 
If you don't want to build the entire milvus project, follow below steps:
G
groot 已提交
5 6 7 8 9
```shell
 # generate make files
 $ cd [Milvus root path]/core
 $ ./build.sh -l
 
G
groot 已提交
10
 # build C++ SDK project
G
groot 已提交
11 12 13 14 15 16
 $ cd [Milvus root path]/core/cmake_build
 $ make -C src/sdk
```

### Try C++ example

G
groot 已提交
17 18
Firstly, you need to start a Milvus server.
If you've already built the entire milvus project, just start Milvus server with the following command:
G
groot 已提交
19 20 21 22 23
```shell
 # start milvus server
 $ cd [Milvus root path]/core
 $ ./start_server.sh
```
G
groot 已提交
24
You can also use Docker to start Milvus server:
G
groot 已提交
25 26 27 28 29 30
```shell
 # pull milvus docker image and start milvus server
 $ docker pull milvusdb/milvus:latest
 $ docker run --runtime=nvidia -p 19530:19530 -d milvusdb/milvus:latest
```

G
groot 已提交
31
Run C++ example:
G
groot 已提交
32 33 34 35 36 37 38 39 40

```shell
 # run milvus C++ example
 $ cd [Milvus root path]/core/cmake_build/src/sdk/examples/simple
 $ ./sdk_simple
```

### Make your own C++ client project

G
groot 已提交
41
Create a folder for the project, and copy C++ SDK header and library files into it.
G
groot 已提交
42 43 44 45 46 47 48 49 50 51 52
```shell
 # create project folder
 $ mkdir MyMilvusClient
 $ cd MyMilvusClient
 
 # copy necessary files
 $ cp [Milvus root path]/core/cmake_build/src/sdk/libmilvus_sdk.so .
 $ cp [Milvus root path]/core/src/sdk/include/MilvusApi.h .
 $ cp [Milvus root path]/core/src/sdk/include/Status.h .
```

G
groot 已提交
53
Create file main.cpp in the project folder, and copy the following code into it:
G
groot 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
```shell
#include "./MilvusApi.h"
#include "./Status.h"

int main() {
  // connect to milvus server
  std::shared_ptr<milvus::Connection> conn = milvus::Connection::Create();
  milvus::ConnectParam param = {"127.0.0.1", "19530"};
  conn->Connect(param);
  
  // put your client code here
  
  milvus::Connection::Destroy(conn);
  return 0;
}
```

G
groot 已提交
71
Create file CMakeList.txt in the project folder, and copy the following code into it:
G
groot 已提交
72 73 74 75 76 77 78 79 80 81
```shell
 cmake_minimum_required(VERSION 3.14)
 project(test)
 set(CMAKE_CXX_STANDARD 14)

 add_executable(milvus_client main.cpp)
 target_link_libraries(milvus_client
         ${PROJECT_SOURCE_DIR}/libmilvus_sdk.so)
```

G
groot 已提交
82 83 84 85 86 87 88 89 90 91 92
Now there are 5 files in your project:
```shell
MyMilvusClient
 |-CMakeList.txt
 |-main.cpp
 |-libmilvus_sdk.so
 |-MilvusApi.h
 |-Status.h
  ```

Build the project:
G
groot 已提交
93 94 95 96 97 98 99 100 101 102 103
```shell
 $ mkdir cmake_build
 $ cd cmake_build
 $ cmake ..
 $ make
```

Run your client program:
```shell
 $ ./milvus_client
```