Skip to content

Update SDK reference docs (v2.6.x) #1114

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

Open
github-actions wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update SDK reference docs (v2.6.x) #1114

Show file tree
Hide file tree
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
31 changes: 0 additions & 31 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/AddPrivilegesToGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,8 @@

This operation adds privileges to a privilege group.

```cpp
Status AddPrivilegesToGroup(const AddPrivilegesToGroupRequest& request)
```

## Request Syntax

```cpp
auto request = AddPrivilegesToGroupRequest()
.WithGroupName(name)
.WithPrivileges(privileges);
```

**REQUEST METHODS:**

- `WithGroupName(const std::string& name)`
Expand All @@ -38,24 +28,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

std::set<std::string> privileges = {"Search", "Query"};
status = client->AddPrivilegesToGroup(
milvus::AddPrivilegesToGroupRequest()
.WithGroupName(privilege_group_name)
.WithPrivileges(std::move(privileges))
);

if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
27 changes: 0 additions & 27 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/CreatePrivilegeGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@

This operation creates a privilege group.

```cpp
Status CreatePrivilegeGroup(const CreatePrivilegeGroupRequest& request)
```

## Request Syntax

```cpp
auto request = CreatePrivilegeGroupRequest()
.WithGroupName(name);
```

**REQUEST METHODS:**

- `WithGroupName(const std::string& name)`
Expand All @@ -33,21 +24,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

status = client->CreatePrivilegeGroup(
milvus::CreatePrivilegeGroupRequest()
.WithGroupName(privilege_group_name)
);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
28 changes: 0 additions & 28 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/CreateRole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@

This operation creates a role with specific privileges.

```cpp
Status CreateRole(const CreateRoleRequest& request)
```

## Request Syntax

```cpp
auto request = CreateRoleRequest()
.WithRoleName(name);
```

**REQUEST METHODS:**

- `WithRoleName(const std::string& name)`
Expand All @@ -33,22 +24,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

status = client->CreateRole(
milvus::CreateRoleRequest()
.WithRoleName(role_name)
);

if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
32 changes: 1 addition & 31 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/CreateUser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,9 @@
# CreateUser()

This operation creates a user account with a username and password for logging into Milvus.

```cpp
Status CreateUser(const CreateUserRequest& request)
```
This operation creates a user account with a username and password for logging into Milvus.

## Request Syntax

```cpp
auto request = CreateUserRequest()
.WithUserName(name)
.WithPassword(password);
```

**REQUEST METHODS:**

- `WithUserName(const std::string& name)`
Expand All @@ -38,23 +28,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

status = client->CreateUser(
milvus::CreateUserRequest().
WithUserName(user_name).
WithPassword("P@ssw0rd!")
);

if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
31 changes: 0 additions & 31 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/DescribeRole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,8 @@

This operation returns the description of a specific role.

```cpp
Status DescribeRole(const DescribeRoleRequest& request, DescribeRoleResponse& response)
```

## Request Syntax

```cpp
auto request = DescribeRoleRequest()
.WithRoleName(name)
.WithDatabaseName(db_name);
```

**REQUEST METHODS:**

- `WithRoleName(const std::string& name)`
Expand All @@ -38,24 +28,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

milvus::DescribeRoleResponse resp_desc_role;
status = client->DescribeRole(
milvus::DescribeRoleRequest()
.WithRoleName(role_name),
resp_desc_role
);

if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
30 changes: 0 additions & 30 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/DescribeUser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@

This operation returns a user's detailed description.

```cpp
Status DescribeUser(const DescribeUserRequest& request, DescribeUserResponse& response)
```

## Request Syntax

```cpp
auto request = DescribeUserRequest()
.WithUserName(name);
```

**REQUEST METHODS:**

- `WithUserName(const std::string& name)`
Expand All @@ -33,24 +24,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

milvus::DescribeUserResponse resp_desc_user;

status = client->DescribeUser(
milvus::DescribeUserRequest()
.WithUserName(user_name), resp_desc_user
);

if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
28 changes: 0 additions & 28 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/DropPrivilegeGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@

Drop a privilege group.

```cpp
Status DropPrivilegeGroup(const DropPrivilegeGroupRequest& request)
```

## Request Syntax

```cpp
auto request = DropPrivilegeGroupRequest()
.WithGroupName(name);
```

**REQUEST METHODS:**

- `WithGroupName(const std::string& name)`
Expand All @@ -33,22 +24,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

status = client->DropPrivilegeGroup(
milvus::DropPrivilegeGroupRequest()
.WithGroupName(privilege_group_name)
);

if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
30 changes: 0 additions & 30 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/DropRole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,8 @@

This operation drops a role.

```cpp
Status DropRole(const DropRoleRequest& request)
```

## Request Syntax

```cpp
auto request = DropRoleRequest()
.WithRoleName(name)
.WithForceDrop(force_drop);
```

**REQUEST METHODS:**

- `WithRoleName(const std::string& name)`
Expand All @@ -38,23 +28,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

status = client->DropRole(
milvus::DropRoleRequest()
.WithRoleName(role_name)
.WithForceDrop(false)
);

if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
27 changes: 0 additions & 27 deletions API_Reference/milvus-sdk-cpp/v2.6.x/Authentication/DropUser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@

This operation drops a user.

```cpp
Status DropUser(const DropUserRequest& request)
```

## Request Syntax

```cpp
auto request = DropUserRequest()
.WithUserName(name);
```

**REQUEST METHODS:**

- `WithUserName(const std::string& name)`
Expand All @@ -33,21 +24,3 @@ Check `status.IsOk()` to confirm success.

## Example

```cpp
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

status = client->DropUser(
milvus::DropUserRequest()
.WithUserName(user_name)
);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
```
Loading