Skip to content

docs: Add migration guide for hosted managed databases #3417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kyleconroy merged 1 commit into from
Jun 5, 2024
Merged

docs: Add migration guide for hosted managed databases #3417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: Add migration guide for hosted managed databases
  • Loading branch information
@kyleconroy
kyleconroy committed Jun 5, 2024
commit 0a6d33e66081c3769bacaeac3c9e4f131f47d88e
3 changes: 0 additions & 3 deletions docs/_templates/breadcrumbs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

{% block breadcrumbs %}
{% if show_banner %}
<header id="banner">
<div>Join the wait list for <a href="https://bm2gstcnhch.typeform.com/to/fV96Dsyf">BigQuery</a>, <a href="https://bm2gstcnhch.typeform.com/to/fV96Dsyf">ClickHouse</a>, <a href="https://bm2gstcnhch.typeform.com/to/fV96Dsyf">MSSQL</a>, or <a href="https://bm2gstcnhch.typeform.com/to/fV96Dsyf">Spanner</a> today.</div>
</header>
{% endif %}
{{ super() }}
{% endblock %}
71 changes: 71 additions & 0 deletions docs/guides/migrating-off-hosted-managed-databases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Migrating off hosted managed databases

Starting in sqlc 1.27.0, [managed databases](../docs/managed-databases.md) will require a database server URI in the configuration file.

This guide walks you through migrating to a locally running database server.

## Run a database server locally

There are many options for running a database server locally, but this guide
will use [Docker Compose](https://docs.docker.com/compose/), as it can support
both MySQL and PostgreSQL.

If you're using macOS and PostgreSQL, [Postgres.app](https://postgresapp.com/) is also a good option.

For MySQL, create a `docker-compose.yml` file with the following contents:

```yaml
version: "3.8"
services:
mysql:
image: "mysql/mysql-server:8.0"
ports:
- "3306:3306"
restart: always
environment:
MYSQL_DATABASE: dinotest
MYSQL_ROOT_PASSWORD: mysecretpassword
MYSQL_ROOT_HOST: '%'
```

For PostgreSQL, create a `docker-compose.yml` file with the following contents:

```yaml
version: "3.8"
services:
postgresql:
image: "postgres:16"
ports:
- "5432:5432"
restart: always
environment:
POSTGRES_DB: postgres
POSTGRES_PASSWORD: mysecretpassword
POSTGRES_USER: postgres
```

```sh
docker compose up -d
```

## Upgrade sqlc

You must be running sqlc v1.27.0 or greater to have access to the `servers`
configuration.

## Add servers to configuration

```diff
version: '2'
cloud:
project: '<PROJECT_ID>'
+ servers:
+ - name: mysql
+ uri: mysql://localhost:3306
+ - name: postgres
+ uri: postgres://localhost:5432/postgres?sslmode=disable
```

## Re-generate the code

Run `sqlc generate`. A database with the `sqlc_managed_` prefix will be automatically created and used for query analysis.