Skip to content

Commit 23656dd

Browse files
authored
Update README
1 parent 252535a commit 23656dd

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Clang: >=7
1717
GridDB Server/C Client: 5.0 CE
1818
```
1919

20-
## QuickStart (CentOS, Ubuntu)
20+
## QuickStart
2121
### Preparations
2222

2323
Install rust.
@@ -53,15 +53,37 @@ $ cargo build
5353

5454
GridDB Server need to be started in advance.
5555

56-
1. The command to run sample
56+
1. If you build GridDB C Client from source code, set LD_LIBRARY_PATH.
57+
```console
58+
$ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:<C client library file directory path>
59+
```
60+
61+
2. The command to run sample
5762

5863
```console
59-
$ cargo run --example sample1 <GridDB notification address> <GridDB notification port>
60-
<GridDB cluster name> <GridDB user> <GridDB password>
61-
--> Person: name=name01 status=false count=100 lob=[ABCDEFGHIJ]
64+
$ cargo run --example sample1 <GridDB notification address> <GridDB notification port>
65+
<GridDB cluster name> <GridDB user> <GridDB password>
66+
--> Person: name=name01 status=false count=100 lob=[ABCDEFGHIJ]
6267
```
6368

64-
Person: name=name01 status=false count=100 lob=[ABCDEFGHIJ]
69+
## Function
70+
71+
(available)
72+
- STRING, BOOL, BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, TIMESTAMP, BLOB type for GridDB
73+
- Put single row, get row with key
74+
- Normal query, aggregation with TQL
75+
76+
(not available)
77+
- GEOMETRY, Array type for GridDB
78+
- Multi-Put/Get/Query (batch processing)
79+
- Timeseries-specific function, affinity
80+
81+
Please refer to the following files for more detailed information.
82+
- [Rust Client API Reference](https://griddb.github.io/rust_client/RustAPIReference.htm)
83+
84+
Note:
85+
1. The current API might be changed in the next version.
86+
2. When you install C Client with RPM or DEB, you don't need to set LD_LIBRARY_PATH.
6587

6688
## Community
6789

0 commit comments

Comments
 (0)