1 | {
|
2 | "version": "1.0.1",
|
3 | "commands": {
|
4 | "add-endpoint": {
|
5 | "id": "add-endpoint",
|
6 | "description": "\nAdds a connection endpoint for Fauna.\n",
|
7 | "strict": true,
|
8 | "pluginName": "fauna-shell",
|
9 | "pluginAlias": "fauna-shell",
|
10 | "pluginType": "core",
|
11 | "aliases": [],
|
12 | "examples": [
|
13 | "$ fauna add-endpoint https://db.fauna.com:443",
|
14 | "$ fauna add-endpoint http://localhost:8443/ --alias localhost --key secret"
|
15 | ],
|
16 | "flags": {
|
17 | "domain": {
|
18 | "name": "domain",
|
19 | "type": "option",
|
20 | "description": "Fauna server domain",
|
21 | "multiple": false
|
22 | },
|
23 | "scheme": {
|
24 | "name": "scheme",
|
25 | "type": "option",
|
26 | "description": "Connection scheme",
|
27 | "multiple": false,
|
28 | "options": [
|
29 | "https",
|
30 | "http"
|
31 | ]
|
32 | },
|
33 | "port": {
|
34 | "name": "port",
|
35 | "type": "option",
|
36 | "description": "Connection port",
|
37 | "multiple": false
|
38 | },
|
39 | "timeout": {
|
40 | "name": "timeout",
|
41 | "type": "option",
|
42 | "description": "Connection timeout in milliseconds",
|
43 | "multiple": false
|
44 | },
|
45 | "secret": {
|
46 | "name": "secret",
|
47 | "type": "option",
|
48 | "description": "Fauna secret key",
|
49 | "multiple": false
|
50 | },
|
51 | "endpoint": {
|
52 | "name": "endpoint",
|
53 | "type": "option",
|
54 | "description": "Fauna server endpoint",
|
55 | "multiple": false
|
56 | },
|
57 | "graphqlHost": {
|
58 | "name": "graphqlHost",
|
59 | "type": "option",
|
60 | "description": "The Fauna GraphQL API host",
|
61 | "multiple": false
|
62 | },
|
63 | "graphqlPort": {
|
64 | "name": "graphqlPort",
|
65 | "type": "option",
|
66 | "description": "GraphQL port",
|
67 | "multiple": false
|
68 | },
|
69 | "alias": {
|
70 | "name": "alias",
|
71 | "type": "option",
|
72 | "description": "Fauna server endpoint alias",
|
73 | "required": false,
|
74 | "multiple": false
|
75 | },
|
76 | "key": {
|
77 | "name": "key",
|
78 | "type": "option",
|
79 | "description": "Fauna server endpoint key",
|
80 | "required": false,
|
81 | "multiple": false
|
82 | }
|
83 | },
|
84 | "args": {
|
85 | "endpoint": {
|
86 | "name": "endpoint",
|
87 | "description": "Fauna server endpoint",
|
88 | "required": true
|
89 | }
|
90 | }
|
91 | },
|
92 | "cloud-login": {
|
93 | "id": "cloud-login",
|
94 | "description": "Adds a Fauna endpoint.",
|
95 | "strict": true,
|
96 | "pluginName": "fauna-shell",
|
97 | "pluginAlias": "fauna-shell",
|
98 | "pluginType": "core",
|
99 | "aliases": [],
|
100 | "examples": [
|
101 | "$ fauna cloud-login"
|
102 | ],
|
103 | "flags": {
|
104 | "domain": {
|
105 | "name": "domain",
|
106 | "type": "option",
|
107 | "description": "Fauna server domain",
|
108 | "multiple": false
|
109 | },
|
110 | "scheme": {
|
111 | "name": "scheme",
|
112 | "type": "option",
|
113 | "description": "Connection scheme",
|
114 | "multiple": false,
|
115 | "options": [
|
116 | "https",
|
117 | "http"
|
118 | ]
|
119 | },
|
120 | "port": {
|
121 | "name": "port",
|
122 | "type": "option",
|
123 | "description": "Connection port",
|
124 | "multiple": false
|
125 | },
|
126 | "timeout": {
|
127 | "name": "timeout",
|
128 | "type": "option",
|
129 | "description": "Connection timeout in milliseconds",
|
130 | "multiple": false
|
131 | },
|
132 | "secret": {
|
133 | "name": "secret",
|
134 | "type": "option",
|
135 | "description": "Fauna secret key",
|
136 | "multiple": false
|
137 | },
|
138 | "endpoint": {
|
139 | "name": "endpoint",
|
140 | "type": "option",
|
141 | "description": "Fauna server endpoint",
|
142 | "multiple": false
|
143 | },
|
144 | "graphqlHost": {
|
145 | "name": "graphqlHost",
|
146 | "type": "option",
|
147 | "description": "The Fauna GraphQL API host",
|
148 | "multiple": false
|
149 | },
|
150 | "graphqlPort": {
|
151 | "name": "graphqlPort",
|
152 | "type": "option",
|
153 | "description": "GraphQL port",
|
154 | "multiple": false
|
155 | }
|
156 | },
|
157 | "args": {}
|
158 | },
|
159 | "create-database": {
|
160 | "id": "create-database",
|
161 | "description": "\nCreates a database\n",
|
162 | "strict": true,
|
163 | "pluginName": "fauna-shell",
|
164 | "pluginAlias": "fauna-shell",
|
165 | "pluginType": "core",
|
166 | "aliases": [],
|
167 | "examples": [
|
168 | "$ fauna create-database dbname"
|
169 | ],
|
170 | "flags": {
|
171 | "domain": {
|
172 | "name": "domain",
|
173 | "type": "option",
|
174 | "description": "Fauna server domain",
|
175 | "multiple": false
|
176 | },
|
177 | "scheme": {
|
178 | "name": "scheme",
|
179 | "type": "option",
|
180 | "description": "Connection scheme",
|
181 | "multiple": false,
|
182 | "options": [
|
183 | "https",
|
184 | "http"
|
185 | ]
|
186 | },
|
187 | "port": {
|
188 | "name": "port",
|
189 | "type": "option",
|
190 | "description": "Connection port",
|
191 | "multiple": false
|
192 | },
|
193 | "timeout": {
|
194 | "name": "timeout",
|
195 | "type": "option",
|
196 | "description": "Connection timeout in milliseconds",
|
197 | "multiple": false
|
198 | },
|
199 | "secret": {
|
200 | "name": "secret",
|
201 | "type": "option",
|
202 | "description": "Fauna secret key",
|
203 | "multiple": false
|
204 | },
|
205 | "endpoint": {
|
206 | "name": "endpoint",
|
207 | "type": "option",
|
208 | "description": "Fauna server endpoint",
|
209 | "multiple": false
|
210 | },
|
211 | "graphqlHost": {
|
212 | "name": "graphqlHost",
|
213 | "type": "option",
|
214 | "description": "The Fauna GraphQL API host",
|
215 | "multiple": false
|
216 | },
|
217 | "graphqlPort": {
|
218 | "name": "graphqlPort",
|
219 | "type": "option",
|
220 | "description": "GraphQL port",
|
221 | "multiple": false
|
222 | }
|
223 | },
|
224 | "args": {
|
225 | "dbname": {
|
226 | "name": "dbname",
|
227 | "description": "database name",
|
228 | "required": true
|
229 | }
|
230 | }
|
231 | },
|
232 | "create-key": {
|
233 | "id": "create-key",
|
234 | "description": "\nCreates a key for the specified database\n",
|
235 | "strict": true,
|
236 | "pluginName": "fauna-shell",
|
237 | "pluginAlias": "fauna-shell",
|
238 | "pluginType": "core",
|
239 | "aliases": [],
|
240 | "examples": [
|
241 | "$ fauna create-key dbname admin"
|
242 | ],
|
243 | "flags": {
|
244 | "domain": {
|
245 | "name": "domain",
|
246 | "type": "option",
|
247 | "description": "Fauna server domain",
|
248 | "multiple": false
|
249 | },
|
250 | "scheme": {
|
251 | "name": "scheme",
|
252 | "type": "option",
|
253 | "description": "Connection scheme",
|
254 | "multiple": false,
|
255 | "options": [
|
256 | "https",
|
257 | "http"
|
258 | ]
|
259 | },
|
260 | "port": {
|
261 | "name": "port",
|
262 | "type": "option",
|
263 | "description": "Connection port",
|
264 | "multiple": false
|
265 | },
|
266 | "timeout": {
|
267 | "name": "timeout",
|
268 | "type": "option",
|
269 | "description": "Connection timeout in milliseconds",
|
270 | "multiple": false
|
271 | },
|
272 | "secret": {
|
273 | "name": "secret",
|
274 | "type": "option",
|
275 | "description": "Fauna secret key",
|
276 | "multiple": false
|
277 | },
|
278 | "endpoint": {
|
279 | "name": "endpoint",
|
280 | "type": "option",
|
281 | "description": "Fauna server endpoint",
|
282 | "multiple": false
|
283 | },
|
284 | "graphqlHost": {
|
285 | "name": "graphqlHost",
|
286 | "type": "option",
|
287 | "description": "The Fauna GraphQL API host",
|
288 | "multiple": false
|
289 | },
|
290 | "graphqlPort": {
|
291 | "name": "graphqlPort",
|
292 | "type": "option",
|
293 | "description": "GraphQL port",
|
294 | "multiple": false
|
295 | }
|
296 | },
|
297 | "args": {
|
298 | "dbname": {
|
299 | "name": "dbname",
|
300 | "description": "database name",
|
301 | "required": true
|
302 | },
|
303 | "role": {
|
304 | "name": "role",
|
305 | "description": "key user role",
|
306 | "options": [
|
307 | "admin",
|
308 | "server",
|
309 | "server-readonly",
|
310 | "client"
|
311 | ]
|
312 | }
|
313 | }
|
314 | },
|
315 | "default-endpoint": {
|
316 | "id": "default-endpoint",
|
317 | "description": "\nSets an endpoint as the default one\n",
|
318 | "strict": true,
|
319 | "pluginName": "fauna-shell",
|
320 | "pluginAlias": "fauna-shell",
|
321 | "pluginType": "core",
|
322 | "aliases": [],
|
323 | "examples": [
|
324 | "$ fauna default-endpoint endpoint"
|
325 | ],
|
326 | "flags": {
|
327 | "domain": {
|
328 | "name": "domain",
|
329 | "type": "option",
|
330 | "description": "Fauna server domain",
|
331 | "multiple": false
|
332 | },
|
333 | "scheme": {
|
334 | "name": "scheme",
|
335 | "type": "option",
|
336 | "description": "Connection scheme",
|
337 | "multiple": false,
|
338 | "options": [
|
339 | "https",
|
340 | "http"
|
341 | ]
|
342 | },
|
343 | "port": {
|
344 | "name": "port",
|
345 | "type": "option",
|
346 | "description": "Connection port",
|
347 | "multiple": false
|
348 | },
|
349 | "timeout": {
|
350 | "name": "timeout",
|
351 | "type": "option",
|
352 | "description": "Connection timeout in milliseconds",
|
353 | "multiple": false
|
354 | },
|
355 | "secret": {
|
356 | "name": "secret",
|
357 | "type": "option",
|
358 | "description": "Fauna secret key",
|
359 | "multiple": false
|
360 | },
|
361 | "endpoint": {
|
362 | "name": "endpoint",
|
363 | "type": "option",
|
364 | "description": "Fauna server endpoint",
|
365 | "multiple": false
|
366 | },
|
367 | "graphqlHost": {
|
368 | "name": "graphqlHost",
|
369 | "type": "option",
|
370 | "description": "The Fauna GraphQL API host",
|
371 | "multiple": false
|
372 | },
|
373 | "graphqlPort": {
|
374 | "name": "graphqlPort",
|
375 | "type": "option",
|
376 | "description": "GraphQL port",
|
377 | "multiple": false
|
378 | }
|
379 | },
|
380 | "args": {
|
381 | "endpoint_alias": {
|
382 | "name": "endpoint_alias",
|
383 | "description": "Fauna server endpoint alias",
|
384 | "required": true
|
385 | }
|
386 | }
|
387 | },
|
388 | "delete-database": {
|
389 | "id": "delete-database",
|
390 | "description": "\nDeletes a database\n",
|
391 | "strict": true,
|
392 | "pluginName": "fauna-shell",
|
393 | "pluginAlias": "fauna-shell",
|
394 | "pluginType": "core",
|
395 | "aliases": [],
|
396 | "examples": [
|
397 | "$ fauna delete-database dbname"
|
398 | ],
|
399 | "flags": {
|
400 | "domain": {
|
401 | "name": "domain",
|
402 | "type": "option",
|
403 | "description": "Fauna server domain",
|
404 | "multiple": false
|
405 | },
|
406 | "scheme": {
|
407 | "name": "scheme",
|
408 | "type": "option",
|
409 | "description": "Connection scheme",
|
410 | "multiple": false,
|
411 | "options": [
|
412 | "https",
|
413 | "http"
|
414 | ]
|
415 | },
|
416 | "port": {
|
417 | "name": "port",
|
418 | "type": "option",
|
419 | "description": "Connection port",
|
420 | "multiple": false
|
421 | },
|
422 | "timeout": {
|
423 | "name": "timeout",
|
424 | "type": "option",
|
425 | "description": "Connection timeout in milliseconds",
|
426 | "multiple": false
|
427 | },
|
428 | "secret": {
|
429 | "name": "secret",
|
430 | "type": "option",
|
431 | "description": "Fauna secret key",
|
432 | "multiple": false
|
433 | },
|
434 | "endpoint": {
|
435 | "name": "endpoint",
|
436 | "type": "option",
|
437 | "description": "Fauna server endpoint",
|
438 | "multiple": false
|
439 | },
|
440 | "graphqlHost": {
|
441 | "name": "graphqlHost",
|
442 | "type": "option",
|
443 | "description": "The Fauna GraphQL API host",
|
444 | "multiple": false
|
445 | },
|
446 | "graphqlPort": {
|
447 | "name": "graphqlPort",
|
448 | "type": "option",
|
449 | "description": "GraphQL port",
|
450 | "multiple": false
|
451 | }
|
452 | },
|
453 | "args": {
|
454 | "dbname": {
|
455 | "name": "dbname",
|
456 | "description": "database name",
|
457 | "required": true
|
458 | }
|
459 | }
|
460 | },
|
461 | "delete-endpoint": {
|
462 | "id": "delete-endpoint",
|
463 | "description": "\nDeletes a connection endpoint.\n",
|
464 | "strict": true,
|
465 | "pluginName": "fauna-shell",
|
466 | "pluginAlias": "fauna-shell",
|
467 | "pluginType": "core",
|
468 | "aliases": [],
|
469 | "examples": [
|
470 | "$ fauna delete-endpoint endpoint_alias"
|
471 | ],
|
472 | "flags": {
|
473 | "domain": {
|
474 | "name": "domain",
|
475 | "type": "option",
|
476 | "description": "Fauna server domain",
|
477 | "multiple": false
|
478 | },
|
479 | "scheme": {
|
480 | "name": "scheme",
|
481 | "type": "option",
|
482 | "description": "Connection scheme",
|
483 | "multiple": false,
|
484 | "options": [
|
485 | "https",
|
486 | "http"
|
487 | ]
|
488 | },
|
489 | "port": {
|
490 | "name": "port",
|
491 | "type": "option",
|
492 | "description": "Connection port",
|
493 | "multiple": false
|
494 | },
|
495 | "timeout": {
|
496 | "name": "timeout",
|
497 | "type": "option",
|
498 | "description": "Connection timeout in milliseconds",
|
499 | "multiple": false
|
500 | },
|
501 | "secret": {
|
502 | "name": "secret",
|
503 | "type": "option",
|
504 | "description": "Fauna secret key",
|
505 | "multiple": false
|
506 | },
|
507 | "endpoint": {
|
508 | "name": "endpoint",
|
509 | "type": "option",
|
510 | "description": "Fauna server endpoint",
|
511 | "multiple": false
|
512 | },
|
513 | "graphqlHost": {
|
514 | "name": "graphqlHost",
|
515 | "type": "option",
|
516 | "description": "The Fauna GraphQL API host",
|
517 | "multiple": false
|
518 | },
|
519 | "graphqlPort": {
|
520 | "name": "graphqlPort",
|
521 | "type": "option",
|
522 | "description": "GraphQL port",
|
523 | "multiple": false
|
524 | }
|
525 | },
|
526 | "args": {
|
527 | "endpoint_alias": {
|
528 | "name": "endpoint_alias",
|
529 | "description": "Fauna server endpoint alias",
|
530 | "required": true
|
531 | }
|
532 | }
|
533 | },
|
534 | "delete-key": {
|
535 | "id": "delete-key",
|
536 | "description": "\nDeletes a key\n",
|
537 | "strict": true,
|
538 | "pluginName": "fauna-shell",
|
539 | "pluginAlias": "fauna-shell",
|
540 | "pluginType": "core",
|
541 | "aliases": [],
|
542 | "examples": [
|
543 | "$ fauna delete-key 123456789012345678"
|
544 | ],
|
545 | "flags": {
|
546 | "domain": {
|
547 | "name": "domain",
|
548 | "type": "option",
|
549 | "description": "Fauna server domain",
|
550 | "multiple": false
|
551 | },
|
552 | "scheme": {
|
553 | "name": "scheme",
|
554 | "type": "option",
|
555 | "description": "Connection scheme",
|
556 | "multiple": false,
|
557 | "options": [
|
558 | "https",
|
559 | "http"
|
560 | ]
|
561 | },
|
562 | "port": {
|
563 | "name": "port",
|
564 | "type": "option",
|
565 | "description": "Connection port",
|
566 | "multiple": false
|
567 | },
|
568 | "timeout": {
|
569 | "name": "timeout",
|
570 | "type": "option",
|
571 | "description": "Connection timeout in milliseconds",
|
572 | "multiple": false
|
573 | },
|
574 | "secret": {
|
575 | "name": "secret",
|
576 | "type": "option",
|
577 | "description": "Fauna secret key",
|
578 | "multiple": false
|
579 | },
|
580 | "endpoint": {
|
581 | "name": "endpoint",
|
582 | "type": "option",
|
583 | "description": "Fauna server endpoint",
|
584 | "multiple": false
|
585 | },
|
586 | "graphqlHost": {
|
587 | "name": "graphqlHost",
|
588 | "type": "option",
|
589 | "description": "The Fauna GraphQL API host",
|
590 | "multiple": false
|
591 | },
|
592 | "graphqlPort": {
|
593 | "name": "graphqlPort",
|
594 | "type": "option",
|
595 | "description": "GraphQL port",
|
596 | "multiple": false
|
597 | }
|
598 | },
|
599 | "args": {
|
600 | "keyname": {
|
601 | "name": "keyname",
|
602 | "description": "key name",
|
603 | "required": true
|
604 | }
|
605 | }
|
606 | },
|
607 | "eval": {
|
608 | "id": "eval",
|
609 | "description": "\nDeprecated: fauna run-queries is deprecated. Use eval instead\nRuns the queries found on the file passed to the command.\n",
|
610 | "strict": true,
|
611 | "pluginName": "fauna-shell",
|
612 | "pluginAlias": "fauna-shell",
|
613 | "pluginType": "core",
|
614 | "aliases": [],
|
615 | "examples": [
|
616 | "$ fauna eval \"Collection.all()\"",
|
617 | "$ fauna eval nestedDbName \"Collection.all()\"",
|
618 | "$ fauna eval --file=/path/to/queries.fql",
|
619 | "$ echo \"1 + 1\" | fauna eval",
|
620 | "$ fauna eval \"2 + 3\" --output=/tmp/result\"",
|
621 | "$ fauna eval \"2 + 3\" --format=json --output=/tmp/result\""
|
622 | ],
|
623 | "flags": {
|
624 | "domain": {
|
625 | "name": "domain",
|
626 | "type": "option",
|
627 | "description": "Fauna server domain",
|
628 | "multiple": false
|
629 | },
|
630 | "scheme": {
|
631 | "name": "scheme",
|
632 | "type": "option",
|
633 | "description": "Connection scheme",
|
634 | "multiple": false,
|
635 | "options": [
|
636 | "https",
|
637 | "http"
|
638 | ]
|
639 | },
|
640 | "port": {
|
641 | "name": "port",
|
642 | "type": "option",
|
643 | "description": "Connection port",
|
644 | "multiple": false
|
645 | },
|
646 | "timeout": {
|
647 | "name": "timeout",
|
648 | "type": "option",
|
649 | "description": "Connection timeout in milliseconds",
|
650 | "multiple": false
|
651 | },
|
652 | "secret": {
|
653 | "name": "secret",
|
654 | "type": "option",
|
655 | "description": "Fauna secret key",
|
656 | "multiple": false
|
657 | },
|
658 | "endpoint": {
|
659 | "name": "endpoint",
|
660 | "type": "option",
|
661 | "description": "Fauna server endpoint",
|
662 | "multiple": false
|
663 | },
|
664 | "graphqlHost": {
|
665 | "name": "graphqlHost",
|
666 | "type": "option",
|
667 | "description": "The Fauna GraphQL API host",
|
668 | "multiple": false
|
669 | },
|
670 | "graphqlPort": {
|
671 | "name": "graphqlPort",
|
672 | "type": "option",
|
673 | "description": "GraphQL port",
|
674 | "multiple": false
|
675 | },
|
676 | "file": {
|
677 | "name": "file",
|
678 | "type": "option",
|
679 | "description": "File where to read queries from",
|
680 | "multiple": false
|
681 | },
|
682 | "stdin": {
|
683 | "name": "stdin",
|
684 | "type": "boolean",
|
685 | "description": "Read file input from stdin. Writes to stdout by default",
|
686 | "allowNo": false
|
687 | },
|
688 | "output": {
|
689 | "name": "output",
|
690 | "type": "option",
|
691 | "description": "File to write output to",
|
692 | "multiple": false,
|
693 | "default": null
|
694 | },
|
695 | "format": {
|
696 | "name": "format",
|
697 | "type": "option",
|
698 | "description": "Output format",
|
699 | "multiple": false,
|
700 | "options": [
|
701 | "json",
|
702 | "json-tagged",
|
703 | "shell"
|
704 | ]
|
705 | },
|
706 | "version": {
|
707 | "name": "version",
|
708 | "type": "option",
|
709 | "description": "FQL Version",
|
710 | "multiple": false,
|
711 | "options": [
|
712 | "4",
|
713 | "10"
|
714 | ],
|
715 | "default": "10"
|
716 | },
|
717 | "typecheck": {
|
718 | "name": "typecheck",
|
719 | "type": "boolean",
|
720 | "description": "Enable typechecking",
|
721 | "allowNo": false
|
722 | }
|
723 | },
|
724 | "args": {
|
725 | "dbname": {
|
726 | "name": "dbname",
|
727 | "description": "Database name",
|
728 | "required": false
|
729 | },
|
730 | "query": {
|
731 | "name": "query",
|
732 | "description": "FQL query to execute",
|
733 | "required": false
|
734 | }
|
735 | }
|
736 | },
|
737 | "import": {
|
738 | "id": "import",
|
739 | "description": "Import data to Fauna",
|
740 | "strict": true,
|
741 | "pluginName": "fauna-shell",
|
742 | "pluginAlias": "fauna-shell",
|
743 | "pluginType": "core",
|
744 | "aliases": [],
|
745 | "examples": [
|
746 | "You can combine the options in any manner of you're choosing (although type translations cannot be applied to JSON or JSONL files). Below are examples.",
|
747 | "\n ... File import examples",
|
748 | "",
|
749 | "\nImport a file into a new collection - given the same name as the file:",
|
750 | "$ fauna import --path ./collection_name.csv",
|
751 | "\nAppend a file into a pre-existing collection - having the same name as the file:",
|
752 | "$ fauna import --append --path ./collection.csv",
|
753 | "\nImport a file into a new collection named \"SampleCollection\" in the child database \"sampleDB\":",
|
754 | "$ fauna import --db=sampleDB --collection=SampleCollection --path ./datafile.csv",
|
755 | "\nImport a file into a new collection named \"SampleCollection\" in the child database \"sampleDB\":",
|
756 | "$ fauna import --type=iso8601_date::dateString --type=hdr2::number --type=hdrX::bool --path ./collection.csv",
|
757 | "",
|
758 | " ... Directory import examples",
|
759 | "",
|
760 | "Import a directory - creating a new collection \"SampleCollection\" with data from every file in the directory:",
|
761 | "$ fauna import --path ./my_directory --collection=SampleCollection",
|
762 | "\nImport a directory - creating appending to the pre-existing collection \"SampleCollection\" with data from every file in the directory:",
|
763 | "$ fauna import --path ./my_directory --collection=SampleCollection --append",
|
764 | "\nImport a directory - creating creating a new collection named after the file name of each file:",
|
765 | "$ fauna import --path ./my_directory",
|
766 | "\nImport a directory - creating appending to pre-existing collections named after the file name of each file:",
|
767 | "$ fauna import --path ./my_directory --append"
|
768 | ],
|
769 | "flags": {
|
770 | "domain": {
|
771 | "name": "domain",
|
772 | "type": "option",
|
773 | "description": "Fauna server domain",
|
774 | "multiple": false
|
775 | },
|
776 | "scheme": {
|
777 | "name": "scheme",
|
778 | "type": "option",
|
779 | "description": "Connection scheme",
|
780 | "multiple": false,
|
781 | "options": [
|
782 | "https",
|
783 | "http"
|
784 | ]
|
785 | },
|
786 | "port": {
|
787 | "name": "port",
|
788 | "type": "option",
|
789 | "description": "Connection port",
|
790 | "multiple": false
|
791 | },
|
792 | "timeout": {
|
793 | "name": "timeout",
|
794 | "type": "option",
|
795 | "description": "Connection timeout in milliseconds",
|
796 | "multiple": false
|
797 | },
|
798 | "secret": {
|
799 | "name": "secret",
|
800 | "type": "option",
|
801 | "description": "Fauna secret key",
|
802 | "multiple": false
|
803 | },
|
804 | "endpoint": {
|
805 | "name": "endpoint",
|
806 | "type": "option",
|
807 | "description": "Fauna server endpoint",
|
808 | "multiple": false
|
809 | },
|
810 | "graphqlHost": {
|
811 | "name": "graphqlHost",
|
812 | "type": "option",
|
813 | "description": "The Fauna GraphQL API host",
|
814 | "multiple": false
|
815 | },
|
816 | "graphqlPort": {
|
817 | "name": "graphqlPort",
|
818 | "type": "option",
|
819 | "description": "GraphQL port",
|
820 | "multiple": false
|
821 | },
|
822 | "path": {
|
823 | "name": "path",
|
824 | "type": "option",
|
825 | "description": "Path to .csv/.json file, or path to folder containing .csv/.json files. if the path is to a folder, sub-folders will be skipped.",
|
826 | "required": true,
|
827 | "multiple": false
|
828 | },
|
829 | "db": {
|
830 | "name": "db",
|
831 | "type": "option",
|
832 | "description": "Child database name; imported documents are stored in this database",
|
833 | "multiple": false
|
834 | },
|
835 | "collection": {
|
836 | "name": "collection",
|
837 | "type": "option",
|
838 | "description": "Collection name. When not specified, the collection name is the filename.",
|
839 | "required": false,
|
840 | "multiple": false
|
841 | },
|
842 | "type": {
|
843 | "name": "type",
|
844 | "type": "option",
|
845 | "description": "Column type casting - converts the column value to a Fauna type. Available only in CSVs; will be ignored in json/jsonl inputs. Null values will be treated as null and no conversion will be performed.\nFormat: <column>::<type>\n<column>: the name of the column to cast values\n<type>: one of\n\t'number' - convert string to number\n\t'bool' - convert 'true', 't', 'yes', or '1' to true and all other values to false (saving null which will be treated as null)\n\t'dateString' - convert a ISO-8601 or RFC-2822 date string to a Fauna Time; will make a best effort on other formats,\n\t'dateEpochMillis' - converts milliseconds since the epoch to a Fauna Time\n\t'dateEpochSeconds' - converts seconds since the epoch to a Fauna Time",
|
846 | "multiple": true
|
847 | },
|
848 | "append": {
|
849 | "name": "append",
|
850 | "type": "boolean",
|
851 | "description": "Allows appending documents to a non-empty collection",
|
852 | "allowNo": false
|
853 | },
|
854 | "allow-short-rows": {
|
855 | "name": "allow-short-rows",
|
856 | "type": "boolean",
|
857 | "description": "Allows rows which are shorter than the number of headers",
|
858 | "allowNo": false
|
859 | },
|
860 | "dry-run": {
|
861 | "name": "dry-run",
|
862 | "type": "boolean",
|
863 | "description": "Dry run the import - committing no documents to Fauna but converting all items to Fauna's format and applying all requested --type conversions. Enables you to detect issues with your file(s) before writing to your collection(s).",
|
864 | "allowNo": false
|
865 | },
|
866 | "treat-empty-csv-cells-as": {
|
867 | "name": "treat-empty-csv-cells-as",
|
868 | "type": "option",
|
869 | "description": "Treat empty csv cells as empty strings or null, default is null.",
|
870 | "multiple": false,
|
871 | "options": [
|
872 | "empty",
|
873 | "null"
|
874 | ],
|
875 | "default": "null"
|
876 | }
|
877 | },
|
878 | "args": {}
|
879 | },
|
880 | "list-databases": {
|
881 | "id": "list-databases",
|
882 | "description": "\nLists child databases in the current database\n",
|
883 | "strict": true,
|
884 | "pluginName": "fauna-shell",
|
885 | "pluginAlias": "fauna-shell",
|
886 | "pluginType": "core",
|
887 | "aliases": [],
|
888 | "examples": [
|
889 | "$ fauna list-databases"
|
890 | ],
|
891 | "flags": {
|
892 | "domain": {
|
893 | "name": "domain",
|
894 | "type": "option",
|
895 | "description": "Fauna server domain",
|
896 | "multiple": false
|
897 | },
|
898 | "scheme": {
|
899 | "name": "scheme",
|
900 | "type": "option",
|
901 | "description": "Connection scheme",
|
902 | "multiple": false,
|
903 | "options": [
|
904 | "https",
|
905 | "http"
|
906 | ]
|
907 | },
|
908 | "port": {
|
909 | "name": "port",
|
910 | "type": "option",
|
911 | "description": "Connection port",
|
912 | "multiple": false
|
913 | },
|
914 | "timeout": {
|
915 | "name": "timeout",
|
916 | "type": "option",
|
917 | "description": "Connection timeout in milliseconds",
|
918 | "multiple": false
|
919 | },
|
920 | "secret": {
|
921 | "name": "secret",
|
922 | "type": "option",
|
923 | "description": "Fauna secret key",
|
924 | "multiple": false
|
925 | },
|
926 | "endpoint": {
|
927 | "name": "endpoint",
|
928 | "type": "option",
|
929 | "description": "Fauna server endpoint",
|
930 | "multiple": false
|
931 | },
|
932 | "graphqlHost": {
|
933 | "name": "graphqlHost",
|
934 | "type": "option",
|
935 | "description": "The Fauna GraphQL API host",
|
936 | "multiple": false
|
937 | },
|
938 | "graphqlPort": {
|
939 | "name": "graphqlPort",
|
940 | "type": "option",
|
941 | "description": "GraphQL port",
|
942 | "multiple": false
|
943 | }
|
944 | },
|
945 | "args": {}
|
946 | },
|
947 | "list-endpoints": {
|
948 | "id": "list-endpoints",
|
949 | "description": "\nLists connection endpoints.\n",
|
950 | "strict": true,
|
951 | "pluginName": "fauna-shell",
|
952 | "pluginAlias": "fauna-shell",
|
953 | "pluginType": "core",
|
954 | "aliases": [],
|
955 | "examples": [
|
956 | "$ fauna list-endpoints"
|
957 | ],
|
958 | "flags": {
|
959 | "domain": {
|
960 | "name": "domain",
|
961 | "type": "option",
|
962 | "description": "Fauna server domain",
|
963 | "multiple": false
|
964 | },
|
965 | "scheme": {
|
966 | "name": "scheme",
|
967 | "type": "option",
|
968 | "description": "Connection scheme",
|
969 | "multiple": false,
|
970 | "options": [
|
971 | "https",
|
972 | "http"
|
973 | ]
|
974 | },
|
975 | "port": {
|
976 | "name": "port",
|
977 | "type": "option",
|
978 | "description": "Connection port",
|
979 | "multiple": false
|
980 | },
|
981 | "timeout": {
|
982 | "name": "timeout",
|
983 | "type": "option",
|
984 | "description": "Connection timeout in milliseconds",
|
985 | "multiple": false
|
986 | },
|
987 | "secret": {
|
988 | "name": "secret",
|
989 | "type": "option",
|
990 | "description": "Fauna secret key",
|
991 | "multiple": false
|
992 | },
|
993 | "endpoint": {
|
994 | "name": "endpoint",
|
995 | "type": "option",
|
996 | "description": "Fauna server endpoint",
|
997 | "multiple": false
|
998 | },
|
999 | "graphqlHost": {
|
1000 | "name": "graphqlHost",
|
1001 | "type": "option",
|
1002 | "description": "The Fauna GraphQL API host",
|
1003 | "multiple": false
|
1004 | },
|
1005 | "graphqlPort": {
|
1006 | "name": "graphqlPort",
|
1007 | "type": "option",
|
1008 | "description": "GraphQL port",
|
1009 | "multiple": false
|
1010 | }
|
1011 | },
|
1012 | "args": {}
|
1013 | },
|
1014 | "list-keys": {
|
1015 | "id": "list-keys",
|
1016 | "description": "\nList keys in the current database or in its child databases\n",
|
1017 | "strict": true,
|
1018 | "pluginName": "fauna-shell",
|
1019 | "pluginAlias": "fauna-shell",
|
1020 | "pluginType": "core",
|
1021 | "aliases": [],
|
1022 | "examples": [
|
1023 | "$ fauna list-keys"
|
1024 | ],
|
1025 | "flags": {
|
1026 | "domain": {
|
1027 | "name": "domain",
|
1028 | "type": "option",
|
1029 | "description": "Fauna server domain",
|
1030 | "multiple": false
|
1031 | },
|
1032 | "scheme": {
|
1033 | "name": "scheme",
|
1034 | "type": "option",
|
1035 | "description": "Connection scheme",
|
1036 | "multiple": false,
|
1037 | "options": [
|
1038 | "https",
|
1039 | "http"
|
1040 | ]
|
1041 | },
|
1042 | "port": {
|
1043 | "name": "port",
|
1044 | "type": "option",
|
1045 | "description": "Connection port",
|
1046 | "multiple": false
|
1047 | },
|
1048 | "timeout": {
|
1049 | "name": "timeout",
|
1050 | "type": "option",
|
1051 | "description": "Connection timeout in milliseconds",
|
1052 | "multiple": false
|
1053 | },
|
1054 | "secret": {
|
1055 | "name": "secret",
|
1056 | "type": "option",
|
1057 | "description": "Fauna secret key",
|
1058 | "multiple": false
|
1059 | },
|
1060 | "endpoint": {
|
1061 | "name": "endpoint",
|
1062 | "type": "option",
|
1063 | "description": "Fauna server endpoint",
|
1064 | "multiple": false
|
1065 | },
|
1066 | "graphqlHost": {
|
1067 | "name": "graphqlHost",
|
1068 | "type": "option",
|
1069 | "description": "The Fauna GraphQL API host",
|
1070 | "multiple": false
|
1071 | },
|
1072 | "graphqlPort": {
|
1073 | "name": "graphqlPort",
|
1074 | "type": "option",
|
1075 | "description": "GraphQL port",
|
1076 | "multiple": false
|
1077 | }
|
1078 | },
|
1079 | "args": {}
|
1080 | },
|
1081 | "run-queries": {
|
1082 | "id": "run-queries",
|
1083 | "description": "\nDeprecated: fauna run-queries is deprecated. Use eval instead\nRuns the queries found on the file passed to the command.\n",
|
1084 | "strict": true,
|
1085 | "pluginName": "fauna-shell",
|
1086 | "pluginAlias": "fauna-shell",
|
1087 | "pluginType": "core",
|
1088 | "aliases": [],
|
1089 | "examples": [
|
1090 | "$ fauna run-queries dbname --file=/path/to/queries.fql"
|
1091 | ],
|
1092 | "flags": {
|
1093 | "domain": {
|
1094 | "name": "domain",
|
1095 | "type": "option",
|
1096 | "description": "Fauna server domain",
|
1097 | "multiple": false
|
1098 | },
|
1099 | "scheme": {
|
1100 | "name": "scheme",
|
1101 | "type": "option",
|
1102 | "description": "Connection scheme",
|
1103 | "multiple": false,
|
1104 | "options": [
|
1105 | "https",
|
1106 | "http"
|
1107 | ]
|
1108 | },
|
1109 | "port": {
|
1110 | "name": "port",
|
1111 | "type": "option",
|
1112 | "description": "Connection port",
|
1113 | "multiple": false
|
1114 | },
|
1115 | "timeout": {
|
1116 | "name": "timeout",
|
1117 | "type": "option",
|
1118 | "description": "Connection timeout in milliseconds",
|
1119 | "multiple": false
|
1120 | },
|
1121 | "secret": {
|
1122 | "name": "secret",
|
1123 | "type": "option",
|
1124 | "description": "Fauna secret key",
|
1125 | "multiple": false
|
1126 | },
|
1127 | "endpoint": {
|
1128 | "name": "endpoint",
|
1129 | "type": "option",
|
1130 | "description": "Fauna server endpoint",
|
1131 | "multiple": false
|
1132 | },
|
1133 | "graphqlHost": {
|
1134 | "name": "graphqlHost",
|
1135 | "type": "option",
|
1136 | "description": "The Fauna GraphQL API host",
|
1137 | "multiple": false
|
1138 | },
|
1139 | "graphqlPort": {
|
1140 | "name": "graphqlPort",
|
1141 | "type": "option",
|
1142 | "description": "GraphQL port",
|
1143 | "multiple": false
|
1144 | },
|
1145 | "file": {
|
1146 | "name": "file",
|
1147 | "type": "option",
|
1148 | "description": "File where to read queries from",
|
1149 | "required": true,
|
1150 | "multiple": false
|
1151 | },
|
1152 | "stdin": {
|
1153 | "name": "stdin",
|
1154 | "type": "boolean",
|
1155 | "description": "Read file input from stdin. Writes to stdout by default",
|
1156 | "allowNo": false
|
1157 | },
|
1158 | "output": {
|
1159 | "name": "output",
|
1160 | "type": "option",
|
1161 | "description": "File to write output to",
|
1162 | "multiple": false,
|
1163 | "default": null
|
1164 | },
|
1165 | "format": {
|
1166 | "name": "format",
|
1167 | "type": "option",
|
1168 | "description": "Output format",
|
1169 | "multiple": false,
|
1170 | "options": [
|
1171 | "json",
|
1172 | "json-tagged",
|
1173 | "shell"
|
1174 | ]
|
1175 | },
|
1176 | "version": {
|
1177 | "name": "version",
|
1178 | "type": "option",
|
1179 | "description": "FQL Version",
|
1180 | "multiple": false,
|
1181 | "options": [
|
1182 | "4",
|
1183 | "10"
|
1184 | ],
|
1185 | "default": "10"
|
1186 | },
|
1187 | "typecheck": {
|
1188 | "name": "typecheck",
|
1189 | "type": "boolean",
|
1190 | "description": "Enable typechecking",
|
1191 | "allowNo": false
|
1192 | }
|
1193 | },
|
1194 | "args": {
|
1195 | "dbname": {
|
1196 | "name": "dbname",
|
1197 | "description": "Database name",
|
1198 | "required": false
|
1199 | },
|
1200 | "query": {
|
1201 | "name": "query",
|
1202 | "description": "FQL query to execute",
|
1203 | "required": false
|
1204 | }
|
1205 | }
|
1206 | },
|
1207 | "shell": {
|
1208 | "id": "shell",
|
1209 | "description": "\nStarts an interactive shell.\n",
|
1210 | "strict": true,
|
1211 | "pluginName": "fauna-shell",
|
1212 | "pluginAlias": "fauna-shell",
|
1213 | "pluginType": "core",
|
1214 | "aliases": [],
|
1215 | "examples": [
|
1216 | "$ fauna shell dbname"
|
1217 | ],
|
1218 | "flags": {
|
1219 | "domain": {
|
1220 | "name": "domain",
|
1221 | "type": "option",
|
1222 | "description": "Fauna server domain",
|
1223 | "multiple": false
|
1224 | },
|
1225 | "scheme": {
|
1226 | "name": "scheme",
|
1227 | "type": "option",
|
1228 | "description": "Connection scheme",
|
1229 | "multiple": false,
|
1230 | "options": [
|
1231 | "https",
|
1232 | "http"
|
1233 | ]
|
1234 | },
|
1235 | "port": {
|
1236 | "name": "port",
|
1237 | "type": "option",
|
1238 | "description": "Connection port",
|
1239 | "multiple": false
|
1240 | },
|
1241 | "timeout": {
|
1242 | "name": "timeout",
|
1243 | "type": "option",
|
1244 | "description": "Connection timeout in milliseconds",
|
1245 | "multiple": false
|
1246 | },
|
1247 | "secret": {
|
1248 | "name": "secret",
|
1249 | "type": "option",
|
1250 | "description": "Fauna secret key",
|
1251 | "multiple": false
|
1252 | },
|
1253 | "endpoint": {
|
1254 | "name": "endpoint",
|
1255 | "type": "option",
|
1256 | "description": "Fauna server endpoint",
|
1257 | "multiple": false
|
1258 | },
|
1259 | "graphqlHost": {
|
1260 | "name": "graphqlHost",
|
1261 | "type": "option",
|
1262 | "description": "The Fauna GraphQL API host",
|
1263 | "multiple": false
|
1264 | },
|
1265 | "graphqlPort": {
|
1266 | "name": "graphqlPort",
|
1267 | "type": "option",
|
1268 | "description": "GraphQL port",
|
1269 | "multiple": false
|
1270 | },
|
1271 | "file": {
|
1272 | "name": "file",
|
1273 | "type": "option",
|
1274 | "description": "File where to read queries from",
|
1275 | "multiple": false
|
1276 | },
|
1277 | "stdin": {
|
1278 | "name": "stdin",
|
1279 | "type": "boolean",
|
1280 | "description": "Read file input from stdin. Writes to stdout by default",
|
1281 | "allowNo": false
|
1282 | },
|
1283 | "output": {
|
1284 | "name": "output",
|
1285 | "type": "option",
|
1286 | "description": "File to write output to",
|
1287 | "multiple": false,
|
1288 | "default": null
|
1289 | },
|
1290 | "format": {
|
1291 | "name": "format",
|
1292 | "type": "option",
|
1293 | "description": "Output format",
|
1294 | "multiple": false,
|
1295 | "options": [
|
1296 | "json",
|
1297 | "json-tagged",
|
1298 | "shell"
|
1299 | ]
|
1300 | },
|
1301 | "version": {
|
1302 | "name": "version",
|
1303 | "type": "option",
|
1304 | "description": "FQL Version",
|
1305 | "multiple": false,
|
1306 | "options": [
|
1307 | "4",
|
1308 | "10"
|
1309 | ],
|
1310 | "default": "10"
|
1311 | },
|
1312 | "typecheck": {
|
1313 | "name": "typecheck",
|
1314 | "type": "boolean",
|
1315 | "description": "Enable typechecking",
|
1316 | "allowNo": false
|
1317 | }
|
1318 | },
|
1319 | "args": {
|
1320 | "dbname": {
|
1321 | "name": "dbname",
|
1322 | "description": "database name",
|
1323 | "required": false
|
1324 | }
|
1325 | }
|
1326 | },
|
1327 | "upload-graphql-schema": {
|
1328 | "id": "upload-graphql-schema",
|
1329 | "description": "Upload GraphQL schema",
|
1330 | "strict": true,
|
1331 | "pluginName": "fauna-shell",
|
1332 | "pluginAlias": "fauna-shell",
|
1333 | "pluginType": "core",
|
1334 | "aliases": [],
|
1335 | "examples": [
|
1336 | "$ fauna upload-graphql-schema ./schema.gql",
|
1337 | "$ fauna upload-graphql-schema ./schema.gql --mode override"
|
1338 | ],
|
1339 | "flags": {
|
1340 | "domain": {
|
1341 | "name": "domain",
|
1342 | "type": "option",
|
1343 | "description": "Fauna server domain",
|
1344 | "multiple": false
|
1345 | },
|
1346 | "scheme": {
|
1347 | "name": "scheme",
|
1348 | "type": "option",
|
1349 | "description": "Connection scheme",
|
1350 | "multiple": false,
|
1351 | "options": [
|
1352 | "https",
|
1353 | "http"
|
1354 | ]
|
1355 | },
|
1356 | "port": {
|
1357 | "name": "port",
|
1358 | "type": "option",
|
1359 | "description": "Connection port",
|
1360 | "multiple": false
|
1361 | },
|
1362 | "timeout": {
|
1363 | "name": "timeout",
|
1364 | "type": "option",
|
1365 | "description": "Connection timeout in milliseconds",
|
1366 | "multiple": false
|
1367 | },
|
1368 | "secret": {
|
1369 | "name": "secret",
|
1370 | "type": "option",
|
1371 | "description": "Fauna secret key",
|
1372 | "multiple": false
|
1373 | },
|
1374 | "endpoint": {
|
1375 | "name": "endpoint",
|
1376 | "type": "option",
|
1377 | "description": "Fauna server endpoint",
|
1378 | "multiple": false
|
1379 | },
|
1380 | "graphqlHost": {
|
1381 | "name": "graphqlHost",
|
1382 | "type": "option",
|
1383 | "description": "The Fauna GraphQL API host",
|
1384 | "multiple": false
|
1385 | },
|
1386 | "graphqlPort": {
|
1387 | "name": "graphqlPort",
|
1388 | "type": "option",
|
1389 | "description": "GraphQL port",
|
1390 | "multiple": false
|
1391 | },
|
1392 | "mode": {
|
1393 | "name": "mode",
|
1394 | "type": "option",
|
1395 | "description": "Upload mode",
|
1396 | "multiple": false,
|
1397 | "options": [
|
1398 | "merge",
|
1399 | "override",
|
1400 | "replace"
|
1401 | ],
|
1402 | "default": "merge"
|
1403 | }
|
1404 | },
|
1405 | "args": {
|
1406 | "graphqlFilePath": {
|
1407 | "name": "graphqlFilePath",
|
1408 | "description": "Path to GraphQL schema",
|
1409 | "required": true
|
1410 | }
|
1411 | }
|
1412 | }
|
1413 | }
|
1414 | } |
\ | No newline at end of file |