Files
SugarDB/docs/docs/commands/generic/rename.mdx
Kelvin Mwinuka 206a9fe4e6 Added docs folder at the project root. Added build_docs and publish_d… (#105)
Docs sub-directory added to the project.
2024-09-11 01:32:58 +08:00

46 lines
882 B
Plaintext

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
vault, err := echovault.NewEchoVault()
if err != nil {
log.Fatal(err)
}
err = vault.Rename("mykey", "newkey")
```
</TabItem>
<TabItem value="cli">
Rename the key `mykey` to `newkey`:
```
> RENAME mykey newkey
```
</TabItem>
</Tabs>