Skip to content

Commit

Permalink
docs: Replace form with dashboard link (#2840)
Browse files Browse the repository at this point in the history
  • Loading branch information
kyleconroy authored Oct 12, 2023
1 parent 53d1792 commit f09d96f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
11 changes: 6 additions & 5 deletions docs/howto/managed-databases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Managed databases

```{note}
Managed databases are powered by [sqlc Cloud](https://dashboard.sqlc.dev). Sign up for [free](https://dashboard.sqlc.dev) today.
```

*Added in v1.22.0*

`sqlc` can create and maintain hosted databases for your project. These
Expand All @@ -12,15 +16,12 @@ other use-cases. Beyond linting queries, you can use sqlc managed databases
in your tests to quickly stand up a database per test suite or even per test,
providing a real, isolated database for a test run. No cleanup required.

Interested in trying out managed databases? Sign up [here](https://docs.google.com/forms/d/e/1FAIpQLSdxoMzJ7rKkBpuez-KyBcPNyckYV-5iMR--FRB7WnhvAmEvKg/viewform) or send us an email
at [hello@sqlc.dev](mailto:hello@sqlc.dev).

## Configuring managed databases

To configure `sqlc` to use a managed database, remove the `uri` key from your
`database` configuration and replace it with the `managed` key set to `true`.
Set the `project` key in your `cloud` configuration to the value of your
project ID, obtained via the sqlc.dev Dashboard.
project ID, obtained via the [dashboard](https://dashboard.sqlc.dev).

```yaml
version: '2'
Expand All @@ -37,7 +38,7 @@ sql:
## Authentication
`sqlc` expects to find a valid auth token in the value of the `SQLC_AUTH_TOKEN`
environment variable. You can create an auth token via the sqlc.dev Dashboard.
environment variable. You can create an auth token via the [dashboard](https://dashboard.sqlc.dev).

```shell
export SQLC_AUTH_TOKEN=sqlc_xxxxxxxx
Expand Down
9 changes: 5 additions & 4 deletions docs/howto/upload.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Uploading projects

```{note}
Project uploads are powered by [sqlc Cloud](https://dashboard.sqlc.dev). Sign up for [free](https://dashboard.sqlc.dev) 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](https://github.com/rust-lang/crater)
project, uploaded archives are tested against development releases of sqlc to
verify correctness.

Interested in uploading projects? Sign up [here](https://docs.google.com/forms/d/e/1FAIpQLSdxoMzJ7rKkBpuez-KyBcPNyckYV-5iMR--FRB7WnhvAmEvKg/viewform) or send us an email
at [hello@sqlc.dev](mailto:hello@sqlc.dev).

## Add configuration

After creating a project, add the project ID to your sqlc configuration file.
Expand Down Expand Up @@ -46,4 +47,4 @@ 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!
By uploading your project, you're making sqlc more stable and reliable. Thanks!
5 changes: 2 additions & 3 deletions docs/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ When you turn on managed databases, `sqlc` will use your schema to create a
template database that it can copy to make future runs of `sqlc vet` very
performant.

This feature relies on configuration obtained via sqlc Cloud. If you're interested
in early access you can [sign up here](https://docs.google.com/forms/d/e/1FAIpQLSdxoMzJ7rKkBpuez-KyBcPNyckYV-5iMR--FRB7WnhvAmEvKg/viewform)
or send us an email at [hello@sqlc.dev](mailto:hello@sqlc.dev).
This feature relies on configuration obtained via [sqlc
Cloud](https://dashboard.sqlc.dev).

Read more in the [managed databases](../howto/managed-databases.md) documentation.

Expand Down

0 comments on commit f09d96f

Please sign in to comment.