Created documentation for RENAMENX command

EchoVault · Nov 24, 2024 · 284995f · 284995f
1 parent 992a3a8
commit 284995f
Showing 1 changed file with 46 additions and 0 deletions.
diff --git a/docs/docs/commands/generic/renamenx.md b/docs/docs/commands/generic/renamenx.md
@@ -0,0 +1,46 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# RENAME
+
+### Syntax
+```
+RENAME key newkey
+```
+
+### Module
+<span className="acl-category">generic</span>
+
+### Categories 
+<span className="acl-category">fast</span>
+<span className="acl-category">write</span>
+
+### Description
+Renames key to newkey. If newkey already exists, it is overwritten. If key does not exist, an error is returned.
+
+### Examples
+
+<Tabs
+  defaultValue="go"
+  values={[
+    { label: 'Go (Embedded)', value: 'go', },
+    { label: 'CLI', value: 'cli', },
+  ]}
+>
+  <TabItem value="go">
+  Rename the key `mykey` to `newkey`:
+  ```go
+  db, err := sugardb.NewSugarDB()
+  if err != nil {
+    log.Fatal(err)
+  }
+  err = db.Rename("mykey", "newkey")
+  ```
+  </TabItem>
+  <TabItem value="cli">
+  Rename the key `mykey` to `newkey`:
+  ```
+  > RENAME mykey newkey
+  ```
+  </TabItem>
+</Tabs>