fauna-shell
Advanced tools
fauna-shell - npm Package Compare versions
Comparing version 0.13.0 to 0.14.0
@@ -1,1 +0,1 @@ | ||
| {"version":"0.13.0","commands":{"add-endpoint":{"id":"add-endpoint","description":"\nAdds a connection endpoint for FaunaDB\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna add-endpoint https://db.fauna.com:443","$ fauna add-endpoint http://localhost:8443/ --alias localhost --key secret"],"flags":{"alias":{"name":"alias","type":"option","description":"FaunaDB server endpoint alias","required":false},"key":{"name":"key","type":"option","description":"FaunaDB server endpoint key","required":false}},"args":[{"name":"endpoint","description":"FaunaDB server endpoint","required":true}]},"cloud-login":{"id":"cloud-login","description":"Adds the FaunaDB Cloud endpoint","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna cloud-login"],"flags":{},"args":[]},"create-database":{"id":"create-database","description":"\nCreates a database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna create-database dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":true}]},"create-key":{"id":"create-key","description":"\nCreates a key for the specified database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna create-key dbname admin"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":true},{"name":"role","description":"key user role","options":["admin","server","server-readonly","client"]}]},"default-endpoint":{"id":"default-endpoint","description":"\nSets an endpoint as the default one\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna default-endpoint endpoint"],"flags":{},"args":[{"name":"endpoint_alias","description":"FaunaDB server endpoint alias","required":true}]},"delete-database":{"id":"delete-database","description":"\nDeletes a database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-database dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":true}]},"delete-endpoint":{"id":"delete-endpoint","description":"\nDeletes a connection endpoint for FaunaDB\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-endpoint endpoint_alias"],"flags":{},"args":[{"name":"endpoint_alias","description":"FaunaDB server endpoint alias","required":true}]},"delete-key":{"id":"delete-key","description":"\nDeletes a key\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-key 123456789012345678"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"keyname","description":"key name","required":true}]},"eval":{"id":"eval","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna eval \"Paginate(Collections())\"","$ fauna eval nestedDbName \"Paginate(Collections())\"","$ fauna eval --file=/path/to/queries.fql","$ echo \"Add(1,1)\" | fauna eval --stdin","$ fauna eval \"Add(2,3)\" --output=/tmp/result\"","$ fauna eval \"Add(2,3)\" --format=json --output=/tmp/result\""],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"},"file":{"name":"file","type":"option","description":"File where to read queries from"},"stdin":{"name":"stdin","type":"boolean","description":"Read file input from stdin. Writes to stdout by default","allowNo":false},"output":{"name":"output","type":"option","description":"File to write output to","default":null},"format":{"name":"format","type":"option","description":"Output format","options":["json","shell"],"default":"json"}},"args":[{"name":"dbname","description":"Database name","required":false},{"name":"query","description":"FQL query to execute","required":false}]},"import":{"id":"import","description":"Import data to Fauna","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna import --path ./collection_name.csv","$ fauna import --append --path ./collection.csv","$ fauna import --db=sampleDB --collection=SampleCollection --path ./datafile.csv","$ fauna import --db=sampleDB --path ./dump","$ fauna import --type=header_name::date --type=hdr2::number --type=hdrX::bool --path ./collection.csv"],"flags":{"path":{"name":"path","type":"option","description":"Path to .csv/.json file, or path to folder containing .csv/.json files","required":true},"db":{"name":"db","type":"option","description":"Child database name; imported documents are stored in this database"},"collection":{"name":"collection","type":"option","description":"Collection name. When not specified, the collection name is the filename when --path is file","required":false},"type":{"name":"type","type":"option","description":"Column type casting, converts the column value to a Fauna type.\nFormat: <column>::<type>\n<column>: the name of the column to cast values\n<type>: one of 'number', 'bool', or 'date'."},"append":{"name":"append","type":"boolean","description":"Allows appending documents to a non-empty collection","allowNo":false},"allow-short-rows":{"name":"allow-short-rows","type":"boolean","description":"Allows rows which are shorter than the number of headers","allowNo":false},"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[]},"list-databases":{"id":"list-databases","description":"\nLists child databases in the current database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-databases"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[]},"list-endpoints":{"id":"list-endpoints","description":"\nLists FaunaDB connection endpoints\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-endpoints"],"flags":{},"args":[]},"list-keys":{"id":"list-keys","description":"\nList keys in the current database or in its child databases\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-keys"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[]},"run-queries":{"id":"run-queries","description":"\nDeprecated: fauna run-queries is deprecated. Use eval instead\nRuns the queries found on the file passed to the command.\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna run-queries dbname --file=/path/to/queries.fql"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"},"file":{"name":"file","type":"option","description":"File where to read queries from","required":true}},"args":[{"name":"dbname","description":"Database name","required":false},{"name":"query","description":"FQL query to execute","required":false}]},"shell":{"id":"shell","description":"\nStarts a FaunaDB shell\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna shell dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":false}]},"upload-graphql-schema":{"id":"upload-graphql-schema","description":"Upload GraphQL schema","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna upload-graphql-schema ./schema.gql","$ fauna upload-graphql-schema ./schema.gql --mode override"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"},"mode":{"name":"mode","type":"option","description":"Upload mode","options":["merge","override","replace"],"default":"merge"}},"args":[{"name":"graphqlFilePath","description":"Path to GraphQL schema","required":true}]}}} | ||
| {"version":"0.14.0","commands":{"add-endpoint":{"id":"add-endpoint","description":"\nAdds a connection endpoint for FaunaDB\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna add-endpoint https://db.fauna.com:443","$ fauna add-endpoint http://localhost:8443/ --alias localhost --key secret"],"flags":{"alias":{"name":"alias","type":"option","description":"FaunaDB server endpoint alias","required":false},"key":{"name":"key","type":"option","description":"FaunaDB server endpoint key","required":false}},"args":[{"name":"endpoint","description":"FaunaDB server endpoint","required":true}]},"cloud-login":{"id":"cloud-login","description":"Adds the FaunaDB Cloud endpoint","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna cloud-login"],"flags":{},"args":[]},"create-database":{"id":"create-database","description":"\nCreates a database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna create-database dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":true}]},"create-key":{"id":"create-key","description":"\nCreates a key for the specified database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna create-key dbname admin"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":true},{"name":"role","description":"key user role","options":["admin","server","server-readonly","client"]}]},"default-endpoint":{"id":"default-endpoint","description":"\nSets an endpoint as the default one\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna default-endpoint endpoint"],"flags":{},"args":[{"name":"endpoint_alias","description":"FaunaDB server endpoint alias","required":true}]},"delete-database":{"id":"delete-database","description":"\nDeletes a database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-database dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":true}]},"delete-endpoint":{"id":"delete-endpoint","description":"\nDeletes a connection endpoint for FaunaDB\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-endpoint endpoint_alias"],"flags":{},"args":[{"name":"endpoint_alias","description":"FaunaDB server endpoint alias","required":true}]},"delete-key":{"id":"delete-key","description":"\nDeletes a key\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna delete-key 123456789012345678"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"keyname","description":"key name","required":true}]},"eval":{"id":"eval","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna eval \"Paginate(Collections())\"","$ fauna eval nestedDbName \"Paginate(Collections())\"","$ fauna eval --file=/path/to/queries.fql","$ echo \"Add(1,1)\" | fauna eval --stdin","$ fauna eval \"Add(2,3)\" --output=/tmp/result\"","$ fauna eval \"Add(2,3)\" --format=json --output=/tmp/result\""],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"},"file":{"name":"file","type":"option","description":"File where to read queries from"},"stdin":{"name":"stdin","type":"boolean","description":"Read file input from stdin. Writes to stdout by default","allowNo":false},"output":{"name":"output","type":"option","description":"File to write output to","default":null},"format":{"name":"format","type":"option","description":"Output format","options":["json","shell"],"default":"json"}},"args":[{"name":"dbname","description":"Database name","required":false},{"name":"query","description":"FQL query to execute","required":false}]},"import":{"id":"import","description":"Import data to Fauna","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna import --path ./collection_name.csv","$ fauna import --append --path ./collection.csv","$ fauna import --db=sampleDB --collection=SampleCollection --path ./datafile.csv","$ fauna import --db=sampleDB --path ./dump","$ fauna import --type=header_name::date --type=hdr2::number --type=hdrX::bool --path ./collection.csv"],"flags":{"path":{"name":"path","type":"option","description":"Path to .csv/.json file, or path to folder containing .csv/.json files","required":true},"db":{"name":"db","type":"option","description":"Child database name; imported documents are stored in this database"},"collection":{"name":"collection","type":"option","description":"Collection name. When not specified, the collection name is the filename when --path is file","required":false},"type":{"name":"type","type":"option","description":"Column type casting, converts the column value to a Fauna type.\nFormat: <column>::<type>\n<column>: the name of the column to cast values\n<type>: one of 'number', 'bool', or 'date'."},"append":{"name":"append","type":"boolean","description":"Allows appending documents to a non-empty collection","allowNo":false},"allow-short-rows":{"name":"allow-short-rows","type":"boolean","description":"Allows rows which are shorter than the number of headers","allowNo":false},"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"}},"args":[]},"list-databases":{"id":"list-databases","description":"\nLists child databases in the current database\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-databases"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[]},"list-endpoints":{"id":"list-endpoints","description":"\nLists FaunaDB connection endpoints\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-endpoints"],"flags":{},"args":[]},"list-keys":{"id":"list-keys","description":"\nList keys in the current database or in its child databases\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna list-keys"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[]},"run-queries":{"id":"run-queries","description":"\nDeprecated: fauna run-queries is deprecated. Use eval instead\nRuns the queries found on the file passed to the command.\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna run-queries dbname --file=/path/to/queries.fql"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"},"file":{"name":"file","type":"option","description":"File where to read queries from","required":true}},"args":[{"name":"dbname","description":"Database name","required":false},{"name":"query","description":"FQL query to execute","required":false}]},"shell":{"id":"shell","description":"\nStarts a FaunaDB shell\n","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna shell dbname"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"}},"args":[{"name":"dbname","description":"database name","required":false}]},"upload-graphql-schema":{"id":"upload-graphql-schema","description":"Upload GraphQL schema","pluginName":"fauna-shell","pluginType":"core","aliases":[],"examples":["$ fauna upload-graphql-schema ./schema.gql","$ fauna upload-graphql-schema ./schema.gql --mode override"],"flags":{"domain":{"name":"domain","type":"option","description":"FaunaDB server domain"},"scheme":{"name":"scheme","type":"option","description":"Connection scheme","options":["https","http"]},"port":{"name":"port","type":"option","description":"Connection port"},"timeout":{"name":"timeout","type":"option","description":"Connection timeout in milliseconds"},"secret":{"name":"secret","type":"option","description":"FaunaDB secret key"},"endpoint":{"name":"endpoint","type":"option","description":"FaunaDB server endpoint"},"graphqlHost":{"name":"graphqlHost","type":"option","description":"The Fauna GraphQL API host"},"graphqlPort":{"name":"graphqlPort","type":"option","description":"GraphQL port"},"mode":{"name":"mode","type":"option","description":"Upload mode","options":["merge","override","replace"],"default":"merge"}},"args":[{"name":"graphqlFilePath","description":"Path to GraphQL schema","required":true}]}}} |
| { | ||
| "name": "fauna-shell", | ||
| "description": "faunadb shell", | ||
| "version": "0.13.0", | ||
| "version": "0.14.0", | ||
| "author": "Fauna", | ||
@@ -23,3 +23,3 @@ "bin": { | ||
| "esprima": "^4.0.1", | ||
| "faunadb": "^4.4.1", | ||
| "faunadb": "^4.5.2", | ||
| "globby": "^11.0.0", | ||
@@ -29,3 +29,3 @@ "heroku-cli-util": "^8.0.9", | ||
| "inquirer": "^8.1.1", | ||
| "node-fetch": "^2.6.1", | ||
| "node-fetch": "^2.6.7", | ||
| "object-sizeof": "^1.6.1", | ||
@@ -32,0 +32,0 @@ "prettier": "^2.3.0", |
109
README.md
@@ -495,5 +495,2 @@ # fauna-shell | ||
| ``` | ||
| Adds a connection endpoint for FaunaDB | ||
| USAGE | ||
@@ -512,10 +509,8 @@ $ fauna add-endpoint ENDPOINT | ||
| EXAMPLES | ||
| $ fauna add-endpoint https://db.fauna.com:443 | ||
| $ fauna add-endpoint http://localhost:8443/ --alias localhost --key secret | ||
| ``` | ||
| _See code: [src/commands/add-endpoint.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/add-endpoint.js)_ | ||
| _See code: [src/commands/add-endpoint.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/add-endpoint.js)_ | ||
@@ -527,4 +522,2 @@ ## `fauna autocomplete [SHELL]` | ||
| ``` | ||
| display autocomplete installation instructions | ||
| USAGE | ||
@@ -541,7 +534,4 @@ $ fauna autocomplete [SHELL] | ||
| $ fauna autocomplete | ||
| $ fauna autocomplete bash | ||
| $ fauna autocomplete zsh | ||
| $ fauna autocomplete --refresh-cache | ||
@@ -557,4 +547,2 @@ ``` | ||
| ``` | ||
| Adds the FaunaDB Cloud endpoint | ||
| USAGE | ||
@@ -567,3 +555,3 @@ $ fauna cloud-login | ||
| _See code: [src/commands/cloud-login.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/cloud-login.js)_ | ||
| _See code: [src/commands/cloud-login.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/cloud-login.js)_ | ||
@@ -575,5 +563,2 @@ ## `fauna create-database DBNAME` | ||
| ``` | ||
| Creates a database | ||
| USAGE | ||
@@ -598,3 +583,2 @@ $ fauna create-database DBNAME | ||
| EXAMPLE | ||
@@ -604,3 +588,3 @@ $ fauna create-database dbname | ||
| _See code: [src/commands/create-database.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/create-database.js)_ | ||
| _See code: [src/commands/create-database.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/create-database.js)_ | ||
@@ -612,5 +596,2 @@ ## `fauna create-key DBNAME [ROLE]` | ||
| ``` | ||
| Creates a key for the specified database | ||
| USAGE | ||
@@ -621,3 +602,3 @@ $ fauna create-key DBNAME [ROLE] | ||
| DBNAME database name | ||
| ROLE key user role | ||
| ROLE (admin|server|server-readonly|client) key user role | ||
@@ -637,3 +618,2 @@ OPTIONS | ||
| EXAMPLE | ||
@@ -643,3 +623,3 @@ $ fauna create-key dbname admin | ||
| _See code: [src/commands/create-key.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/create-key.js)_ | ||
| _See code: [src/commands/create-key.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/create-key.js)_ | ||
@@ -651,5 +631,2 @@ ## `fauna default-endpoint ENDPOINT_ALIAS` | ||
| ``` | ||
| Sets an endpoint as the default one | ||
| USAGE | ||
@@ -664,3 +641,2 @@ $ fauna default-endpoint ENDPOINT_ALIAS | ||
| EXAMPLE | ||
@@ -670,3 +646,3 @@ $ fauna default-endpoint endpoint | ||
| _See code: [src/commands/default-endpoint.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/default-endpoint.js)_ | ||
| _See code: [src/commands/default-endpoint.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/default-endpoint.js)_ | ||
@@ -678,5 +654,2 @@ ## `fauna delete-database DBNAME` | ||
| ``` | ||
| Deletes a database | ||
| USAGE | ||
@@ -701,3 +674,2 @@ $ fauna delete-database DBNAME | ||
| EXAMPLE | ||
@@ -707,3 +679,3 @@ $ fauna delete-database dbname | ||
| _See code: [src/commands/delete-database.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/delete-database.js)_ | ||
| _See code: [src/commands/delete-database.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/delete-database.js)_ | ||
@@ -715,5 +687,2 @@ ## `fauna delete-endpoint ENDPOINT_ALIAS` | ||
| ``` | ||
| Deletes a connection endpoint for FaunaDB | ||
| USAGE | ||
@@ -728,3 +697,2 @@ $ fauna delete-endpoint ENDPOINT_ALIAS | ||
| EXAMPLE | ||
@@ -734,3 +702,3 @@ $ fauna delete-endpoint endpoint_alias | ||
| _See code: [src/commands/delete-endpoint.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/delete-endpoint.js)_ | ||
| _See code: [src/commands/delete-endpoint.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/delete-endpoint.js)_ | ||
@@ -742,5 +710,2 @@ ## `fauna delete-key KEYNAME` | ||
| ``` | ||
| Deletes a key | ||
| USAGE | ||
@@ -765,3 +730,2 @@ $ fauna delete-key KEYNAME | ||
| EXAMPLE | ||
@@ -771,3 +735,3 @@ $ fauna delete-key 123456789012345678 | ||
| _See code: [src/commands/delete-key.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/delete-key.js)_ | ||
| _See code: [src/commands/delete-key.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/delete-key.js)_ | ||
@@ -777,4 +741,2 @@ ## `fauna eval [DBNAME] [QUERY]` | ||
| ``` | ||
| undefined | ||
| USAGE | ||
@@ -803,15 +765,10 @@ $ fauna eval [DBNAME] [QUERY] | ||
| $ fauna eval "Paginate(Collections())" | ||
| $ fauna eval nestedDbName "Paginate(Collections())" | ||
| $ fauna eval --file=/path/to/queries.fql | ||
| $ echo "Add(1,1)" | fauna eval --stdin | ||
| $ fauna eval "Add(2,3)" --output=/tmp/result" | ||
| $ fauna eval "Add(2,3)" --format=json --output=/tmp/result" | ||
| ``` | ||
| _See code: [src/commands/eval.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/eval.js)_ | ||
| _See code: [src/commands/eval.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/eval.js)_ | ||
@@ -823,4 +780,2 @@ ## `fauna help [COMMAND]` | ||
| ``` | ||
| display help for <%= config.bin %> | ||
| USAGE | ||
@@ -843,4 +798,2 @@ $ fauna help [COMMAND] | ||
| ``` | ||
| Import data to Fauna | ||
| USAGE | ||
@@ -869,13 +822,9 @@ $ fauna import | ||
| $ fauna import --path ./collection_name.csv | ||
| $ fauna import --append --path ./collection.csv | ||
| $ fauna import --db=sampleDB --collection=SampleCollection --path ./datafile.csv | ||
| $ fauna import --db=sampleDB --path ./dump | ||
| $ fauna import --type=header_name::date --type=hdr2::number --type=hdrX::bool --path ./collection.csv | ||
| ``` | ||
| _See code: [src/commands/import.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/import.js)_ | ||
| _See code: [src/commands/import.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/import.js)_ | ||
@@ -887,5 +836,2 @@ ## `fauna list-databases` | ||
| ``` | ||
| Lists child databases in the current database | ||
| USAGE | ||
@@ -907,3 +853,2 @@ $ fauna list-databases | ||
| EXAMPLE | ||
@@ -913,3 +858,3 @@ $ fauna list-databases | ||
| _See code: [src/commands/list-databases.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/list-databases.js)_ | ||
| _See code: [src/commands/list-databases.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/list-databases.js)_ | ||
@@ -921,5 +866,2 @@ ## `fauna list-endpoints` | ||
| ``` | ||
| Lists FaunaDB connection endpoints | ||
| USAGE | ||
@@ -931,3 +873,2 @@ $ fauna list-endpoints | ||
| EXAMPLE | ||
@@ -937,3 +878,3 @@ $ fauna list-endpoints | ||
| _See code: [src/commands/list-endpoints.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/list-endpoints.js)_ | ||
| _See code: [src/commands/list-endpoints.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/list-endpoints.js)_ | ||
@@ -945,5 +886,2 @@ ## `fauna list-keys` | ||
| ``` | ||
| List keys in the current database or in its child databases | ||
| USAGE | ||
@@ -965,3 +903,2 @@ $ fauna list-keys | ||
| EXAMPLE | ||
@@ -971,3 +908,3 @@ $ fauna list-keys | ||
| _See code: [src/commands/list-keys.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/list-keys.js)_ | ||
| _See code: [src/commands/list-keys.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/list-keys.js)_ | ||
@@ -979,6 +916,2 @@ ## `fauna run-queries [DBNAME] [QUERY]` | ||
| ``` | ||
| Deprecated: fauna run-queries is deprecated. Use eval instead | ||
| Runs the queries found on the file passed to the command. | ||
| USAGE | ||
@@ -1006,3 +939,2 @@ $ fauna run-queries [DBNAME] [QUERY] | ||
| EXAMPLE | ||
@@ -1012,3 +944,3 @@ $ fauna run-queries dbname --file=/path/to/queries.fql | ||
| _See code: [src/commands/run-queries.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/run-queries.js)_ | ||
| _See code: [src/commands/run-queries.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/run-queries.js)_ | ||
@@ -1020,5 +952,2 @@ ## `fauna shell [DBNAME]` | ||
| ``` | ||
| Starts a FaunaDB shell | ||
| USAGE | ||
@@ -1043,3 +972,2 @@ $ fauna shell [DBNAME] | ||
| EXAMPLE | ||
@@ -1049,3 +977,3 @@ $ fauna shell dbname | ||
| _See code: [src/commands/shell.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/shell.js)_ | ||
| _See code: [src/commands/shell.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/shell.js)_ | ||
@@ -1057,4 +985,2 @@ ## `fauna upload-graphql-schema GRAPHQLFILEPATH` | ||
| ``` | ||
| Upload GraphQL schema | ||
| USAGE | ||
@@ -1079,7 +1005,6 @@ $ fauna upload-graphql-schema GRAPHQLFILEPATH | ||
| $ fauna upload-graphql-schema ./schema.gql | ||
| $ fauna upload-graphql-schema ./schema.gql --mode override | ||
| ``` | ||
| _See code: [src/commands/upload-graphql-schema.js](https://github.com/fauna/fauna-shell/blob/v0.13.0/src/commands/upload-graphql-schema.js)_ | ||
| _See code: [src/commands/upload-graphql-schema.js](https://github.com/fauna/fauna-shell/blob/v0.14.0/src/commands/upload-graphql-schema.js)_ | ||
| <!-- commandsstop --> | ||
@@ -1086,0 +1011,0 @@ |
@@ -66,5 +66,5 @@ const fs = require('fs') | ||
| if (this.isDir(subPath)) { | ||
| const message = `"${file}" subdirectory is skipped from processing` | ||
| failedFiles.push(message) | ||
| this.warn(message) | ||
| const warning = `"${file}" subdirectory is skipped from processing` | ||
| failedFiles.push({ file, warning }) | ||
| this.warn(warning) | ||
| continue | ||
@@ -71,0 +71,0 @@ } |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.54%
123922
- Number of lines in readme file
- decreased by-7.13%
977
Dependency changes
Updatedfaunadb@^4.5.2
Updatednode-fetch@^2.6.7