Skip to content

Commit 2f3752f

Browse files
committed
Sample output for native commands
1 parent 9ca4757 commit 2f3752f

File tree

1 file changed

+49
-7
lines changed

1 file changed

+49
-7
lines changed

Diff for: docs/native-commands.md

+49-7
Original file line numberDiff line numberDiff line change
@@ -76,23 +76,26 @@ PRISMADB DECRYPT column [STATUS]
7676
PRISMADB DECRYPT Product.Price;
7777
```
7878

79-
## OPETREE SAVE
79+
## OPETREE STATUS
8080

81-
The Order Preserving Encoding (OPE) tree will be saved in the database for restoration on proxy restarts.
81+
To check the status of the OPE tree.
8282

8383
```
84-
PRISMADB OPETREE SAVE
84+
PRISMADB OPETREE STATUS
8585
```
8686

87-
- The OPE tree is saved in a new table named `PrismaDB_OpeTree`.
88-
- Execution of the `OPETREE REBUILD` and `OPETREE INSERT` commands will perform this action as well.
89-
9087
#### Examples
9188

9289
```
93-
PRISMADB OPETREE SAVE;
90+
PRISMADB OPETREE STATUS;
9491
```
9592

93+
#### Sample Output
94+
95+
| Size | Height | HeightAllowance |
96+
| ---- | ------ | --------------- |
97+
| 1024 | 42 | 21 |
98+
9699
## OPETREE INSERT
97100

98101
Provided values will be inserted into the Order Preserving Encoding (OPE) tree in a most balanced way, and saved in the database.
@@ -148,6 +151,17 @@ PRISMADB OPETREE REBALANCE STOP;
148151
PRISMADB OPETREE REBALANCE STATUS;
149152
```
150153

154+
#### Sample Output for `OPETREE REBALANCE STATUS`
155+
156+
| `Command` | `Status` | `StartedAt` | `InitialHeight` | `CurrentHeight` | `CurrentIteration` | `IterationProgress` | `Stopping` | `CompletedAt` | `ErrorMessage` |
157+
| ---------------------------------------------------- | ------------- | --------------------- | --------------- | --------------- | ------------------ | ------------------- | ---------- | ------------- | -------------- |
158+
| `PRISMADB OPETREE REBALANCE STOP AFTER 3 ITERATIONS` | `In Progress` | `2020-01-02 03:04:05` | `62` | `60` | `2` | `66%` | `False` | *`null`* | *`null`* |
159+
160+
Possible values for `Status`:
161+
- `Completed`
162+
- `In Progress`
163+
- `Error`
164+
151165
## OPETREE REBUILD
152166

153167
The Order Preserving Encoding (OPE) tree will be rebuild entirely from all the `RANGE` encoding enabled data stored in the database. This is used if the OPE tree stored in the database is out-of-sync with the data.
@@ -165,6 +179,23 @@ PRISMADB OPETREE REBUILD [STATUS]
165179
PRISMADB OPETREE REBUILD;
166180
```
167181

182+
## OPETREE SAVE
183+
184+
The Order Preserving Encoding (OPE) tree will be saved in the database for restoration on proxy restarts.
185+
186+
```
187+
PRISMADB OPETREE SAVE
188+
```
189+
190+
- The OPE tree is saved in a new table named `PrismaDB_OpeTree`.
191+
- Execution of the `OPETREE REBUILD` and `OPETREE INSERT` commands will perform this action as well.
192+
193+
#### Examples
194+
195+
```
196+
PRISMADB OPETREE SAVE;
197+
```
198+
168199
## OPETREE LOAD
169200

170201
The Order Preserving Encoding (OPE) tree will be loaded from the database.
@@ -277,3 +308,14 @@ PRISMADB REGISTER USER userid PASSWORD password
277308
```
278309
PRISMADB REGISTER USER 'root' PASSWORD 'qwerty123';
279310
```
311+
312+
## Sample Output for Asynchronous Encryption Modifying `STATUS` Commands
313+
314+
| `LatestQuery` | `Status` | `OverallProgress` | `ColumnProgress` | `ErrorMessage` |
315+
| ---------------------- | ------------- | ----------------- | ---------------- | -------------- |
316+
| `PRISMADB KEYS UPDATE` | `In Progress` | `8/42` | `255` | *`null`* |
317+
318+
Possible values for `Status`:
319+
- `Completed`
320+
- `In Progress`
321+
- `Error`

0 commit comments

Comments
 (0)