Commit 8b436401 authored by Praful Nalatwad's avatar Praful Nalatwad
Browse files

added hex codes for correct and wrong ticks and properly indented the documentation

parent 581a7ffd
Branches
Tags
2 merge requests!270Core ImmuDB package and TOTP plugin - Implementation,!269Core ImmuDB package and TOTP plugin - Implementation
Showing with 63 additions and 50 deletions
......@@ -2,9 +2,13 @@
### **Steps for connecting to Immudb**<br>
- There are two ways to connect to the database using package. 1. **`coreimmudb.InitUsingJson()`** - Provide JSON file path to read ImmuDB config details.<br>
`[
{
- There are two ways to connect to the database using package.
1. **`coreimmudb.InitUsingJson()`** - Provide JSON file path to read ImmuDB config details.<br>
```
[
{
"hostName": "ImmuDbHost1",
"server": "127.0.0.1",
"port": 3322,
......@@ -14,39 +18,46 @@
"dir": "",
"isDefault": true,
"isDisabled": false
}
]`
Hostname (`hostName`) - Hostname for the database connection.<br>
Server (`server`) - Database server address.<br>
Port (`port`) - Port on which ImmuDB running.<br>
Database (`database`) - Database name.<br>
Username (`username`) - Database username<br>
Password (`password`) - Database password<br>
IsDefault (`isDefault`) - Default database selection<br>
IsDisabled (`isDisabled`) - Skip connection <br>
<br> 2. `coreimmudb.InitImmuDBConnections()` - Provide Immudb config details in `[]coreimmudb.ImmuHost`
`[
coreimmudb.ImmuHost{
"HostName": "ImmuDbHost1",
"Server": "127.0.0.1",
"Port": 3322,
"database": "defaultdb",
"Username": "immudb",
"Password": "immudb",
"Dir": "",
"IsDefault": true,
"IsDisabled": false
}
]`
Hostname (`hostName`) - Hostname for the database connection.<br>
Server (`server`) - Database server address.<br>
Port (`port`) - Port on which ImmuDB running.<br>
Database (`database`) - Database name.<br>
Username (`username`) - Database username<br>
Password (`password`) - Database password<br>
IsDefault (`isDefault`) - Default database selection<br>
IsDisabled (`isDisabled`) - Skip connection <br>
<br>
}
]
```
Hostname (`hostName`) - Hostname for the database connection.<br>
Server (`server`) - Database server address.<br>
Port (`port`) - Port on which ImmuDB running.<br>
Database (`database`) - Database name.<br>
Username (`username`) - Database username<br>
Password (`password`) - Database password<br>
IsDefault (`isDefault`) - Default database selection<br>
IsDisabled (`isDisabled`) - Skip connection <br>
2. `coreimmudb.InitImmuDBConnections()` - Provide Immudb config details in `[]coreimmudb.ImmuHost`
```
[
coreimmudb.ImmuHost{
"HostName": "ImmuDbHost1",
"Server": "127.0.0.1",
"Port": 3322,
"database": "defaultdb",
"Username": "immudb",
"Password": "immudb",
"Dir": "",
"IsDefault": true,
"IsDisabled": false
}
]
```
Hostname (`hostName`) - Hostname for the database connection.<br>
Server (`server`) - Database server address.<br>
Port (`port`) - Port on which ImmuDB running.<br>
Database (`database`) - Database name.<br>
Username (`username`) - Database username<br>
Password (`password`) - Database password<br>
IsDefault (`isDefault`) - Default database selection<br>
IsDisabled (`isDisabled`) - Skip connection <br>
<br>
### **Disconnecting ImmuDB connection**<br>
......@@ -120,23 +131,25 @@ AtRevision (`atRevision`) - This option is used to request specific revision for
| AtTx | SinceTx | NoWait | AtRevision | Applies |
| :--: | :-----: | :----: | :--------: | :------: |
| 0 | 0 | 0 | 0 | &#x2713; |
| 0 | 0 | 0 | 1 | &check; |
| 0 | 0 | 1 | 0 | &check; |
| 0 | 0 | 1 | 1 | &check; |
| 0 | 1 | 0 | 0 | &check; |
| 0 | 1 | 0 | 1 | &check; |
| 0 | 1 | 1 | 0 | &check; |
| 0 | 1 | 1 | 1 | &check; |
| 1 | 0 | 0 | 0 | &check; |
| 0 | 0 | 0 | 1 | &#x2713; |
| 0 | 0 | 1 | 0 | &#x2713; |
| 0 | 0 | 1 | 1 | &#x2713; |
| 0 | 1 | 0 | 0 | &#x2713; |
| 0 | 1 | 0 | 1 | &#x2713; |
| 0 | 1 | 1 | 0 | &#x2713; |
| 0 | 1 | 1 | 1 | &#x2713; |
| 1 | 0 | 0 | 0 | &#x2713; |
| 1 | 0 | 0 | 1 | &#x2717; |
| 1 | 0 | 1 | 0 | &check; |
| 1 | 0 | 1 | 1 | &cross; |
| 1 | 1 | 0 | 0 | &cross; |
| 1 | 0 | 1 | 1 | &cross; |
| 1 | 1 | 1 | 0 | &cross; |
| 1 | 1 | 1 | 1 | &cross; |
| 1 | 0 | 1 | 0 | &#x2713; |
| 1 | 0 | 1 | 1 | &#x2717; |
| 1 | 1 | 0 | 0 | &#x2717; |
| 1 | 0 | 1 | 1 | &#x2717; |
| 1 | 1 | 1 | 0 | &#x2717; |
| 1 | 1 | 1 | 1 | &#x2717; |
**Note :-** These Options only work with **`GetKeyData() and GetVerifiedKeyData()`** and does not work with **`GetAllKeysData() and GetKeyHistory()`**.
<br>
<br>
### **Get key data**
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment