mobiletto 1.1.10 → 1.1.13
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 +74 -0
- package/docs/README.md +113 -0
- package/docs/af/README.md +481 -0
- package/docs/am/README.md +481 -0
- package/docs/ar/README.md +481 -0
- package/docs/az/README.md +481 -0
- package/docs/be/README.md +481 -0
- package/docs/bg/README.md +481 -0
- package/docs/bn/README.md +481 -0
- package/docs/bs/README.md +481 -0
- package/docs/ca/README.md +481 -0
- package/docs/ceb/README.md +481 -0
- package/docs/co/README.md +481 -0
- package/docs/cs/README.md +481 -0
- package/docs/cy/README.md +481 -0
- package/docs/da/README.md +481 -0
- package/docs/de/README.md +481 -0
- package/docs/el/README.md +481 -0
- package/docs/eo/README.md +481 -0
- package/docs/es/README.md +481 -0
- package/docs/et/README.md +481 -0
- package/docs/eu/README.md +481 -0
- package/docs/fa/README.md +481 -0
- package/docs/fi/README.md +481 -0
- package/docs/fr/README.md +481 -0
- package/docs/fy/README.md +481 -0
- package/docs/ga/README.md +481 -0
- package/docs/gd/README.md +481 -0
- package/docs/gl/README.md +481 -0
- package/docs/gu/README.md +481 -0
- package/docs/ha/README.md +481 -0
- package/docs/haw/README.md +481 -0
- package/docs/he/README.md +481 -0
- package/docs/hi/README.md +481 -0
- package/docs/hmn/README.md +481 -0
- package/docs/hr/README.md +481 -0
- package/docs/ht/README.md +481 -0
- package/docs/hu/README.md +481 -0
- package/docs/hy/README.md +481 -0
- package/docs/id/README.md +481 -0
- package/docs/ig/README.md +481 -0
- package/docs/is/README.md +481 -0
- package/docs/it/README.md +481 -0
- package/docs/iw/README.md +481 -0
- package/docs/ja/README.md +481 -0
- package/docs/jv/README.md +481 -0
- package/docs/ka/README.md +481 -0
- package/docs/kk/README.md +481 -0
- package/docs/km/README.md +481 -0
- package/docs/kn/README.md +481 -0
- package/docs/ko/README.md +481 -0
- package/docs/ku/README.md +481 -0
- package/docs/ky/README.md +481 -0
- package/docs/la/README.md +481 -0
- package/docs/lb/README.md +481 -0
- package/docs/lo/README.md +481 -0
- package/docs/lt/README.md +481 -0
- package/docs/lv/README.md +481 -0
- package/docs/mg/README.md +481 -0
- package/docs/mi/README.md +481 -0
- package/docs/mk/README.md +481 -0
- package/docs/ml/README.md +481 -0
- package/docs/mn/README.md +481 -0
- package/docs/mr/README.md +481 -0
- package/docs/ms/README.md +481 -0
- package/docs/mt/README.md +481 -0
- package/docs/my/README.md +481 -0
- package/docs/ne/README.md +481 -0
- package/docs/nl/README.md +481 -0
- package/docs/no/README.md +481 -0
- package/docs/ny/README.md +481 -0
- package/docs/or/README.md +481 -0
- package/docs/pa/README.md +481 -0
- package/docs/pl/README.md +481 -0
- package/docs/ps/README.md +481 -0
- package/docs/pt/README.md +481 -0
- package/docs/ro/README.md +481 -0
- package/docs/ru/README.md +481 -0
- package/docs/rw/README.md +481 -0
- package/docs/sd/README.md +481 -0
- package/docs/si/README.md +481 -0
- package/docs/sk/README.md +481 -0
- package/docs/sl/README.md +481 -0
- package/docs/sm/README.md +481 -0
- package/docs/sn/README.md +481 -0
- package/docs/so/README.md +481 -0
- package/docs/sq/README.md +481 -0
- package/docs/sr/README.md +481 -0
- package/docs/st/README.md +481 -0
- package/docs/su/README.md +481 -0
- package/docs/sv/README.md +481 -0
- package/docs/sw/README.md +481 -0
- package/docs/ta/README.md +481 -0
- package/docs/te/README.md +481 -0
- package/docs/tg/README.md +481 -0
- package/docs/th/README.md +481 -0
- package/docs/tk/README.md +481 -0
- package/docs/tl/README.md +481 -0
- package/docs/tr/README.md +481 -0
- package/docs/tt/README.md +481 -0
- package/docs/ug/README.md +481 -0
- package/docs/uk/README.md +481 -0
- package/docs/ur/README.md +481 -0
- package/docs/uz/README.md +481 -0
- package/docs/vi/README.md +481 -0
- package/docs/xh/README.md +481 -0
- package/docs/yi/README.md +481 -0
- package/docs/yo/README.md +481 -0
- package/docs/zh/README.md +481 -0
- package/docs/zu/README.md +481 -0
- package/drivers/b2/index.js +25 -6
- package/hokey.json +16 -0
- package/index.js +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +13 -9
- package/util/redis.js +2 -2
|
@@ -0,0 +1,481 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
==========
|
|
3
|
+
|
|
4
|
+
I-Mobiletto ngumaleko wogcino weJavaScript, kunye noguqulelo oluyimfihlo lomthengi olusecaleni.
|
|
5
|
+
|
|
6
|
+
# Imixholo
|
|
7
|
+
* [Kutheni iMobiletto?](#Kutheni-iMobiletto?)
|
|
8
|
+
* [Isiqalo esiKhawulezayo](#Ukuqala ngokukhawuleza)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Umthombo](#Umthombo)
|
|
11
|
+
* [Ufakelo](#Fakelo)
|
|
12
|
+
* [Inkxaso kunye neNkxaso](#Inkxaso-kunye-neNkxaso-mali)
|
|
13
|
+
* [Usetyenziso olusisiseko](#Usetyenziso oluSiseko)
|
|
14
|
+
* [Metadata](#Metadata)
|
|
15
|
+
* [Esinye isimbo sokungenisa](#Esinye-isimbo sokungenisa)
|
|
16
|
+
* [Caching](#Caching)
|
|
17
|
+
* [Mirroring](#Mirroring)
|
|
18
|
+
* [Uguqulelo oluntsonkothileyo elubala](#Uguqulelo olungafihlwayo)
|
|
19
|
+
* [Ukujikeleziswa kweSitshixo](#Ukujikeleziswa kweSitshixo)
|
|
20
|
+
* [Ujongano lomqhubi](#Ujongano lomqhubi)
|
|
21
|
+
* [Logging](#Logging)
|
|
22
|
+
|
|
23
|
+
# Funda oku ngolunye ulwimi
|
|
24
|
+
Olu xwebhu README.md luguqulelwe, kusetyenziswa [hokeylization](https://github.com/cobbzilla/hokeylization), kwi
|
|
25
|
+
**[lonke ulwimi luxhaswa yiToliki kaGoogle](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
+
|
|
27
|
+
Ndiqinisekile ukuba ayifezekanga, kodwa ndiyathemba ukuba ingcono kunanto!
|
|
28
|
+
|
|
29
|
+
[🇸🇦 isiArabhu](amaxwebhu/ar/README.md)
|
|
30
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
31
|
+
[🇩🇪 isiJamani](../de/README.md)
|
|
32
|
+
[🇺🇸 IsiNgesi](../en/README.md)
|
|
33
|
+
[🇪🇸 ISpanish](amaxwebhu/es/README.md)
|
|
34
|
+
[🇫🇷 isiFrentshi](../fr/README.md)
|
|
35
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
+
[🇮🇩 isi-Indonesian](../id/README.md)
|
|
38
|
+
[🇮🇹 IsiTaliyane](amaxwebhu/it/README.md)
|
|
39
|
+
[🇯🇵 Japanese](../ja/README.md)
|
|
40
|
+
[🇰🇷 isiKorea](amaxwebhu/ko/README.md)
|
|
41
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
42
|
+
[🇵🇱 Polish](../pl/README.md)
|
|
43
|
+
[🇧🇷 IsiPhuthukezi](amaxwebhu/pt/README.md)
|
|
44
|
+
[🇷🇺 IsiRashiya](../ru/README.md)
|
|
45
|
+
[🇰🇪 IsiSwahili](amaxwebhu/sw/README.md)
|
|
46
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
+
[🇹🇷 IsiTurkey](../tr/README.md)
|
|
48
|
+
[🇵🇰 Urdu](amaxwebhu/ur/README.md)
|
|
49
|
+
[🇻🇳 Vietnamese](../vi/README.md)
|
|
50
|
+
[🇨🇳 isiTshayina](../zh/README.md)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
**[📚 ... Zonke Iilwimi ...](amaxwebhu/README.md)**
|
|
54
|
+
----
|
|
55
|
+
|
|
56
|
+
### Ngaba kukho ingxaki ngoluguqulelo lwe-FUNDA?
|
|
57
|
+
Le nguqulelo yoqobo [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
+
isenokuba neziphene -- *izilungiso zamkelekile kakhulu!* Nceda uthumele [isicelo sokutsalwa kwi-GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
+
okanye ukuba awukhululekanga ukwenza loo nto, [vula umcimbi](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
+
|
|
61
|
+
Xa usenza umba omtsha weGitHub malunga nenguqulelo, nceda wenze:
|
|
62
|
+
* bandakanya i-URL yephepha (ikopi/uncamathisele kwibar yedilesi yomkhangeli zincwadi)
|
|
63
|
+
* bandakanya isicatshulwa kanye esingalunganga (khuphela/uncamathisele kwisikhangeli)
|
|
64
|
+
* Nceda uchaze ukuba yintoni engalunganga -- ingaba uguqulelo aluchanekanga? Ngaba ukufomatha kwaphukile ngandlela ithile?
|
|
65
|
+
* ngobubele nikela icebiso lenguqulelo engcono, okanye indlela umbhalo ofanele ubhalwe ngokufanelekileyo
|
|
66
|
+
* **Enkosi!**
|
|
67
|
+
|
|
68
|
+
## Kutheni iMobiletto?
|
|
69
|
+
|
|
70
|
+
### Sala kakuhle kumthengisi ukutshixa!
|
|
71
|
+
Ababoneleli abahlukeneyo bokugcina ifu bane-APIs engahambelaniyo. Kwanabo balwela "ukuhambelana kwe-S3"
|
|
72
|
+
babe neendlela zokuziphatha ezingaqhelekanga.
|
|
73
|
+
|
|
74
|
+
Xa ukhetha umthengisi othile wokugcina usetyenziso lwakho, ukuba ukhowudi ngqo kwi-API yabo, usetyenziso lwakho
|
|
75
|
+
ngoku ixhomekeke kuloo nkonzo. Njengoko ixesha lihamba kwaye ikhowudi iqokelela, ukutshintsha abathengisi kuba
|
|
76
|
+
iya ingakwazi ukwenzeka. Wamkelekile kwihlabathi elimnandi lokutshixa kwabathengisi!
|
|
77
|
+
|
|
78
|
+
I-Mobiletto yenzelwe ukusombulula le ngxaki. Ngokufaka ikhowudi iapp yakho kwimobiletto's API, ungalula
|
|
79
|
+
tshintsha ababoneleli ngogcino kwaye wazi ukuba umaleko wogcino lweapp yakho uya kuziphatha ngokufanayo.
|
|
80
|
+
|
|
81
|
+
### Uvavanyo olubanzi
|
|
82
|
+
Bonke abaqhubi bavavanyelwa ukuziphatha okufanayo kunye novavanyo lwe-60+ kumqhubi ngamnye.
|
|
83
|
+
Sivavanya bonke abaqhubi ngayo yonke indibaniselwano:
|
|
84
|
+
* Uguqulelo oluntsonkothileyo: zombini zivuliwe kwaye zikhubazekile
|
|
85
|
+
* I-Redis cache: zombini ivuliwe kwaye ivaliwe
|
|
86
|
+
|
|
87
|
+
Le ndlela isinika uxolo lwengqondo yokuba i-mobiletto iya kuziphatha ngendlela efanayo nokuba usebenzisa umqhubi weyiphi na.
|
|
88
|
+
kwaye nokuba wenza i-caching kunye/okanye uguqulelo oluntsonkothileyo.
|
|
89
|
+
|
|
90
|
+
### Inkxaso yomqhubi
|
|
91
|
+
Abaqhubi bangoku beMobiletto yokugcina:
|
|
92
|
+
* `s3` : Amazon S3
|
|
93
|
+
* `b2` : I-Backblaze B2
|
|
94
|
+
* `local` : inkqubo yefayile yendawo
|
|
95
|
+
|
|
96
|
+
*Amagalelo okuxhasa ababoneleli abaninzi bokugcina ilifu bamkelekile kakhulu!*
|
|
97
|
+
|
|
98
|
+
## mobiletto-cli
|
|
99
|
+
IMobiletto yenzelwe ukuba isetyenziswe njengethala leencwadi ngenye ikhowudi yeJavaScript.
|
|
100
|
+
|
|
101
|
+
Ukusebenza nge-mobiletto kumgca womyalelo, sebenzisa [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
+
|
|
103
|
+
## Umthombo
|
|
104
|
+
* [mobiletto kwi-GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
+
* [mobiletto kwi-npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
+
|
|
107
|
+
## Inkxaso kunye neNkxaso
|
|
108
|
+
Ndizama ukuba ngumphuhlisi wesoftware ovulelekileyo. Bendisebenza ngaphakathi
|
|
109
|
+
ishishini lesoftware iminyaka emininzi, ndiqale iinkampani eziphumeleleyo kwaye ndazithengisa kwiinkampani zoluntu.
|
|
110
|
+
Kutshanje ndiye ndaphelelwa ngumsebenzi, yaye andinawo omnye umsebenzi endiwudwelisileyo
|
|
111
|
+
|
|
112
|
+
Ke ndiza kuzama ukubhala isoftware eluncedo kwaye ndibone ukuba iyasebenza na
|
|
113
|
+
|
|
114
|
+
Ukuba uyakonwabela ukusebenzisa le software, ndingabulela kakhulu nokuba
|
|
115
|
+
incinci [igalelo lenyanga ngePatreon](https://www.patreon.com/cobbzilla)
|
|
116
|
+
|
|
117
|
+
*Enkosi!*
|
|
118
|
+
|
|
119
|
+
## Ukufakela
|
|
120
|
+
Faka usebenzisa `npm` okanye `yarn` . Mhlawumbi ufuna `lite` zonke
|
|
121
|
+
Iifayile eziguqulelweyo ze-README:
|
|
122
|
+
|
|
123
|
+
npm install mobiletto-lite
|
|
124
|
+
yarn add mobiletto-lite
|
|
125
|
+
|
|
126
|
+
Ukuba ufuna ngokwenene i README iifayile kulo lonke ulwimi, faka uguqulelo olupheleleyo:
|
|
127
|
+
|
|
128
|
+
npm install mobiletto
|
|
129
|
+
yarn add mobiletto
|
|
130
|
+
|
|
131
|
+
## Ukuqala ngokukhawuleza
|
|
132
|
+
Umzekelo omfutshane usebenzisa imobiletto `s3` umqhubi.
|
|
133
|
+
|
|
134
|
+
Le khowudi iyakuqhuba ngendlela efanayo ukuba umqhubi `b2` okanye `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
|
+
## Usetyenziso olusisiseko
|
|
165
|
+
Umzekelo obanzi ngakumbi, obonisa uninzi lweempawu ezibonelelwayo:
|
|
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
|
+
Umyalelo `metadata` ubuyisela imetadata malunga nongeno lwesixokelelwano esinye.
|
|
268
|
+
Ngokunjalo, ixabiso `list` lomyalelo luludwe lwezinto zemetadata.
|
|
269
|
+
|
|
270
|
+
Into yemetadata ibonakala ngolu hlobo:
|
|
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
|
+
I `type` ipropathi inokuba `file` , `dir` , `link` , okanye `special` .
|
|
281
|
+
|
|
282
|
+
Kuxhomekeka kudidi lomqhubi, `list` umyalelo awunakubuyisela zonke iindawo. I `name` kunye `type` iimpawu
|
|
283
|
+
kufuneka ahlale ekho. Umyalelo olandelayo `metadata` zonke iipropati ezikhoyo.
|
|
284
|
+
|
|
285
|
+
## Esinye isimbo sokungenisa
|
|
286
|
+
Thatha ngaphandle imodyuli enomda ngokupheleleyo kwaye usebenzise umsebenzi `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
|
+
## Ugcino
|
|
294
|
+
I-Mobiletto isebenza kakuhle nge-cache ye- <a href="https://redis.io">redis</a> .
|
|
295
|
+
|
|
296
|
+
I-Mobiletto iya kuzama ukudibanisa kumzekelo we-redis kwi-127.0.0.1: 6379
|
|
297
|
+
|
|
298
|
+
Ungabhala ngaphezulu kwezi:
|
|
299
|
+
* Cwangcisa i `MOBILETTO_REDIS_HOST` env var, imobiletto qhagamshela apha endaweni yehostela yendawo
|
|
300
|
+
* Cwangcisa i `MOBILETTO_REDIS_PORT` env var, elizibuko liza kusetyenziswa
|
|
301
|
+
|
|
302
|
+
I-Mobiletto izakugcina zonke izitshixo zayo zeredis kunye nesiqalo `_mobiletto__` . Ungatshintsha oku
|
|
303
|
+
ngokucwangcisa i `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
+
|
|
305
|
+
Ungakwazi nokuseta uqhagamshelo lwe-caching nganye kunye nento ethi `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
|
+
### Awufuni redis caching?
|
|
317
|
+
Ukuyekisa: dlula `enabled: false` kwinto yakho `opts.redisConfig` xa useka umdibaniso wakho.
|
|
318
|
+
|
|
319
|
+
Njengoko kuxoxwe ngezantsi, ukukhubaza i-caching kuya kuba nefuthe elibi ekusebenzeni kwaye kubangele izicelo ezininzi
|
|
320
|
+
kugcino olufuna ngokwenene.
|
|
321
|
+
|
|
322
|
+
### Isikhokelo se-caching
|
|
323
|
+
**Ugcino oluntsonkothileyo**: ukufunda/ukubhala ugcino olufihliweyo lucotha kancinci kunesiqhelo,
|
|
324
|
+
kodwa ukuzulazula kuluhlu lwezalathisi (ezinye izinto ezizenzayo) kubiza kakhulu. Ukusebenzisa i-redis cache
|
|
325
|
+
iya kukunika ukonyuswa okubalulekileyo kokusebenza.
|
|
326
|
+
|
|
327
|
+
I-cache engagqibekanga ikhuselekile, kodwa ayisebenzi kakuhle ukuba unokuninzi kokubhala/ukususa imisebenzi.
|
|
328
|
+
Nakuphi na ukubhala okanye ukususa umsebenzi kuyenza ingasebenzi i-cache yonke, ukuqinisekisa ukuba ufundo olulandelayo luya kubona
|
|
329
|
+
utshintsho lwamva nje.
|
|
330
|
+
|
|
331
|
+
### izixhobo zeCLI
|
|
332
|
+
Ukuba usebenzisa isixhobo se-CLI esinje [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
+
ngokuqinisekileyo uya kufuna ukuba i-redis cache yenziwe, njengoko iqhubeka ngapha kwezicelo zomyalelo `mo` .
|
|
334
|
+
|
|
335
|
+
## Isipili
|
|
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
|
+
Umyalelo `mirror` wenza ikopi yexesha elinye yazo zonke iifayile ukusuka kwimobiletto enye ukuya kwenye.
|
|
344
|
+
Ayiqhubeki nayiphi na inkqubo yokugcina isibuko ngexesha. Sebenzisa `mirror` umyalelo kwakhona
|
|
345
|
+
ukulungelelanisa naziphi na iifayile ezingekhoyo.
|
|
346
|
+
|
|
347
|
+
Ixabiso lembuyekezo elisuka `mirror` yinto elula enezinto zokubala zokuba zingaphi iifayile eziphumeleleyo
|
|
348
|
+
ezibonisiweyo kwaye zingaphi iifayile ezineempazamo:
|
|
349
|
+
|
|
350
|
+
{
|
|
351
|
+
success: count-of-files-mirrored,
|
|
352
|
+
errors: count-of-files-with-errors
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
ISILUMKISO: Ukujonga iiseti zedatha enkulu kunokutya ixesha elininzi kunye ne-bandwidth
|
|
356
|
+
|
|
357
|
+
Nge `mirror` sokufowuna semantiki ngamanye amaxesha kunokubhida ukuqonda ukuba ngubani
|
|
358
|
+
umfundi kwaye ngubani umbhali. Yiba nomfanekiso wengxelo yesabelo: "isandla sasekhohlo mobiletto"
|
|
359
|
+
yinto eyabelwa kuyo (idatha ebonisiweyo ebhaliweyo), kunye ne "right-hand mobiletto" (i
|
|
360
|
+
Ingxoxo `mirror` ) lixabiso elabelweyo (idatha ebonisiweyo iyafundwa).
|
|
361
|
+
|
|
362
|
+
## Uguqulelo oluntsonkothileyo
|
|
363
|
+
Yenza uguqulelo oluntsonkothileyo kwicala lomxhasi:
|
|
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
|
+
Kwenzekani? Indawo eyahlukileyo "yengeniso kavimba weefayili" (dirent) uvimba weefayili (ofihliweyo) ulandelela ukuba zeziphi iifayile ezikuloo nto
|
|
383
|
+
uvimba weefayili (aka uvimba weefayili).
|
|
384
|
+
* Umyalelo `list` lufunda uvimba weefayili zongeno, icoca indlela nganye edwelisiweyo; emva koko ibuyisela imetadata yefayile nganye
|
|
385
|
+
`list` ayisebenzi ngakumbi, ingakumbi kubalawuli abanenani elikhulu leefayile
|
|
386
|
+
* Umyalelo othi `write` ubhala iifayile ezizii-dirent kuluhlu lomzali ngamnye, ngokuphindaphindiweyo; emva koko ibhale ifayile
|
|
387
|
+
* `write` imiyalelo iya kwenza u-O(N) ubhale, nge-N = ubunzulu kuluhlu lolawulo
|
|
388
|
+
* Umyalelo `remove` ususa ifayile ehambelanayo ehambelanayo, kwaye umzali wayo ukuba akananto, ngokuphindaphindiweyo; emva koko isuse ifayile
|
|
389
|
+
* Imiyalelo `remove` -O(N) ifundeke kwaye kunokwenzeka ucime oluninzi, nge N = ubunzulu kuluhlu lwenkqubo
|
|
390
|
+
* Imiyalelo ephindaphindayo `remove`
|
|
391
|
+
|
|
392
|
+
Qaphela ukuba nofihlo lwecala lomxhasi luvuliwe, umchasi onokubonakala okupheleleyo kwicala leseva elifihliweyo.
|
|
393
|
+
ugcino, nangaphandle kwesitshixo, usengabona inani lilonke labalawuli kunye nokuba zingaphi iifayile kwindawo nganye, kwaye nge
|
|
394
|
+
umzamo othile, fumana enye okanye sonke isakhelo esipheleleyo soluhlu lweqela leefayili.
|
|
395
|
+
*Qaphela: Sebenzisa isakhiwo esithe tyaba ukwenzela ukhuseleko olungcono.
|
|
396
|
+
Utshaba alunakwazi amagama abalawuli/iifayile ngaphandle kokuba nabo bayalwazi ufihlo lwakho
|
|
397
|
+
isitshixo okanye ngenye indlela iqhekeze ngempumelelo uguqulelo oluntsonkothileyo. Zonke iibheji zicinyiwe ngoko!
|
|
398
|
+
|
|
399
|
+
### Ukusebenza kunye ne-caching
|
|
400
|
+
Imisebenzi kugcino oluntsonkothileyo lungacotha. Uluhlu oluphindayo kunye nokususwa kunokucotha kakhulu.
|
|
401
|
+
Ukugcinwa kwe-cache nge-redis kunceda kakhulu, kodwa qaphela ukuba i-cache igutyungelwe nakuphi na okubhaliweyo okanye okususayo.
|
|
402
|
+
|
|
403
|
+
## Ujikelezo olungundoqo
|
|
404
|
+
Yenza i-mobiletto ngesitshixo sakho esitsha, emva koko ubonise idatha endala kuyo:
|
|
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
|
+
## Ujongano lomqhubi
|
|
417
|
+
Umqhubi yiyo nayiphi na ifayile ye-JS ethumela ngaphandle umsebenzi we-'storageClient' ngolu tyikityo:
|
|
418
|
+
|
|
419
|
+
function storageClient (key, secret, opts)
|
|
420
|
+
|
|
421
|
+
* `key` : umtya, isitshixo sakho se-API ( `local` olu luluhlu lwesiseko)
|
|
422
|
+
* `secret` : umtya, imfihlo yakho ye-API (inokushiywa kumqhubi `local` )
|
|
423
|
+
* `opts` : into, iipropati ngomqhubi ngamnye:
|
|
424
|
+
* `local` , `fileMode` kunye ne `dirMode` iipropati zimisela indlela entsha yokudala iifayile kunye nabalawuli benziwa
|
|
425
|
+
* Kwi `s3` , ipropathi `bucket` iyafuneka. Iipropati ozikhethelayo zezi:
|
|
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
|
+
Into ebuyiswa ngumsebenzi weClient kufuneka ichaze le misebenzi:
|
|
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
|
+
## Ukugawulwa kwemithi
|
|
457
|
+
I-Mobiletto isebenzisa [winston](https://www.npmjs.com/package/winston) ilayibrari yokugawulwa kwemithi.
|
|
458
|
+
|
|
459
|
+
Iilogi ** ziya kuqulatha iindlela zefayile kunye nemiyalezo yempazamo, kodwa ayinakuze ** iqulathe izitshixo, iimfihlo,
|
|
460
|
+
okanye naluphi na olunye ulwazi loqwalaselo loqhagamshelwano.
|
|
461
|
+
|
|
462
|
+
### Inqanaba lokuloga
|
|
463
|
+
Sebenzisa `MOBILETTO_LOG_LEVEL` ukuguquguquka kwemekobume ukuseta umgangatho welog, usebenzisa enye
|
|
464
|
+
`npm` achazwe kwi [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
+
|
|
466
|
+
Umphakamo omiselweyo uthi `error` . Elona nqanaba `silly` , nangona okwangoku mobiletto
|
|
467
|
+
ayilogi kumanqanaba asezantsi `debug`
|
|
468
|
+
|
|
469
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
+
|
|
471
|
+
### Ifayile yelog
|
|
472
|
+
Ngokungagqibekanga, umgawuli ubhalela ikhonsoli. Ukuthumela iilog kwifayile, seta i `MOBILETTO_LOG_FILE`
|
|
473
|
+
ukuguquguquka kokusingqongileyo. Xa ungena kwifayile, iilog azisayi kuphinda zibhalelwe kwi-console.
|
|
474
|
+
|
|
475
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
+
|
|
477
|
+
Ukucima ukugawulwa kwemithi:
|
|
478
|
+
|
|
479
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
+
|
|
481
|
+
</pre>
|