Skip to content

Commit db14868

Browse files
committed
add HMGET documentation, add HMGET link to readme.md
and fix wrong github route in documentation header
1 parent ff96d45 commit db14868

File tree

4 files changed

+50
-2
lines changed

4 files changed

+50
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,7 @@ MSET (10 keys): 56022.41 requests per second, p50=0.463 msec
250250
* [HINCRBYFLOAT](https://sugardb.io/docs/commands/hash/hincrbyfloat)
251251
* [HKEYS](https://sugardb.io/docs/commands/hash/hkeys)
252252
* [HLEN](https://sugardb.io/docs/commands/hash/hlen)
253+
* [HMGET](https://sugardb.io/docs/commands/hash/hmget)
253254
* [HRANDFIELD](https://sugardb.io/docs/commands/hash/hrandfield)
254255
* [HSET](https://sugardb.io/docs/commands/hash/hset)
255256
* [HSETNX](https://sugardb.io/docs/commands/hash/hsetnx)

docs/docs/commands/hash/hmget.mdx

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
# HMGET
5+
6+
### Syntax
7+
```
8+
HMGET key field [field ...]
9+
```
10+
11+
### Module
12+
<span className="acl-category">hash</span>
13+
14+
### Categories
15+
<span className="acl-category">fast</span>
16+
<span className="acl-category">hash</span>
17+
<span className="acl-category">read</span>
18+
19+
### Description
20+
Retrieves the value of each of the listed fields from the hash.
21+
22+
### Examples
23+
24+
<Tabs
25+
defaultValue="go"
26+
values={[
27+
{ label: 'Go (Embedded)', value: 'go', },
28+
{ label: 'CLI', value: 'cli', },
29+
]}
30+
>
31+
<TabItem value="go">
32+
Retrieve values from a hash:
33+
```go
34+
db, err := sugardb.NewSugarDB()
35+
if err != nil {
36+
log.Fatal(err)
37+
}
38+
values, err := db.HMGet("key", "field1", "field2", "field3")
39+
```
40+
</TabItem>
41+
<TabItem value="cli">
42+
Retrieve values from a hash:
43+
```
44+
> HMGET key field1 field2
45+
```
46+
</TabItem>
47+
</Tabs>

docs/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ const config: Config = {
9292
label: "Documentation",
9393
},
9494
{
95-
href: "https://github.com//SugarDB",
95+
href: "https://github.com/EchoVault/SugarDB",
9696
label: "GitHub",
9797
position: "right",
9898
},

docs/src/pages/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div class="home">
1+
<div className="home">
22
<img width="200" src="img/ram.png" />
33
# Unleash the Power of Configurable, Distributed In-Memory Storage
44
SugarDB is a highly configurable, distributed, in-memory data store and cache implemented in Go. It can be imported as a Go library or run as an independent service.

0 commit comments

Comments
 (0)