mirror of
https://github.com/neondatabase/neon.git
synced 2025-12-22 21:59:59 +00:00
791b5d736b
## Problem As reported in #10441 the `control_plane/README/md` incorrectly specified that `--pg-version` should be specified in the `cargo neon init` command. This is not the case and causes an invalid argument error. ## Summary of changes Fix the README ## Test Plan I verified that the steps in the README now work locally. I connected to the started postgres endpoint and executed some basic metadata queries.
31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
# Local Development Control Plane (`neon_local`)
|
|
|
|
This crate contains tools to start a Neon development environment locally. This utility can be used with the `cargo neon` command. This is a convenience to invoke
|
|
the `neon_local` binary.
|
|
|
|
**Note**: this is a dev/test tool -- a minimal control plane suitable for testing
|
|
code changes locally, but not suitable for running production systems.
|
|
|
|
## Example: Start with Postgres 16
|
|
|
|
To create and start a local development environment with Postgres 16, you will need to provide `--pg-version` flag to 2 of the start-up commands.
|
|
|
|
```shell
|
|
cargo neon init
|
|
cargo neon start
|
|
cargo neon tenant create --set-default --pg-version 16
|
|
cargo neon endpoint create main --pg-version 16
|
|
cargo neon endpoint start main
|
|
```
|
|
|
|
## Example: Create Test User and Database
|
|
|
|
By default, `cargo neon` starts an endpoint with `cloud_admin` and `postgres` database. If you want to have a role and a database similar to what we have on the cloud service, you can do it with the following commands when starting an endpoint.
|
|
|
|
```shell
|
|
cargo neon endpoint create main --pg-version 16 --update-catalog true
|
|
cargo neon endpoint start main --create-test-user true
|
|
```
|
|
|
|
The first command creates `neon_superuser` and necessary roles. The second command creates `test` user and `neondb` database. You will see a connection string that connects you to the test user after running the second command.
|