upload - Uploading projects

Note

Project uploads are powered by sqlc Cloud. Sign up for free today.

Added in v1.22.0

Uploading an archive of your project ensures that future releases of sqlc do not break your code. Similar to Rust’s crater project, uploaded archives are tested against development releases of sqlc to verify correctness.

Add configuration

After creating a project, add the project ID to your sqlc configuration file.

version: "2"
cloud:
  project: "<PROJECT_ID>"

You’ll also need to create an auth token and make it available via the SQLC_AUTH_TOKEN environment variable.

export SQLC_AUTH_TOKEN=sqlc_xxxxxxxx

Dry run

You can see what’s included when uploading your project by using using the --dry-run flag:

sqlc upload --dry-run

The output is the request sqlc would have sent without the --dry-run flag.

Upload

Once you’re ready to upload, remove the --dry-run flag.

sqlc upload

By uploading your project, you’re making sqlc more stable and reliable. Thanks!