rust/neon

mirror of https://github.com/neondatabase/neon.git synced 2026-01-07 05:22:56 +00:00

Files

Kirill Bulatov fca25edae8 Fix 1.66 Clippy warnings (#3178 )

1.66 release speeds up compile times for over 10% according to tests.

Also its Clippy finds plenty of old nits in our code:
* useless conversion, `foo as u8` where `foo: u8` and similar, removed
`as u8` and similar
* useless references and dereferenced (that were automatically adjusted
by the compiler), removed various `&` and `*`
* bool -> u8 conversion via `if/else`, changed to `u8::from`
* Map `.iter()` calls where only values were used, changed to
`.values()` instead

Standing out lints:
* `Eq` is missing in our protoc generated structs. Silenced, does not
seem crucial for us.
* `fn default` looks like the one from `Default` trait, so I've
implemented that instead and replaced the `dummy_*` method in tests with
`::default()` invocation
* Clippy detected that
```
if retry_attempt < u32::MAX {
    retry_attempt += 1;
}
```
is a saturating add and proposed to replace it.

2022-12-22 14:27:48 +02:00

src

Fix 1.66 Clippy warnings (#3178 )

2022-12-22 14:27:48 +02:00

tests

[compute_ctl] Use postgres::config to properly escape database names (#2652 )

2022-10-19 19:20:06 +02:00

.dockerignore

Move compute_tools from console repo (zenithdb/console#383 )

2021-12-28 20:17:29 +03:00

.gitignore

Move compute_tools from console repo (zenithdb/console#383 )

2021-12-28 20:17:29 +03:00

Cargo.toml

Update rust-postgres everywhere

2022-12-17 00:26:10 +03:00

README.md

Rename 'zenith_admin' role to 'cloud_admin'

2022-05-30 11:11:01 +03:00

rustfmt.toml

Move compute_tools from console repo (zenithdb/console#383 )

2021-12-28 20:17:29 +03:00

README.md

Compute node tools

Postgres wrapper (compute_ctl) is intended to be run as a Docker entrypoint or as a systemd ExecStart option. It will handle all the Neon specifics during compute node initialization:

compute_ctl accepts cluster (compute node) specification as a JSON file.
Every start is a fresh start, so the data directory is removed and initialized again on each run.
Next it will put configuration files into the PGDATA directory.
Sync safekeepers and get commit LSN.
Get basebackup from pageserver using the returned on the previous step LSN.
Try to start postgres and wait until it is ready to accept connections.
Check and alter/drop/create roles and databases.
Hang waiting on the postmaster process to exit.

Also compute_ctl spawns two separate service threads:

compute-monitor checks the last Postgres activity timestamp and saves it into the shared ComputeNode;
http-endpoint runs a Hyper HTTP API server, which serves readiness and the last activity requests.

Usage example:

compute_ctl -D /var/db/postgres/compute \
            -C 'postgresql://cloud_admin@localhost/postgres' \
            -S /var/db/postgres/specs/current.json \
            -b /usr/local/bin/postgres

Tests

Cargo formatter:

cargo fmt

Run tests:

cargo test

Clippy linter:

cargo clippy --all --all-targets -- -Dwarnings -Drust-2018-idioms

Cross-platform compilation

Imaging that you are on macOS (x86) and you want a Linux GNU (x86_64-unknown-linux-gnu platform in rust terminology) executable.

Using docker

You can use a throw-away Docker container (rustlang/rust image) for doing that:

docker run --rm \
    -v $(pwd):/compute_tools \
    -w /compute_tools \
    -t rustlang/rust:nightly cargo build --release --target=x86_64-unknown-linux-gnu

or one-line:

docker run --rm -v $(pwd):/compute_tools -w /compute_tools -t rust:latest cargo build --release --target=x86_64-unknown-linux-gnu

Using rust native cross-compilation

Another way is to add x86_64-unknown-linux-gnu target on your host system:

rustup target add x86_64-unknown-linux-gnu

Install macOS cross-compiler toolchain:

brew tap SergioBenitez/osxct
brew install x86_64-unknown-linux-gnu

And finally run cargo build:

CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER=x86_64-unknown-linux-gnu-gcc cargo build --target=x86_64-unknown-linux-gnu --release