-
Notifications
You must be signed in to change notification settings - Fork 434
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
neon_local: improved docs and fix wrong connstr (#6954)
The user created with the `--create-test-user` flag is `test` instead of `user`. ref #6848 Signed-off-by: Alex Chi Z <chi@neon.tech>
- Loading branch information
Showing
3 changed files
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Control Plane and Neon Local | ||
|
||
This crate contains tools to start a Neon development environment locally. This utility can be used with the `cargo neon` command. | ||
|
||
## 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 3 of the start-up commands. | ||
|
||
```shell | ||
cargo neon init --pg-version 16 | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ea0d35f
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2549 tests run: 2416 passed, 0 failed, 133 skipped (full report)
Flaky tests (5)
Postgres 16
test_crafted_wal_end[last_wal_record_crossing_segment]
: debugtest_vm_bit_clear_on_heap_lock
: debugPostgres 15
test_delete_timeline_client_hangup
: debugPostgres 14
test_ts_of_lsn_api
: debugtest_neon_superuser
: debugCode coverage* (full report)
functions
:28.8% (6932 of 24085 functions)
lines
:47.4% (42555 of 89855 lines)
* collected from Rust tests only
ea0d35f at 2024-03-01T20:47:14.378Z :recycle: