mobiletto 1.1.10 → 1.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/docs/README.md +113 -0
- package/docs/af/README.md +455 -0
- package/docs/am/README.md +455 -0
- package/docs/ar/README.md +455 -0
- package/docs/az/README.md +455 -0
- package/docs/be/README.md +455 -0
- package/docs/bg/README.md +455 -0
- package/docs/bn/README.md +455 -0
- package/docs/bs/README.md +455 -0
- package/docs/ca/README.md +455 -0
- package/docs/ceb/README.md +455 -0
- package/docs/co/README.md +455 -0
- package/docs/cs/README.md +455 -0
- package/docs/cy/README.md +455 -0
- package/docs/da/README.md +455 -0
- package/docs/de/README.md +455 -0
- package/docs/el/README.md +455 -0
- package/docs/eo/README.md +455 -0
- package/docs/es/README.md +455 -0
- package/docs/et/README.md +455 -0
- package/docs/eu/README.md +455 -0
- package/docs/fa/README.md +455 -0
- package/docs/fi/README.md +455 -0
- package/docs/fr/README.md +455 -0
- package/docs/fy/README.md +455 -0
- package/docs/ga/README.md +455 -0
- package/docs/gd/README.md +455 -0
- package/docs/gl/README.md +455 -0
- package/docs/gu/README.md +455 -0
- package/docs/ha/README.md +455 -0
- package/docs/haw/README.md +455 -0
- package/docs/he/README.md +455 -0
- package/docs/hi/README.md +455 -0
- package/docs/hmn/README.md +455 -0
- package/docs/hr/README.md +455 -0
- package/docs/ht/README.md +455 -0
- package/docs/hu/README.md +455 -0
- package/docs/hy/README.md +455 -0
- package/docs/id/README.md +455 -0
- package/docs/ig/README.md +455 -0
- package/docs/is/README.md +455 -0
- package/docs/it/README.md +455 -0
- package/docs/iw/README.md +455 -0
- package/docs/ja/README.md +455 -0
- package/docs/jv/README.md +455 -0
- package/docs/ka/README.md +455 -0
- package/docs/kk/README.md +455 -0
- package/docs/km/README.md +455 -0
- package/docs/kn/README.md +455 -0
- package/docs/ko/README.md +455 -0
- package/docs/ku/README.md +455 -0
- package/docs/ky/README.md +455 -0
- package/docs/la/README.md +455 -0
- package/docs/lb/README.md +455 -0
- package/docs/lo/README.md +455 -0
- package/docs/lt/README.md +455 -0
- package/docs/lv/README.md +455 -0
- package/docs/mg/README.md +455 -0
- package/docs/mi/README.md +455 -0
- package/docs/mk/README.md +455 -0
- package/docs/ml/README.md +455 -0
- package/docs/mn/README.md +455 -0
- package/docs/mr/README.md +455 -0
- package/docs/ms/README.md +455 -0
- package/docs/mt/README.md +455 -0
- package/docs/my/README.md +455 -0
- package/docs/ne/README.md +455 -0
- package/docs/nl/README.md +455 -0
- package/docs/no/README.md +455 -0
- package/docs/ny/README.md +455 -0
- package/docs/or/README.md +455 -0
- package/docs/pa/README.md +455 -0
- package/docs/pl/README.md +455 -0
- package/docs/ps/README.md +455 -0
- package/docs/pt/README.md +455 -0
- package/docs/ro/README.md +455 -0
- package/docs/ru/README.md +455 -0
- package/docs/rw/README.md +455 -0
- package/docs/sd/README.md +455 -0
- package/docs/si/README.md +455 -0
- package/docs/sk/README.md +455 -0
- package/docs/sl/README.md +455 -0
- package/docs/sm/README.md +455 -0
- package/docs/sn/README.md +455 -0
- package/docs/so/README.md +455 -0
- package/docs/sq/README.md +455 -0
- package/docs/sr/README.md +455 -0
- package/docs/st/README.md +455 -0
- package/docs/su/README.md +455 -0
- package/docs/sv/README.md +455 -0
- package/docs/sw/README.md +455 -0
- package/docs/ta/README.md +455 -0
- package/docs/te/README.md +455 -0
- package/docs/tg/README.md +455 -0
- package/docs/th/README.md +455 -0
- package/docs/tk/README.md +455 -0
- package/docs/tl/README.md +455 -0
- package/docs/tr/README.md +455 -0
- package/docs/tt/README.md +455 -0
- package/docs/ug/README.md +455 -0
- package/docs/uk/README.md +455 -0
- package/docs/ur/README.md +455 -0
- package/docs/uz/README.md +455 -0
- package/docs/vi/README.md +455 -0
- package/docs/xh/README.md +455 -0
- package/docs/yi/README.md +455 -0
- package/docs/yo/README.md +455 -0
- package/docs/zh/README.md +455 -0
- package/docs/zu/README.md +455 -0
- package/drivers/b2/index.js +24 -6
- package/hokey.json +16 -0
- package/index.js +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +12 -9
- package/util/redis.js +1 -1
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
ʻO Mobiletto kahi ʻāpana abstraction storage JavaScript, me ka hoʻopunipuni ʻaoʻao o ka mea kūʻai aku.
|
|
5
|
+
|
|
6
|
+
# Maʻiʻo
|
|
7
|
+
* [No ke aha ʻo Mobiletto?](#No ke aha-Mobiletto?)
|
|
8
|
+
* [Hoʻomaka wikiwiki](#Hoʻomaka wikiwiki)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Source](#Source)
|
|
11
|
+
* [Hoʻohana kumu](#Hoʻohana kumu)
|
|
12
|
+
* [Metadata](#Metadata)
|
|
13
|
+
* [Kaila hoʻokomo ʻokoʻa](#Kaila-hoʻokomo ʻokoʻa)
|
|
14
|
+
* [Ke hoʻopaʻa ʻia](#Caching)
|
|
15
|
+
* [Mirroring](#Mirroring)
|
|
16
|
+
* [Hoʻopili paʻapū](#Pūnaewele-alohi)
|
|
17
|
+
* [Hoʻololi kī](#Hoʻololi kī)
|
|
18
|
+
* [Ke kaʻa hoʻokele](#Keaukaha-kaʻa)
|
|
19
|
+
* [Logging](#Logging)
|
|
20
|
+
|
|
21
|
+
# E heluhelu i kēia ma ka ʻōlelo ʻē aʻe
|
|
22
|
+
Ua unuhi ʻia kēia palapala README.md, ma o [hokeylization](https://github.com/cobbzilla/hokeylization), i loko
|
|
23
|
+
**[kākoʻo ʻia kēlā me kēia ʻōlelo e ka Unuhi Google](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Ua maopopo iaʻu ʻaʻole ia i hemolele, akā manaʻo wau ʻoi aku ka maikaʻi ma mua o ka ʻole!
|
|
26
|
+
|
|
27
|
+
[🇸🇦 ʻAlapia](../ar/README.md)
|
|
28
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
29
|
+
[🇩🇪 Kelemānia](../de/README.md)
|
|
30
|
+
[🇺🇸 Pelekania](../en/README.md)
|
|
31
|
+
[🇪🇸 Paniolo](../es/README.md)
|
|
32
|
+
[🇫🇷 Palani](../fr/README.md)
|
|
33
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
34
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
35
|
+
[🇮🇩 Indonesia](../id/README.md)
|
|
36
|
+
[🇮🇹 Italia](../it/README.md)
|
|
37
|
+
[🇯🇵 Kepani](../ja/README.md)
|
|
38
|
+
[🇰🇷 Korean](../ko/README.md)
|
|
39
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
40
|
+
[🇵🇱 Polani](../pl/README.md)
|
|
41
|
+
[🇧🇷 Pukiki](../pt/README.md)
|
|
42
|
+
[🇷🇺 Lūkia](../ru/README.md)
|
|
43
|
+
[🇰🇪 Swahili](../sw/README.md)
|
|
44
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
45
|
+
[🇹🇷 Turkish](../tr/README.md)
|
|
46
|
+
[🇵🇰 Urdu](../ur/README.md)
|
|
47
|
+
[🇻🇳 Vietnamese](../vi/README.md)
|
|
48
|
+
[🇨🇳 Pākē](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Nā ʻŌlelo a pau ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Aia kekahi pilikia me kēia unuhi o ka README?
|
|
55
|
+
ʻO kēia unuhi kikoʻī o ka [README] kumu (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
hewa paha -- * mahalo nui ʻia nā hoʻoponopono!* E ʻoluʻolu e hoʻouna i [noi huki ma GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
57
|
+
a inā ʻaʻole ʻoluʻolu ʻoe e hana i kēlā, [wehe i kahi pilikia](https://github.com/cobbzilla/mobiletto/issues)
|
|
58
|
+
|
|
59
|
+
Ke hana ʻoe i kahi pilikia GitHub hou e pili ana i kahi unuhi, e ʻoluʻolu e hana:
|
|
60
|
+
* hoʻokomo i ka URL o ka ʻaoʻao (kope/paʻi mai ka ʻaoʻao ʻaoʻao pūnaewele)
|
|
61
|
+
* hoʻokomo i ka kikokikona pololei i hewa (kope/paʻi mai ka polokalamu kele pūnaewele)
|
|
62
|
+
* ʻoluʻolu e wehewehe i ka hewa -- hewa ka unuhi? Ua haki paha ke ʻano o ke ʻano?
|
|
63
|
+
* ʻoluʻolu e hāʻawi i ka manaʻo o kahi unuhi ʻoi aku ka maikaʻi, a i ʻole pehea e hoʻopili pono ʻia ai ka kikokikona
|
|
64
|
+
* **Mahalo!**
|
|
65
|
+
|
|
66
|
+
## No ke aha ʻo Mobiletto?
|
|
67
|
+
|
|
68
|
+
### Aloha ka mea kūʻai aku laka-i!
|
|
69
|
+
Loaʻa nā API like ʻole i nā mea hoʻolako mālama kapua. ʻO ka poʻe e hoʻoikaika nei no ka "S3 compatibility"
|
|
70
|
+
loaʻa nā ʻano idiosyncratic.
|
|
71
|
+
|
|
72
|
+
Ke koho ʻoe i kahi mea kūʻai waihona no kāu polokalamu, inā ʻoe e helu pololei i kā lākou API, kāu app
|
|
73
|
+
ke hilinaʻi nei i kēia lawelawe. Ke hele nei ka manawa a hōʻiliʻili nā code, lilo nā mea kūʻai aku
|
|
74
|
+
mahuahua hiki ole. Welina mai i ka honua leʻaleʻa o ka mea kūʻai aku laka-i!
|
|
75
|
+
|
|
76
|
+
Ua hoʻolālā ʻia ʻo Mobiletto e hoʻoponopono i kēia pilikia. Ma ka hoʻopili ʻana i kāu polokalamu i ka mobiletto's API, hiki iā ʻoe ke maʻalahi
|
|
77
|
+
e hoʻololi i nā mea hoʻolako waihona a ʻike e ʻano like ke ʻano o ka papa waiho o kāu app.
|
|
78
|
+
|
|
79
|
+
### Hoʻāʻo nui
|
|
80
|
+
Hoʻāʻo ʻia nā mea hoʻokele a pau no ka ʻano like me 60+ mau hoʻāʻo no kēlā me kēia kaʻa.
|
|
81
|
+
Hoʻāʻo mākou i nā mea hoʻokele āpau me kēlā me kēia hui ʻana o:
|
|
82
|
+
* Hoʻopili: hoʻohana ʻia a paʻa ʻole
|
|
83
|
+
* Redis cache: hoʻohana ʻia a paʻa ʻole
|
|
84
|
+
|
|
85
|
+
Hāʻawi kēia ala iā mākou i ka maluhia o ka noʻonoʻo e hana like ana ʻo mobiletto me ka nānā ʻole i ka mea hoʻokele āu e hoʻohana ai,
|
|
86
|
+
a me ka nānā ʻole inā hiki iā ʻoe ke hoʻokomo i ka cache a/a i ʻole ka hoʻopili ʻana.
|
|
87
|
+
|
|
88
|
+
### Kākoʻo hoʻokele
|
|
89
|
+
Nā mea hoʻokele mālama ʻo Mobiletto i kēia manawa:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` : ʻōnaehana waihona kūloko
|
|
93
|
+
|
|
94
|
+
*Hoʻokipa maikaʻi ʻia nā hāʻawi e kākoʻo i nā mea hoʻolako mālama kapua!*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Hoʻohana ʻia ʻo Mobiletto ma ke ʻano he waihona e nā code JavaScript ʻē aʻe.
|
|
98
|
+
|
|
99
|
+
No ka hana ʻana me mobiletto ma ka laina kauoha, e hoʻohana iā [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Puna
|
|
102
|
+
* [mobiletto ma GitHub](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto ma npm](https://www.npmjs.com/package/mobiletto)
|
|
104
|
+
|
|
105
|
+
## Hoʻomaka wikiwiki
|
|
106
|
+
He laʻana pōkole e hoʻohana ana i ka mea hoʻokele mobiletto `s3` .
|
|
107
|
+
|
|
108
|
+
E holo like ana kēia code inā ʻo ka mea hoʻokele `b2` a i ʻole `local` .
|
|
109
|
+
|
|
110
|
+
const storage = require('mobiletto')
|
|
111
|
+
const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
|
|
112
|
+
|
|
113
|
+
// list objects: returns array of metadata objects
|
|
114
|
+
const listing = await bucket.list()
|
|
115
|
+
const dirList = await bucket.list('some/dir/')
|
|
116
|
+
const everything = await bucket.list('', {recursive: true})
|
|
117
|
+
|
|
118
|
+
// write an entire file
|
|
119
|
+
let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
|
|
120
|
+
|
|
121
|
+
// write a file from a stream/generator
|
|
122
|
+
bytesWritten = await bucket.write('some/path', streamOrGenerator)
|
|
123
|
+
|
|
124
|
+
// read an entire file
|
|
125
|
+
// returns null if an exception would otherwise be thrown
|
|
126
|
+
const bufferOrNull = await bucket.safeReadFile('some/path')
|
|
127
|
+
|
|
128
|
+
// stream-read a file, passing data to callback
|
|
129
|
+
const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
|
|
130
|
+
|
|
131
|
+
// remove a file, returns the path removed
|
|
132
|
+
let removed = await bucket.remove('some/path') // removed is a string
|
|
133
|
+
|
|
134
|
+
// remove a directory, returns array of paths removed
|
|
135
|
+
removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
|
|
136
|
+
|
|
137
|
+
----
|
|
138
|
+
## Hoʻohana kumu
|
|
139
|
+
ʻO kahi laʻana nui loa, e hōʻike ana i ka hapa nui o nā hiʻohiʻona i hāʻawi ʻia:
|
|
140
|
+
|
|
141
|
+
const { mobiletto } = require('mobiletto')
|
|
142
|
+
|
|
143
|
+
// General usage
|
|
144
|
+
const api = await mobiletto(driverName, key, secret, opts)
|
|
145
|
+
|
|
146
|
+
// To use 'local' driver:
|
|
147
|
+
// * key: base directory
|
|
148
|
+
// * secret: ignored, can be null
|
|
149
|
+
// * opts object:
|
|
150
|
+
// * readOnly: optional, never change anything on the filesystem; default is false
|
|
151
|
+
// * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
|
|
152
|
+
// * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
|
|
153
|
+
const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
|
|
154
|
+
|
|
155
|
+
// To use 's3' driver:
|
|
156
|
+
// * key: AWS Access Key ID
|
|
157
|
+
// * secret: AWS Secret Key
|
|
158
|
+
// * opts object:
|
|
159
|
+
// * readOnly: optional, never change anything on the bucket; default is false
|
|
160
|
+
// * bucket: required, name of the S3 bucket
|
|
161
|
+
// * region: optional, the AWS region to communicate with, default is us-east-1
|
|
162
|
+
// * prefix: optional, all read/writes within the S3 bucket will be under this prefix
|
|
163
|
+
// * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
|
|
164
|
+
const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
|
|
165
|
+
|
|
166
|
+
// To use 'b2' driver:
|
|
167
|
+
// * key: Backblaze Key ID
|
|
168
|
+
// * secret: Backblaze Application Key
|
|
169
|
+
// * opts object:
|
|
170
|
+
// * readOnly: optional, never change anything on the bucket; default is false
|
|
171
|
+
// * bucket: required, the ID (**not the name**) of the B2 bucket
|
|
172
|
+
// * prefix: optional, all read/writes within the B2 bucket will be under this prefix
|
|
173
|
+
// * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
|
|
174
|
+
// * partSize: optional, large files will be split into chunks of this size when uploading
|
|
175
|
+
const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
|
|
176
|
+
|
|
177
|
+
// List files
|
|
178
|
+
api.list() // --> returns an array of metadata objects
|
|
179
|
+
|
|
180
|
+
// List files recursively
|
|
181
|
+
api.list({ recursive: true })
|
|
182
|
+
|
|
183
|
+
// List files in a directory
|
|
184
|
+
const path = 'some/path'
|
|
185
|
+
api.list(path)
|
|
186
|
+
api.list(path, { recursive: true }) // also supports recursive flag
|
|
187
|
+
|
|
188
|
+
// Visit files in a directory -- visitor function must be async
|
|
189
|
+
api.list(path, { visitor: myAsyncFunc })
|
|
190
|
+
api.list(path, { visitor: myAsyncFunc, recursive: true })
|
|
191
|
+
|
|
192
|
+
// The `list` method throws MobilettoNotFoundError if the path does not exist
|
|
193
|
+
// When you call `safeList` on a non-existent path, it returns an empty array
|
|
194
|
+
api.safeList('/path/that/does/not/exist') // returns []
|
|
195
|
+
|
|
196
|
+
// Read metadata for a file
|
|
197
|
+
api.metadata(path) // returns metadata object
|
|
198
|
+
|
|
199
|
+
// The `metadata` method throws MobilettoNotFoundError if the path does not exist
|
|
200
|
+
// When you call `safeMetadata` on a non-existent path, it returns null
|
|
201
|
+
api.safeMetadata('/tmp/does_not_exist') // returns null
|
|
202
|
+
|
|
203
|
+
// Read a file
|
|
204
|
+
// Provide a callback that writes the data someplace
|
|
205
|
+
const callback = (chunk) => { ... write chunk somewhere ... }
|
|
206
|
+
api.read(path, callback) // returns count of bytes read
|
|
207
|
+
|
|
208
|
+
// Read an entire file at once
|
|
209
|
+
const data = await api.readFile(path) // returns a byte Buffer of the file contents
|
|
210
|
+
|
|
211
|
+
// Read an entire file at once
|
|
212
|
+
// returns null if an exception would otherwise be thrown
|
|
213
|
+
const bufferOrNull = await bucket.safeReadFile('some/path')
|
|
214
|
+
|
|
215
|
+
// Write a file
|
|
216
|
+
// Provide a generator function that yields chunks of data
|
|
217
|
+
const generator = function* () {
|
|
218
|
+
while ( ... more-data-to-return ... ) {
|
|
219
|
+
data = ... load-data ...
|
|
220
|
+
yield data
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
local.api(path, generator) // returns count of bytes written
|
|
224
|
+
|
|
225
|
+
// Write an entire file at once (convenience method)
|
|
226
|
+
await api.writeFile(path, bufferOrString) // returns count of bytes written
|
|
227
|
+
|
|
228
|
+
// Delete a file
|
|
229
|
+
// Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
|
|
230
|
+
// Always returns a value or throws an error.
|
|
231
|
+
// Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
|
|
232
|
+
const quiet = true
|
|
233
|
+
api.remove(path, {quiet}) // returns single path removed
|
|
234
|
+
|
|
235
|
+
// Recursively delete a directory and do it quietly (do not report errors)
|
|
236
|
+
const recursive = true
|
|
237
|
+
const quiet = true
|
|
238
|
+
api.remove(path, {recursive, quiet}) // returns array of paths removed
|
|
239
|
+
|
|
240
|
+
## ʻIkepili
|
|
241
|
+
Hoʻihoʻi ke kauoha `metadata` i ka metadata e pili ana i hoʻokahi waihona waihona waihona.
|
|
242
|
+
Pēlā nō, ʻo ka waiwai hoʻihoʻi mai ke kauoha `list` he ʻano o nā mea metadata.
|
|
243
|
+
|
|
244
|
+
Penei ke ano o kekahi mea metadata:
|
|
245
|
+
|
|
246
|
+
{
|
|
247
|
+
"name": "fully/qualified/path/to/file",
|
|
248
|
+
"type": "entry-type",
|
|
249
|
+
"size": size-in-bytes,
|
|
250
|
+
"ctime": creation-time-epoch-millis,
|
|
251
|
+
"mtime": modification-time-epoch-millis
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
Hiki ke ʻano ʻano ʻano `type` `file` , `dir` , `link` , a i ʻole `special` .
|
|
255
|
+
|
|
256
|
+
Ma muli o ke ʻano o ka mea hoʻokele, ʻaʻole hiki i kahi kauoha `list` ke hoʻihoʻi i nā kahua āpau. ʻO ka `name` a me `type` waiwai
|
|
257
|
+
pono e noho mau. E hoʻihoʻi mai kahi kauoha `metadata` i nā waiwai āpau i loaʻa.
|
|
258
|
+
|
|
259
|
+
## Kāhua hoʻokomo ʻē aʻe
|
|
260
|
+
Hoʻokomo i ka module piha piha a hoʻohana i ka hana `connect` :
|
|
261
|
+
|
|
262
|
+
const storage = require('mobiletto')
|
|
263
|
+
const opts = {bucket: 'bk', region: 'us-east-1'}
|
|
264
|
+
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
265
|
+
const objectData = await s3.readFile('some/path')
|
|
266
|
+
|
|
267
|
+
## Ke kāʻei ʻana
|
|
268
|
+
Hana maikaʻi ʻo Mobiletto me kahi cache <a href="https://redis.io">redis</a> .
|
|
269
|
+
|
|
270
|
+
E hoʻāʻo ʻo Mobiletto e hoʻopili i kahi ʻano redis ma 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Hiki iā ʻoe ke hoʻololi i kekahi o kēia:
|
|
273
|
+
* E hoʻonohonoho i ka `MOBILETTO_REDIS_HOST` env var, mobiletto hoʻohui ma ʻaneʻi ma kahi o ka localhost
|
|
274
|
+
* E hoʻonoho i ka `MOBILETTO_REDIS_PORT` env var, e hoʻohana ʻia kēia awa
|
|
275
|
+
|
|
276
|
+
E mālama ʻo Mobiletto i kāna mau kī redis me ka prefix `_mobiletto__` . Hiki iā ʻoe ke hoʻololi i kēia
|
|
277
|
+
ma ka hoʻonohonoho ʻana i ka var env `MOBILETTO_REDIS_PREFIX` .
|
|
278
|
+
|
|
279
|
+
Hiki iā ʻoe ke hoʻonohonoho i ka hoʻopaʻa ʻana i kēlā me kēia pilina me ka mea `opts.redisConfig` ':
|
|
280
|
+
|
|
281
|
+
const redisConfig = {
|
|
282
|
+
enabled: true, // optional, default is true. if false other props are ignored
|
|
283
|
+
host: '127.0.0.1',
|
|
284
|
+
port: 6379,
|
|
285
|
+
prefix: '_mobiletto__'
|
|
286
|
+
}
|
|
287
|
+
const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
|
|
288
|
+
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
289
|
+
|
|
290
|
+
### ʻAʻole makemake e hoʻihoʻi hou i ka cache?
|
|
291
|
+
No ka hoʻopau: e hoʻokomo i ka `enabled: false` i kāu mea `opts.redisConfig` ke hoʻokumu ʻoe i kāu pilina.
|
|
292
|
+
|
|
293
|
+
E like me ka mea i kūkākūkā ʻia ma lalo nei, ʻo ka hoʻopau ʻana i ka cache e loaʻa i kahi hopena maikaʻi ʻole i ka hana a loaʻa i nā noi hou aku
|
|
294
|
+
i ka waihona āu e pono ai.
|
|
295
|
+
|
|
296
|
+
### Ke alakaʻi cache
|
|
297
|
+
** Waihona i hoʻopaʻa ʻia**: ʻoi aku ka lohi o ka heluhelu/kākau ʻana i kahi waihona i hoʻopili ʻia ma mua o ka maʻamau,
|
|
298
|
+
akā ʻo ka hoʻokele ʻana a puni nā papa kuhikuhi (kahi e hana ai kekahi mau mea) ʻoi aku ka pipiʻi. Ke hoʻohana nei i kahi cache redis
|
|
299
|
+
e hāʻawi iā ʻoe i kahi hoʻoikaika nui.
|
|
300
|
+
|
|
301
|
+
Paʻa ka cache paʻamau, akā ʻaʻole hana maikaʻi inā he nui kāu mau hana kākau/wehe.
|
|
302
|
+
Hoʻopau ka hana kākau a wehe paha i ka cache holoʻokoʻa, e hōʻoia ana e ʻike ʻia nā heluhelu ma hope
|
|
303
|
+
nā hoʻololi hou.
|
|
304
|
+
|
|
305
|
+
### mea hana CLI
|
|
306
|
+
Inā ʻoe e hoʻohana nei i kahi mea hana CLI e like me [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
Makemake ʻoe e hoʻohana ʻia ka cache redis, no ka mea e mau ana ia ma nā ʻōlelo ʻana o ke kauoha `mo` .
|
|
308
|
+
|
|
309
|
+
## Ke aniani ana
|
|
310
|
+
|
|
311
|
+
// Copy a local filesystem mobiletto to S3
|
|
312
|
+
s3.mirror(local)
|
|
313
|
+
|
|
314
|
+
// Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
|
|
315
|
+
local.mirror(s3, 'some/local-folder', 'some/s3-folder')
|
|
316
|
+
|
|
317
|
+
Hoʻohana ke kauoha `mirror` i hoʻokahi kope o nā faila a pau mai kekahi mobiletto a i kekahi.
|
|
318
|
+
ʻAʻole ia e holo i kekahi kaʻina hana e mālama i ke aniani i ka manawa. E holo hou i ke kauoha `mirror`
|
|
319
|
+
e hoʻonohonoho i nā faila i nalowale.
|
|
320
|
+
|
|
321
|
+
ʻO ka waiwai hoʻihoʻi mai `mirror` ' he mea maʻalahi me nā helu helu no ka nui o nā faila i kūleʻa
|
|
322
|
+
aniani a me ka nui o nā faila i hewa:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
'Ōlelo Aʻo: ʻO ke aniani ʻana i nā pūʻulu ʻikepili nui hiki ke hoʻopau i ka manawa a me ka nui o ka bandwidth
|
|
330
|
+
|
|
331
|
+
Me ka `mirror` call semantics hiki ke huikau i kekahi manawa ke maopopo ʻo wai ka
|
|
332
|
+
mea heluhelu a ʻo wai ka mea kākau. E noʻonoʻo ʻoe e like me ka ʻōlelo kuhikuhi: ka "lima hema mobiletto"
|
|
333
|
+
ʻo ia ka mea i hāʻawi ʻia i (ka ʻikepili aniani i kākau ʻia), a me ka "mobiletto lima ʻākau" (ka
|
|
334
|
+
ʻO ka hoʻopaʻapaʻa i ke `mirror` ') ʻo ia ka waiwai i hāʻawi ʻia (heluhelu ʻia ka ʻike aniani).
|
|
335
|
+
|
|
336
|
+
## Hoʻopili paʻa
|
|
337
|
+
E ho'ā i ka hoʻopunipuni ʻaoʻao o nā mea kūʻai aku:
|
|
338
|
+
|
|
339
|
+
// Pass encryption parameters
|
|
340
|
+
const encryption = {
|
|
341
|
+
// key is required, must be >= 16 chars
|
|
342
|
+
key: randomstring.generate(128),
|
|
343
|
+
|
|
344
|
+
// optional, the default is to derive IV from key
|
|
345
|
+
// when set, IV must be >= 16 chars
|
|
346
|
+
iv: randomstring.generate(128),
|
|
347
|
+
|
|
348
|
+
// optional, the default is aes-256-cbc
|
|
349
|
+
algo: 'aes-256-cbc'
|
|
350
|
+
}
|
|
351
|
+
const api = await mobiletto(driverName, key, secret, opts, encryption)
|
|
352
|
+
|
|
353
|
+
// Subsequent write operations will encrypt data (client side) when writing
|
|
354
|
+
// Subsequent read operations will decrypt data (client side) when reading
|
|
355
|
+
|
|
356
|
+
He aha ka hana? Hoʻokaʻawale ʻia kahi papa kuhikuhi "hoʻokomo" (dirent) (hoʻopili ʻia) i nā faila i loko
|
|
357
|
+
directory (aka the dirent directory).
|
|
358
|
+
* Heluhelu ke kauoha `list` i nā faila hoʻokomo papa kuhikuhi, wehe i kēlā me kēia ala i helu ʻia; a laila hoʻihoʻi i ka metadata no kēlā me kēia faila
|
|
359
|
+
* ʻOi aku ka maikaʻi ʻole o nā kauoha `list` , ʻoi aku hoʻi no nā papa kuhikuhi me ka nui o nā faila
|
|
360
|
+
* ʻO ke kauoha `write` e kākau i nā faila i loko o ka papa kuhikuhi kuhikuhi o kēlā me kēia makua, me ka recursively; a laila kākau i ka faila
|
|
361
|
+
* E loaʻa i nā kauoha `write` O(N) kākau, me ka N = hohonu i ka hierarchy papa kuhikuhi.
|
|
362
|
+
* Na ke kauoha `remove` e wehe i ka faila dirent e pili ana, a me kona makua ina nele, me ka recursively; a laila wehe i ka faila
|
|
363
|
+
* ʻO nā kauoha `remove` e hoʻihoʻi hou e loaʻa iā O(N) heluhelu a hiki i ka nui o nā holoi ʻana, me ka N = hohonu i ka hierarchy papa kuhikuhi.
|
|
364
|
+
* Hiki ke pipiʻi i nā kauoha `remove` ma nā ʻōnaehana waihona nui a hohonu
|
|
365
|
+
|
|
366
|
+
E hoʻomanaʻo, ʻoiai me ka hoʻopili ʻana i ka ʻaoʻao o ka mea kūʻai aku, he ʻenemi me ka ʻike piha i kāu ʻaoʻao kikowaena i hoʻopili ʻia.
|
|
367
|
+
waihona, ʻoiai me ka ʻole o ke kī, hiki ke ʻike i ka huina o nā papa kuhikuhi a me ka nui o nā faila i kēlā me kēia, a me
|
|
368
|
+
i kekahi hana, e ʻike i kekahi a i ʻole ka ʻōnaehana holoʻokoʻa o ka hierarchy papa kuhikuhi.
|
|
369
|
+
*E hoʻomaopopo: E hoʻohana i kahi hale palahalaha no ka palekana maikaʻi.*
|
|
370
|
+
ʻAʻole ʻike ka ʻenemi i nā inoa o nā papa kuhikuhi/faila ke ʻole lākou i ʻike i kāu hoʻopunipuni
|
|
371
|
+
kī a i ʻole ua haki ʻia ka hoʻopunipuni. Pau nā pili a pau ia manawa!
|
|
372
|
+
|
|
373
|
+
### Ka hana a me ka hoʻopaʻa ʻana
|
|
374
|
+
Hiki ke lohi nā hana ma ka waihona i hoʻopili ʻia. Hiki ke lohi loa nā papa inoa recursive a me ka wehe ʻana.
|
|
375
|
+
He kōkua nui ka hoʻokahe ʻana ma o redis, akā e hoʻomanaʻo e hoʻoheheʻe ʻia ka cache ma luna o nā mea kākau a wehe paha.
|
|
376
|
+
|
|
377
|
+
## Hoʻololi kī
|
|
378
|
+
E hana i mobiletto me kāu kī hou, a laila e hoʻohālike i ka ʻikepili kahiko i loko:
|
|
379
|
+
|
|
380
|
+
const storage = require('mobiletto')
|
|
381
|
+
|
|
382
|
+
const oldEncryption = { key: .... }
|
|
383
|
+
const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
|
|
384
|
+
|
|
385
|
+
const newEncryption = { key: .... }
|
|
386
|
+
const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
|
|
387
|
+
|
|
388
|
+
newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
|
|
389
|
+
|
|
390
|
+
## Hoʻokele hoʻokele
|
|
391
|
+
ʻO ka mea hoʻokele ka waihona JS e hoʻokuʻu aku i kahi hana 'storageClient' me kēia pūlima:
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` : he kaula, kāu kī API (no ka mea hoʻokele `local` ʻo ia ka papa kuhikuhi kumu)
|
|
396
|
+
* `secret` : he kaula, kāu mea huna API (hiki ke waiho ʻia no ka mea hoʻokele `local` )
|
|
397
|
+
* `opts` : he mea, aia nā waiwai i kēlā me kēia mea hoʻokele:
|
|
398
|
+
* No `local` , nā `fileMode` a me `dirMode` e ho'oholo i ka hana 'ana i nā faila a me nā papa kuhikuhi hou.
|
|
399
|
+
* No `s3` , pono ka waiwai `bucket` . ʻO nā waiwai koho:
|
|
400
|
+
* `region`: the S3 region, default is us-east-1
|
|
401
|
+
* `prefix`: a prefix to prepend to all S3 paths, default is the empty string
|
|
402
|
+
* `delimiter`: the directory delimiter, default is '/'
|
|
403
|
+
|
|
404
|
+
Pono ka mea i hoʻihoʻi ʻia e ka storageClient i kēia mau hana:
|
|
405
|
+
|
|
406
|
+
// Test the driver before using, ensure proper configuration
|
|
407
|
+
async testConfig ()
|
|
408
|
+
|
|
409
|
+
// List files in path (or from base-directory)
|
|
410
|
+
// If recursive is true, list recursively
|
|
411
|
+
// If visitor is defined, it will be an async function. await the visitor function on each file found
|
|
412
|
+
// Otherwise, perform the listing and return an array of objects
|
|
413
|
+
async list (path, recursive = false, visitor = null) // path may be omitted
|
|
414
|
+
|
|
415
|
+
// Read metadata for a path
|
|
416
|
+
async metadata (path)
|
|
417
|
+
|
|
418
|
+
// Read a file
|
|
419
|
+
// callback receives a chunk of data. endCallback is called at end-of-stream
|
|
420
|
+
async read (path, callback, endCallback = null)
|
|
421
|
+
|
|
422
|
+
// Write a file
|
|
423
|
+
// driver must be able to handle a generator or a stream
|
|
424
|
+
async write (path, generatorOrReadableStream)
|
|
425
|
+
|
|
426
|
+
// Remove a file, or recursively delete a directory
|
|
427
|
+
// returns a string of a single path removed, or an array of multiple paths removed
|
|
428
|
+
async remove (path, recursive = false, quiet = false)
|
|
429
|
+
|
|
430
|
+
## Hoʻopaʻa inoa
|
|
431
|
+
Hoʻohana ʻo Mobiletto i ka waihona logging [winston](https://www.npmjs.com/package/winston).
|
|
432
|
+
|
|
433
|
+
Loaʻa i nā moʻolelo ** nā ala faila a me nā memo hewa, akā ʻaʻole ** loaʻa nā kī, nā mea huna,
|
|
434
|
+
a i ʻole kekahi ʻike hoʻonohonoho pili.
|
|
435
|
+
|
|
436
|
+
### Papa helu
|
|
437
|
+
E hoʻohana i ka `MOBILETTO_LOG_LEVEL` hoʻololi kaiapuni no ka hoʻonohonoho ʻana i ka pae log, me ka hoʻohana ʻana i kekahi
|
|
438
|
+
o nā pae `npm` i wehewehe ʻia ma [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
439
|
+
|
|
440
|
+
ʻO ka pae paʻamau ʻo `error` . ʻO ka pae haʻihaʻi loa ʻo `silly` , ʻoiai he mobiletto i kēia manawa
|
|
441
|
+
ʻaʻole i hoʻopaʻa inoa ma nā pae ma lalo o `debug`
|
|
442
|
+
|
|
443
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
444
|
+
|
|
445
|
+
### Waihona moʻolelo
|
|
446
|
+
Ma ka paʻamau, kākau ka mea logger i ka console. No ka hoʻouna ʻana i nā moʻolelo i kahi faila, hoʻonohonoho i ka `MOBILETTO_LOG_FILE`
|
|
447
|
+
hoʻololi kaiapuni. Ke hoʻopaʻa inoa nei i kahi faila, ʻaʻole e kākau hou ʻia nā lāʻau i ka console.
|
|
448
|
+
|
|
449
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
450
|
+
|
|
451
|
+
E hoʻopau i ka hoʻopaʻa inoa ʻana:
|
|
452
|
+
|
|
453
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
454
|
+
|
|
455
|
+
</pre>
|