Install & Run
Run the aetheriusd daemon on your machine. By default it exposes three wire
endpoints (native, PostgreSQL pgwire, and Arrow Flight SQL) and stores data in a
local directory.
Supported platforms
Section titled “Supported platforms”| Platform | Tier | Notes |
|---|---|---|
| macOS (Apple Silicon, arm64) | Tier 1 | Development primary |
| Linux x86_64 | Tier 1 | Fastest bulk-ingest path |
| Linux aarch64 | Tier 1 | Fastest bulk-ingest path |
| Windows | — | Use WSL2 |
Option 1 — Build from source
Section titled “Option 1 — Build from source”AetheriusDB is a Rust project; you need a recent Rust toolchain (1.79+).
# Clone the repositorygit clone https://github.com/your-org/aetherius.gitcd aetherius
# Build the daemon and the AetherTerm REPL in release modecargo build --release -p aetheriusd -p aether-term
# Run the daemon (creates ./aetherius-data on first start)./target/release/aetheriusd --data-dir ./aetherius-dataYou should see a banner like:
aetheriusd · listening: pgwire: 127.0.0.1:5678 native: 127.0.0.1:5679 flight: 127.0.0.1:8815 (Arrow Flight SQL)data-dir: ./aetherius-dataOption 2 — Pre-built installer
Section titled “Option 2 — Pre-built installer”If you don’t want to build from source, grab a pre-built tarball from the Download page — the database server and client tools for Linux, macOS, and Windows, with every published version listed.
# Unpack the database-server tarball and start the daemontar -xzf aetheriusdb-<version>-<os>-<arch>.tar.gzcd aetheriusdb-<version>-<os>-<arch>./aetheriusd --data-dir ./aetherius-dataThe Client Tools tarball unpacks aesql and the AetherTerm REPL the same way.
Smoke-test the install
Section titled “Smoke-test the install”From another terminal, use the bundled REPL to confirm everything works:
./target/release/aether-term
aether> CREATE TABLE hello (id BIGINT, msg TEXT);-- OK
aether> INSERT INTO hello VALUES (1, 'world');-- 1 row affected
aether> SELECT * FROM hello; id | msg----+------ 1 | world(1 row)Common start-up flags
Section titled “Common start-up flags”| Flag | Purpose |
|---|---|
--data-dir <PATH> | Where data is stored. Default ./aetherius-data. |
--port <N> | PostgreSQL pgwire port. Default 5678. |
--native-port <N> | Native binary protocol port. Default 5679. |
--flight-port <N> | Arrow Flight SQL port. Default 8815. |
--disable-flight | Don’t start the Flight SQL listener. |
--disable-native | Don’t start the native listener. |
--native-auth-token <TOK> | Require a bearer token on the native protocol. Env: AETHERIUS_NATIVE_AUTH_TOKEN. |
--flight-auth-token <TOK> | Require a bearer token on Flight SQL. Env: AETHERIUS_FLIGHT_AUTH_TOKEN. |
See the configuration matrix for the full list, including the feature flags that turn JIT, parallelism, and HTAP on.
Backups
Section titled “Backups”Stopping the daemon
Section titled “Stopping the daemon”Send SIGTERM (or press Ctrl-C). In-flight clients are notified, connections
drain gracefully, and the daemon exits within a few seconds.
kill -TERM $(pgrep aetheriusd)