mirror of
https://github.com/rclone/rclone.git
synced 2026-02-07 20:23:18 +00:00
109 lines
2.6 KiB
Markdown
109 lines
2.6 KiB
Markdown
---
|
|
title: "Memory"
|
|
description: "Rclone docs for Memory backend"
|
|
versionIntroduced: "v1.51"
|
|
---
|
|
|
|
# {{< icon "fas fa-memory" >}} Memory
|
|
|
|
The memory backend is an in RAM backend. It does not persist its
|
|
data - use the local backend for that.
|
|
|
|
The memory backend behaves like a bucket-based remote (e.g. like
|
|
s3). Because it has no parameters you can just use it with the
|
|
`:memory:` remote name.
|
|
|
|
## Configuration
|
|
|
|
You can configure it as a remote like this with `rclone config` too if
|
|
you want to:
|
|
|
|
```text
|
|
No remotes found, make a new one\?
|
|
n) New remote
|
|
s) Set configuration password
|
|
q) Quit config
|
|
n/s/q> n
|
|
name> remote
|
|
Type of storage to configure.
|
|
Enter a string value. Press Enter for the default ("").
|
|
Choose a number from below, or type in your own value
|
|
[snip]
|
|
XX / Memory
|
|
\ "memory"
|
|
[snip]
|
|
Storage> memory
|
|
** See help for memory backend at: https://rclone.org/memory/ **
|
|
|
|
Remote config
|
|
|
|
Configuration complete.
|
|
Options:
|
|
- type: memory
|
|
Keep this "remote" remote?
|
|
y) Yes this is OK (default)
|
|
e) Edit this remote
|
|
d) Delete this remote
|
|
y/e/d> y
|
|
```
|
|
|
|
Because the memory backend isn't persistent it is most useful for
|
|
testing or with an rclone server or rclone mount, e.g.
|
|
|
|
```console
|
|
rclone mount :memory: /mnt/tmp
|
|
rclone serve webdav :memory:
|
|
rclone serve sftp :memory:
|
|
```
|
|
|
|
### Modification times and hashes
|
|
|
|
The memory backend supports MD5 hashes and modification times accurate to 1 nS.
|
|
|
|
### Restricted filename characters
|
|
|
|
The memory backend replaces the [default restricted characters
|
|
set](/overview/#restricted-characters).
|
|
|
|
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/memory/memory.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
|
|
### Advanced options
|
|
|
|
Here are the Advanced options specific to memory (In memory object storage system.).
|
|
|
|
#### --memory-discard
|
|
|
|
If set all writes will be discarded and reads will return an error
|
|
|
|
If set then when files are uploaded the contents not be saved. The
|
|
files will appear to have been uploaded but will give an error on
|
|
read. Files will have their MD5 sum calculated on upload which takes
|
|
very little CPU time and allows the transfers to be checked.
|
|
|
|
This can be useful for testing performance.
|
|
|
|
Probably most easily used by using the connection string syntax:
|
|
|
|
:memory,discard:bucket
|
|
|
|
|
|
|
|
Properties:
|
|
|
|
- Config: discard
|
|
- Env Var: RCLONE_MEMORY_DISCARD
|
|
- Type: bool
|
|
- Default: false
|
|
|
|
#### --memory-description
|
|
|
|
Description of the remote.
|
|
|
|
Properties:
|
|
|
|
- Config: description
|
|
- Env Var: RCLONE_MEMORY_DESCRIPTION
|
|
- Type: string
|
|
- Required: false
|
|
|
|
<!-- autogenerated options stop -->
|