fauna-gql-upload
Advanced tools
Changelog
2.5.0 June 18th, 2022
Support for concatenating multiple schema files before uploading to Fauna. This means that you can define queries, mutations, inputs and collections in separate files. These files will then merged together into a single file before uploading it to Fauna. This requires the schemaDir option to be specified in .fauna.json.
Init command. This makes it easier to get started with FGU. You simply run npx fgu init, answer the questions, and you're all set.
JSON schema to make config writing easier. Add "$schema": "node_modules/fauna-gql-upload/config.schema.json" as the top property in your .fauna.json file to use it, or initialize the project with the init command mentioned above.
Support for specifying custom refs when uploading data. Thanks to @employee451 for suggesting this.
Readme
Important note: The minimum supported node version is v12.10.0
Fauna GQL Upload is a simple CLI to update your FaunaDB database's GraphQL schema, resolver functions, indexes, and database roles without going to the FaunaDB dashboard. It uses the https://graphql.fauna.com/import endpoint to update the schema from a file within your project, and the FQL driver for JavaScript to update/create functions, roles, and indexes.
Read the documentation to get started!
NOTE: If you want to use this package with typescript, you do not need to build the resources manually. As of version 1.9.0, type-checking and typescript compilation is handled automatically without extra configuration. Read more about typescript support.
To install, run:
npm install --save-dev faunadb fauna-gql-upload
or with yarn:
yarn add -D faunadb fauna-gql-upload
To view the documentation, visit the new documentation site.
Version 2.0.0 hasn't introduced too many breaking changes, so migration should be fairly simple. Here are the changes that might cause issues.
Fauna GQL Upload previously supported global installation to be used as a CLI. Support for global installations has been removed. If you have a previous global installation, I suggest removing that from your system. To continue using the package, you'll simply have to follow the getting started section in the documentation.
faunadbIt was previously possible to use Fauna GQL Upload without a local faunadb installation. This is no longer possible, the package now relies solely on the faunadb version that you install.
faunadb@>=4.0.0It is still possible to upload resources with versions before 4.0.0, but if you are configuring access providers in your project, you will have to use faunadb@>=4.0.0 since that's when the AccessProvider and CreateAccessProvider functions were added.
The version of faunadb specified in peerDependencies is >=4.0.0, but if you won't be using access providers you should still be able to install older versions. You'll just have to ignore the "incorrect peer depencency" warnings.
The default environment variable for your FaunaDB admin key used to be FAUNADB_SECRET. This has now changed to FGU_SECRET.
If you have previously used the default environment variable you now need to either:
FAUNADB_SECRET to FGU_SECRET in your environment filesecretEnv property in .fauna.json to FAUNADB_SECRETFAQs
Manage your FaunaDB resources in within your project and upload them using a single command
The npm package fauna-gql-upload receives a total of 151 weekly downloads. As such, fauna-gql-upload popularity was classified as not popular.
We found that fauna-gql-upload demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.