readyset-psql/README.md
This crate contains the PostgreSQL protocol adapter for Noria. The adapter allows legacy applications that use parameterized PostgreSQL queries to start using Noria with no or minimal source code changes.
To run the adapter and listen on the default PostgreSQL port (5432), type:
$ cargo run --release -- --deployment $DEPLOYMENT_ID
DEPLOYMENT is the same deployment ID you used when starting
the Noria server.
If you would like to use a different port (e.g., because you're also running
a PostgreSQL server), pass -a <IP>:<PORT>, making sure to specify the desired
bind ip as well.
The PostgreSQL adapter uses Consul to find the Noria server. To specify the
Consul server location, pass the --authority-address argument:
$ cargo run --release -- --deployment $DEPLOYMENT_ID --authority-address 172.16.0.19:8500
... for a Consul server listening on port 8500 at IP 172.16.0.19.