mobiletto 1.1.9 → 1.1.12

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.
Files changed (117) hide show
  1. package/README.md +82 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +32 -16
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,481 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mae Mobiletto yn haen tynnu storio JavaScript, gydag amgryptio ochr y cleient tryloyw dewisol.
5
+
6
+ # Cynnwys
7
+ * [Pam Mobiletto?](#Pam-Mobiletto?)
8
+ * [Cychwyn cyflym](#cychwyn cyflym)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Ffynhonnell](#Ffynhonnell)
11
+ * [Gosod](# Gosod)
12
+ * [Cymorth a Chyllido](#Cymorth-a-Cyllid)
13
+ * [Defnydd sylfaenol](#-defnydd sylfaenol)
14
+ * [Metadata](#Metadata)
15
+ * [Arddull mewnforio amgen](# amgen-mewnforio-arddull)
16
+ * [Casio](#Caching)
17
+ * [Drych](#Drych)
18
+ * [Amgryptio tryloyw](# Tryloyw-amgryptio)
19
+ * [Cylchdro allweddol](# Key-cylchdro)
20
+ * [Rhyngwyneb gyrrwr](# rhyngwyneb gyrrwr)
21
+ * [Logio](#Logio)
22
+
23
+ # Darllenwch hwn mewn iaith arall
24
+ Mae'r ddogfen README.md hon wedi'i chyfieithu, trwy [hokeylization](https://github.com/cobbzilla/hokeylization), i mewn i
25
+ **[pob iaith a gefnogir gan Google Translate]( https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Rwy'n sicr nad yw'n berffaith, ond gobeithio ei fod yn well na dim!
28
+
29
+ [🇸🇦 Arabeg](../ar/README.md)
30
+ [🇧🇩 Bengaleg](../bn/README.md)
31
+ [🇩🇪 Almaeneg](../de/README.md)
32
+ [🇺🇸 Saesneg](../cy/README.md)
33
+ [🇪🇸 Sbaeneg](../es/README.md)
34
+ [🇫🇷 Ffrangeg](../fr/README.md)
35
+ [🇹🇩 Hawsa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 Indoneseg](../id/README.md)
38
+ [🇮🇹 Eidaleg](../it/README.md)
39
+ [🇯🇵 Japaneaidd](../ja/README.md)
40
+ [🇰🇷 Corea](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 Pwyleg](../pl/README.md)
43
+ [🇧🇷 Portiwgaleg](../pt/README.md)
44
+ [🇷🇺 Rwsieg](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 Twrceg](../tr/README.md)
48
+ [🇵🇰 Wrdw](../ur/README.md)
49
+ [🇻🇳 Fietnameg](../vi/README.md)
50
+ [🇨🇳 Tsieinëeg](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Pob Iaith ...](../README.md)**
54
+ ----
55
+
56
+ ### A oes problem gyda'r cyfieithiad hwn o'r README?
57
+ Mae'r cyfieithiad penodol hwn o'r [README] gwreiddiol ( https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ gall fod yn ddiffygiol -- *mae croeso mawr i gywiriadau!* Anfonwch [cais tynnu ar GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ neu os nad ydych chi'n gyfforddus yn gwneud hynny, [agorwch broblem]( https://github.com/cobbzilla/mobiletto/issues )
60
+
61
+ Pan fyddwch chi'n creu rhifyn GitHub newydd am gyfieithiad, gwnewch y canlynol:
62
+ * cynnwys URL y dudalen (copïo / pastio o far cyfeiriad y porwr)
63
+ * cynnwys yr union destun sy'n anghywir (copïo / pastio o'r porwr)
64
+ * disgrifiwch beth sy'n bod -- ydy'r cyfieithiad yn anghywir? a yw'r fformatio wedi torri rhywsut?
65
+ * cynigiwch yn garedig awgrym o well cyfieithiad, neu sut y dylid fformatio'r testun yn gywir
66
+ * **Diolch!**
67
+
68
+ ## Pam Mobiletto?
69
+
70
+ ### Hwyl fawr i'r gwerthwr cloi i mewn!
71
+ Mae gan y gwahanol ddarparwyr storio cwmwl APIs anghydnaws. Hyd yn oed y rhai sy'n ymdrechu am "gydnawsedd S3"
72
+ yn meddu ar ymddygiadau idiosyncratig.
73
+
74
+ Pan fyddwch chi'n dewis gwerthwr storio penodol ar gyfer eich app, os ydych chi'n codio'n uniongyrchol i'w API, eich app
75
+ bellach yn ddibynnol ar y gwasanaeth hwnnw. Wrth i amser fynd heibio ac i'r cod gronni, daw gwerthwyr sy'n newid
76
+ yn gynyddol anghynaladwy. Croeso i fyd hwyliog cloi i mewn i werthwyr!
77
+
78
+ Cynlluniwyd Mobiletto i ddatrys y broblem hon. Trwy godio'ch ap i API mobiletto, gallwch chi'n hawdd
79
+ newid darparwyr storio a gwybod y bydd haen storio eich app yn ymddwyn yn union yr un fath.
80
+
81
+ ### Profi helaeth
82
+ Mae pob gyrrwr yn cael ei brofi am yr un ymddygiad gyda 60+ o brofion ar gyfer pob gyrrwr.
83
+ Rydym yn profi pob gyrrwr gyda phob cyfuniad o:
84
+ * Amgryptio: wedi'i alluogi a'i anabl
85
+ * cache Redis: wedi'i alluogi a'i anabl
86
+
87
+ Mae'r dull hwn yn rhoi tawelwch meddwl i ni y bydd mobiletto yn ymddwyn yr un fath ni waeth pa yrrwr rydych chi'n ei ddefnyddio,
88
+ ac ni waeth a ydych yn galluogi caching a/neu amgryptio.
89
+
90
+ ### Cefnogaeth gyrrwr
91
+ Gyrwyr storio Mobiletto cyfredol:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Blaze B2
94
+ * `local` : system ffeiliau leol
95
+
96
+ *Mae croeso mawr i gyfraniadau i gefnogi mwy o ddarparwyr storio cwmwl!*
97
+
98
+ ## symudoltto-cli
99
+ Bwriedir i Mobiletto gael ei ddefnyddio fel llyfrgell gan god JavaScript arall.
100
+
101
+ I weithio gyda mobiletto yn y llinell orchymyn, defnyddiwch [mobiletto-cli]( https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Ffynhonnell
104
+ * [mobiletto ar GitHub]( https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto ar npm]( https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Cefnogaeth a Chyllid
108
+ Rwy'n ceisio bod yn ddatblygwr meddalwedd ffynhonnell agored proffesiynol. Rwyf wedi bod yn gweithio yn
109
+ y diwydiant meddalwedd ers blynyddoedd lawer, rwyf wedi dechrau cwmnïau llwyddiannus ac wedi eu gwerthu i gwmnïau cyhoeddus.
110
+ Yn ddiweddar collais fy swydd, ac nid oes gennyf unrhyw waith arall wedi'i drefnu
111
+
112
+ Felly rydw i'n mynd i geisio ysgrifennu meddalwedd defnyddiol a gweld a yw hynny'n gweithio
113
+
114
+ Os ydych chi'n mwynhau defnyddio'r feddalwedd hon, byddwn yn ddiolchgar iawn am hyd yn oed y
115
+ lleiaf [cyfraniad misol trwy Patreon]( https://www.patreon.com/cobbzilla)
116
+
117
+ *Diolch!*
118
+
119
+ ## Gosod
120
+ Gosod gan ddefnyddio `npm` neu `yarn` . Mae'n debyg eich bod chi eisiau'r fersiwn `lite` nad yw'n cynnwys yr holl
121
+ ffeiliau README wedi'u cyfieithu:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Os ydych chi wir eisiau'r ffeiliau README ym mhob iaith, gosodwch y fersiwn lawn:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Cychwyn Cyflym
132
+ Enghraifft fer yn defnyddio'r gyrrwr `s3` .
133
+
134
+ Byddai'r cod hwn yn rhedeg yr un peth pe bai'r gyrrwr yn `b2` neu `local` .
135
+
136
+ const storage = require('mobiletto')
137
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
+
139
+ // list objects: returns array of metadata objects
140
+ const listing = await bucket.list()
141
+ const dirList = await bucket.list('some/dir/')
142
+ const everything = await bucket.list('', {recursive: true})
143
+
144
+ // write an entire file
145
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
+
147
+ // write a file from a stream/generator
148
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
+
150
+ // read an entire file
151
+ // returns null if an exception would otherwise be thrown
152
+ const bufferOrNull = await bucket.safeReadFile('some/path')
153
+
154
+ // stream-read a file, passing data to callback
155
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
+
157
+ // remove a file, returns the path removed
158
+ let removed = await bucket.remove('some/path') // removed is a string
159
+
160
+ // remove a directory, returns array of paths removed
161
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
+
163
+ ----
164
+ ## Defnydd sylfaenol
165
+ Enghraifft llawer mwy helaeth, yn dangos y rhan fwyaf o'r nodweddion a gynigir:
166
+
167
+ const { mobiletto } = require('mobiletto')
168
+
169
+ // General usage
170
+ const api = await mobiletto(driverName, key, secret, opts)
171
+
172
+ // To use 'local' driver:
173
+ // * key: base directory
174
+ // * secret: ignored, can be null
175
+ // * opts object:
176
+ // * readOnly: optional, never change anything on the filesystem; default is false
177
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
+
181
+ // To use 's3' driver:
182
+ // * key: AWS Access Key ID
183
+ // * secret: AWS Secret Key
184
+ // * opts object:
185
+ // * readOnly: optional, never change anything on the bucket; default is false
186
+ // * bucket: required, name of the S3 bucket
187
+ // * region: optional, the AWS region to communicate with, default is us-east-1
188
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
+
192
+ // To use 'b2' driver:
193
+ // * key: Backblaze Key ID
194
+ // * secret: Backblaze Application Key
195
+ // * opts object:
196
+ // * readOnly: optional, never change anything on the bucket; default is false
197
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
198
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
+ // * partSize: optional, large files will be split into chunks of this size when uploading
201
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
+
203
+ // List files
204
+ api.list() // --> returns an array of metadata objects
205
+
206
+ // List files recursively
207
+ api.list({ recursive: true })
208
+
209
+ // List files in a directory
210
+ const path = 'some/path'
211
+ api.list(path)
212
+ api.list(path, { recursive: true }) // also supports recursive flag
213
+
214
+ // Visit files in a directory -- visitor function must be async
215
+ api.list(path, { visitor: myAsyncFunc })
216
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
217
+
218
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
219
+ // When you call `safeList` on a non-existent path, it returns an empty array
220
+ api.safeList('/path/that/does/not/exist') // returns []
221
+
222
+ // Read metadata for a file
223
+ api.metadata(path) // returns metadata object
224
+
225
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
+ // When you call `safeMetadata` on a non-existent path, it returns null
227
+ api.safeMetadata('/tmp/does_not_exist') // returns null
228
+
229
+ // Read a file
230
+ // Provide a callback that writes the data someplace
231
+ const callback = (chunk) => { ... write chunk somewhere ... }
232
+ api.read(path, callback) // returns count of bytes read
233
+
234
+ // Read an entire file at once
235
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
+
237
+ // Read an entire file at once
238
+ // returns null if an exception would otherwise be thrown
239
+ const bufferOrNull = await bucket.safeReadFile('some/path')
240
+
241
+ // Write a file
242
+ // Provide a generator function that yields chunks of data
243
+ const generator = function* () {
244
+ while ( ... more-data-to-return ... ) {
245
+ data = ... load-data ...
246
+ yield data
247
+ }
248
+ }
249
+ local.api(path, generator) // returns count of bytes written
250
+
251
+ // Write an entire file at once (convenience method)
252
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
253
+
254
+ // Delete a file
255
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
+ // Always returns a value or throws an error.
257
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
+ const quiet = true
259
+ api.remove(path, {quiet}) // returns single path removed
260
+
261
+ // Recursively delete a directory and do it quietly (do not report errors)
262
+ const recursive = true
263
+ const quiet = true
264
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
265
+
266
+ ## Metadata
267
+ Mae'r gorchymyn `metadata` yn dychwelyd metadata am un cofnod system ffeiliau.
268
+ Yn yr un modd, mae'r gwerth dychwelyd o'r gorchymyn `list` yn amrywiaeth o wrthrychau metadata.
269
+
270
+ Mae gwrthrych metadata yn edrych fel hyn:
271
+
272
+ {
273
+ "name": "fully/qualified/path/to/file",
274
+ "type": "entry-type",
275
+ "size": size-in-bytes,
276
+ "ctime": creation-time-epoch-millis,
277
+ "mtime": modification-time-epoch-millis
278
+ }
279
+
280
+ Gall yr eiddo `type` fod yn `file` , `dir` , `link` , neu `special` .
281
+
282
+ Yn dibynnu ar y math o yrrwr, efallai na fydd gorchymyn `list` yn dychwelyd pob maes. `name` a `type`
283
+ dylai fod yn bresennol bob amser. Bydd gorchymyn `metadata` dilynol yn dychwelyd yr holl briodweddau sydd ar gael.
284
+
285
+ ## Arddull mewnforio amgen
286
+ Mewnforiwch y modiwl â chwmpas llawn a defnyddiwch y swyddogaeth `connect` :
287
+
288
+ const storage = require('mobiletto')
289
+ const opts = {bucket: 'bk', region: 'us-east-1'}
290
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
+ const objectData = await s3.readFile('some/path')
292
+
293
+ ## Caching
294
+ Mae Mobiletto yn gweithio orau gyda storfa <a href="https://redis.io">redis</a> .
295
+
296
+ Bydd Mobiletto yn ceisio cysylltu ag enghraifft redis ar 127.0.0.1:6379
297
+
298
+ Gallwch ddiystyru unrhyw un o'r rhain:
299
+ * Gosodwch yr amg var `MOBILETTO_REDIS_HOST` , mobileto cysylltu yma yn lle localhost
300
+ * Gosodwch yr env var `MOBILETTO_REDIS_PORT` , bydd y porth hwn yn cael ei ddefnyddio
301
+
302
+ Bydd Mobiletto yn storio ei holl allweddi redis gyda'r rhagddodiad `_mobiletto__` . Gallwch chi newid hyn
303
+ trwy osod y `MOBILETTO_REDIS_PREFIX` var.
304
+
305
+ Gallwch hefyd osod caching fesul-cysylltiad gyda'r gwrthrych `opts.redisConfig` :
306
+
307
+ const redisConfig = {
308
+ enabled: true, // optional, default is true. if false other props are ignored
309
+ host: '127.0.0.1',
310
+ port: 6379,
311
+ prefix: '_mobiletto__'
312
+ }
313
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
+
316
+ ### Ddim eisiau caching redis?
317
+ I analluogi: pasiwch `enabled: false` yn eich gwrthrych `opts.redisConfig` pan fyddwch yn sefydlu'ch cysylltiad.
318
+
319
+ Fel y trafodir isod, bydd analluogi caching yn cael effaith andwyol ar berfformiad ac yn arwain at fwy o geisiadau
320
+ i storio y mae gwir angen ichi.
321
+
322
+ ### Canllawiau caching
323
+ **Storfa wedi'i hamgryptio**: dim ond ychydig yn arafach na'r arfer y mae storfa wedi'i hamgryptio darllen/ysgrifennu,
324
+ ond mae llywio o gwmpas cyfeirlyfrau (y mae rhai pethau'n ei wneud) yn weddol ddrud. Gan ddefnyddio storfa redis
325
+ yn rhoi hwb perfformiad sylweddol i chi.
326
+
327
+ Mae'r storfa ddiofyn yn ddiogel, ond nid yw'n perfformio'n dda os oes gennych lawer o weithrediadau ysgrifennu / dileu.
328
+ Mae unrhyw weithred ysgrifennu neu ddileu yn annilysu'r storfa gyfan, gan sicrhau y bydd darlleniadau dilynol yn gweld y
329
+ newidiadau diweddaraf.
330
+
331
+ ### offer CLI
332
+ Os ydych chi'n defnyddio teclyn CLI fel [mobiletto-cli]( https://www.npmjs.com/package/mobiletto-cli),
333
+ byddwch yn bendant am i'r storfa redis alluogi, gan ei fod yn para ar draws galwadau o'r gorchymyn `mo` .
334
+
335
+ ## Drychio
336
+
337
+ // Copy a local filesystem mobiletto to S3
338
+ s3.mirror(local)
339
+
340
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
+
343
+ Mae'r gorchymyn `mirror` yn perfformio copi un-amser o'r holl ffeiliau o un ffôn symudol i un arall.
344
+ Nid yw'n rhedeg unrhyw broses i gynnal y drych dros amser. Rhedeg y gorchymyn `mirror` eto
345
+ i gysoni unrhyw ffeiliau coll.
346
+
347
+ Mae'r gwerth dychwelyd o `mirror` yn wrthrych syml gyda rhifyddion ar gyfer faint o ffeiliau oedd yn llwyddiannus
348
+ wedi'i adlewyrchu a faint o ffeiliau oedd â gwallau:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ RHYBUDD: Gall adlewyrchu setiau data mawr gymryd llawer iawn o amser a lled band-ddwys
356
+
357
+ Gyda’r alwad `mirror` yn semanteg weithiau gall fod yn ddryslyd deall pwy yw’r
358
+ darllenydd a phwy yw yr ysgrifenydd. Dychmygwch ef fel datganiad aseiniad: y "mobileto llaw chwith"
359
+ yw'r peth sy'n cael ei neilltuo i (drych data ysgrifenedig), a'r "de-law mobiletto" (y
360
+ dadl i'r dull `mirror` ) yw'r gwerth sy'n cael ei neilltuo (darllenir data drych).
361
+
362
+ ## Amgryptio tryloyw
363
+ Galluogi amgryptio ochr cleient tryloyw:
364
+
365
+ // Pass encryption parameters
366
+ const encryption = {
367
+ // key is required, must be >= 16 chars
368
+ key: randomstring.generate(128),
369
+
370
+ // optional, the default is to derive IV from key
371
+ // when set, IV must be >= 16 chars
372
+ iv: randomstring.generate(128),
373
+
374
+ // optional, the default is aes-256-cbc
375
+ algo: 'aes-256-cbc'
376
+ }
377
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
378
+
379
+ // Subsequent write operations will encrypt data (client side) when writing
380
+ // Subsequent read operations will decrypt data (client side) when reading
381
+
382
+ Beth sy'n Digwydd? Mae cyfeiriadur "mynediad cyfeiriadur" (cyfeirlyfr) ar wahân (wedi'i amgryptio) yn olrhain pa ffeiliau sydd ynddo
383
+ cyfeiriadur (aka y cyfeiriadur uniongyrchol).
384
+ * Mae'r gorchymyn `list` yn darllen y ffeiliau mynediad cyfeiriadur, yn dadgryptio pob llwybr a restrir; yna'n dychwelyd metadata ar gyfer pob ffeil
385
+ * Mae gorchmynion `list` yn fwy aneffeithlon, yn enwedig ar gyfer cyfeiriaduron gyda nifer fawr o ffeiliau
386
+ * Mae'r gorchymyn `write` ysgrifennu` yn ysgrifennu ffeiliau uniongyrchol yng nghyfeirlyfr uniongyrchol pob rhiant, yn rheolaidd; wedyn yn ysgrifennu'r ffeil
387
+ * Bydd gorchmynion `write` yn arwain at O(N) yn ysgrifennu, gydag N = dyfnder yn hierarchaeth y cyfeiriadur
388
+ * Mae'r gorchymyn `remove` yn dileu'r ffeil uniongyrchol gyfatebol, a'i riant os yw'n wag, yn ailadroddus; yna yn tynnu'r ffeil
389
+ * Bydd gorchmynion `remove` nad ydynt yn ailadroddus yn golygu darlleniadau O(N) ac o bosibl cymaint o ddileu, gyda N = dyfnder yn hierarchaeth y cyfeiriadur
390
+ * Gall gorchmynion `remove` ar systemau ffeiliau mawr a dwfn fod yn ddrud
391
+
392
+ Sylwch, hyd yn oed gydag amgryptio ochr cleient wedi'i alluogi, gwrthwynebydd gyda gwelededd llawn i ochr eich gweinydd wedi'i amgryptio
393
+ storio, hyd yn oed heb yr allwedd, yn dal i allu gweld cyfanswm nifer y cyfeiriaduron a faint o ffeiliau sydd ym mhob un, a gyda
394
+ rhywfaint o ymdrech, darganfod rhywfaint neu'r cyfan o strwythur cyffredinol yr hierarchaeth gyfeiriadur.
395
+ *Sylwer: Defnyddiwch strwythur gweddol wastad ar gyfer gwell diogelwch.*
396
+ Ni fyddai'r gwrthwynebydd yn gwybod enwau'r cyfeiriaduron/ffeiliau oni bai ei fod hefyd yn gwybod eich amgryptio
397
+ allweddol neu wedi cracio'r amgryptio yn llwyddiannus fel arall. Mae pob bet i ffwrdd felly!
398
+
399
+ ### Perfformiad a caching
400
+ Gall gweithrediadau ar storfa wedi'i hamgryptio fod yn araf. Gall rhestrau ailadroddus a dileu fod yn araf iawn.
401
+ Mae cadw trwy redis yn help aruthrol, ond sylwch fod y storfa'n cael ei fflysio ar unrhyw beth sy'n cael ei ysgrifennu neu ei ddileu.
402
+
403
+ ## Cylchdro allweddol
404
+ Creu mobiletto gyda'ch allwedd newydd, yna drychwch yr hen ddata ynddo:
405
+
406
+ const storage = require('mobiletto')
407
+
408
+ const oldEncryption = { key: .... }
409
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
+
411
+ const newEncryption = { key: .... }
412
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
+
414
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
+
416
+ ## rhyngwyneb gyrrwr
417
+ Gyrrwr yw unrhyw ffeil JS sy'n allforio swyddogaeth 'storageClient' gyda'r llofnod hwn:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : llinyn, eich allwedd API (ar gyfer y gyrrwr `local` dyma'r cyfeiriadur sylfaenol)
422
+ * `secret` : llinyn, eich cyfrinach API (gellir ei hepgor ar gyfer y gyrrwr `local` )
423
+ * `opts` : gwrthrych, mae'r priodweddau fesul gyrrwr:
424
+ * Ar gyfer `local` , mae'r `fileMode` a `dirMode` yn pennu sut mae ffeiliau a chyfeiriaduron creu newydd yn cael eu creu
425
+ * Ar gyfer `s3` , mae angen yr eiddo `bucket` . Priodweddau dewisol yw:
426
+ * `region`: the S3 region, default is us-east-1
427
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
+ * `delimiter`: the directory delimiter, default is '/'
429
+
430
+ Rhaid i'r gwrthrych y mae'r swyddogaeth storageClient yn ei ddychwelyd ddiffinio'r swyddogaethau hyn:
431
+
432
+ // Test the driver before using, ensure proper configuration
433
+ async testConfig ()
434
+
435
+ // List files in path (or from base-directory)
436
+ // If recursive is true, list recursively
437
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
438
+ // Otherwise, perform the listing and return an array of objects
439
+ async list (path, recursive = false, visitor = null) // path may be omitted
440
+
441
+ // Read metadata for a path
442
+ async metadata (path)
443
+
444
+ // Read a file
445
+ // callback receives a chunk of data. endCallback is called at end-of-stream
446
+ async read (path, callback, endCallback = null)
447
+
448
+ // Write a file
449
+ // driver must be able to handle a generator or a stream
450
+ async write (path, generatorOrReadableStream)
451
+
452
+ // Remove a file, or recursively delete a directory
453
+ // returns a string of a single path removed, or an array of multiple paths removed
454
+ async remove (path, recursive = false, quiet = false)
455
+
456
+ ## Logio
457
+ Mae Mobiletto yn defnyddio llyfrgell logio [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Bydd logiau ** yn cynnwys llwybrau ffeil a negeseuon gwall, ond ni fydd **byth** yn cynnwys allweddi, cyfrinachau,
460
+ neu unrhyw wybodaeth cyfluniad cysylltiad arall.
461
+
462
+ ### Lefel log
463
+ Defnyddiwch y newidyn amgylchedd `MOBILETTO_LOG_LEVEL` i osod lefel y log, gan ddefnyddio un
464
+ o'r lefelau `npm` a ddiffinnir yn [https://www.npmjs.com/package/winston#logging-levels]( https://www.npmjs.com/package/winston#logging-levels )
465
+
466
+ Y lefel ddiofyn yw `error` . Y lefel fwyaf llafar yw `silly` , er yn mobiletto ar hyn o bryd
467
+ ddim yn mewngofnodi ar lefelau islaw `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Ffeil log
472
+ Yn ddiofyn, mae'r cofnodwr yn ysgrifennu at y consol. I anfon logiau i ffeil, gosodwch y `MOBILETTO_LOG_FILE`
473
+ newidyn amgylchedd. Wrth fewngofnodi i ffeil, ni fydd logiau'n cael eu hysgrifennu i'r consol mwyach.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ I ddiffodd y logio:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>