Create first DB query (#100)

Create our first SQL query, code-generate go types, and add instructions for future queries.

Also renamed some of the tables so that the generated types made more sense in the code.

README.md

@@ -95,4 +95,12 @@ Create a new migration by running:
   dev/gen-migration
   ```
 
-If you are unfamiliar with migrations, you may follow [this guide](https://github.com/golang-migrate/migrate/blob/master/MIGRATIONS.md). The database is PostgreSQL and the driver is PGX.
+Fill in the migrations in the generated files. If you are unfamiliar with migrations, you may follow [this guide](https://github.com/golang-migrate/migrate/blob/master/MIGRATIONS.md). The database is PostgreSQL and the driver is PGX.
+
+## Modifying database queries
+
+We use [sqlc](https://docs.sqlc.dev/en/latest/index.html) to generate the code for our DB queries. Modify the `queries.sql` file, and then run:
+
+  ```sh
+  sqlc generate
+  ```

dev/docker/env

@@ -2,5 +2,5 @@
 set -e
 
 function docker_compose() {
-  docker-compose -f dev/docker/docker-compose.yml -p xmtpd "$@"
+  docker compose -f dev/docker/docker-compose.yml -p xmtpd "$@"
 }

dev/up

@@ -7,6 +7,7 @@ if ! which migrate &>/dev/null; then brew install golang-migrate; fi
 if ! which golangci-lint &>/dev/null; then brew install golangci-lint; fi
 if ! which shellcheck &>/dev/null; then brew install shellcheck; fi
 if ! which mockery &>/dev/null; then brew install mockery; fi
+if ! which sqlc &> /dev/null; then brew install sqlc; fi
 
 dev/generate
 dev/docker/up

pkg/db/queries.sql

@@ -0,0 +1,5 @@
+-- name: InsertStagedOriginatorEnvelope :one
+INSERT INTO staged_originator_envelopes(payer_envelope)
+	VALUES (@payer_envelope)
+RETURNING
+	*;

pkg/migrations/00001_init-schema.down.sql

@@ -1,4 +1,4 @@
 DROP TABLE node_info;
-DROP TABLE all_envelopes;
-DROP TABLE staged_originated_envelopes;
+DROP TABLE gateway_envelopes;
+DROP TABLE staged_originator_envelopes;
 DROP TABLE address_log;

pkg/migrations/00001_init-schema.up.sql

@@ -8,17 +8,18 @@ CREATE TABLE node_info(
 	CONSTRAINT is_singleton CHECK (singleton_id = 1)
 );
 
-CREATE TABLE all_envelopes(
+-- Includes all envelopes, whether they were originated locally or not
+CREATE TABLE gateway_envelopes(
 	-- used to construct gateway_sid
 	id BIGSERIAL PRIMARY KEY,
 	originator_sid BIGINT NOT NULL,
 	topic BYTEA NOT NULL,
 	originator_envelope BYTEA NOT NULL
 );
 -- Client queries
-CREATE INDEX idx_all_envelopes_topic ON all_envelopes(topic);
+CREATE INDEX idx_gateway_envelopes_topic ON gateway_envelopes(topic);
 -- Node queries
-CREATE UNIQUE INDEX idx_all_envelopes_originator_sid ON all_envelopes(originator_sid);
+CREATE UNIQUE INDEX idx_gateway_envelopes_originator_sid ON gateway_envelopes(originator_sid);
 
 
 -- Process for originating envelopes:
@@ -30,10 +31,10 @@ CREATE UNIQUE INDEX idx_all_envelopes_originator_sid ON all_envelopes(originator
 --     2.2. Atomically insert into all_envelopes and delete from originated_envelopes,
 --	        ignoring unique index violations on originator_sid
 -- This preserves total ordering, while avoiding gaps in sequence ID's.
-CREATE TABLE staged_originated_envelopes(
+CREATE TABLE staged_originator_envelopes(
 	-- used to construct originator_sid
 	id BIGSERIAL PRIMARY KEY,
-	originator_ns TIMESTAMP NOT NULL DEFAULT now(),
+	originator_time TIMESTAMP NOT NULL DEFAULT now(),
 	payer_envelope BYTEA NOT NULL
 );
 

sqlc.yaml

@@ -0,0 +1,9 @@
+version: "2"
+sql:
+  - engine: "postgresql"
+    queries: "pkg/db/queries.sql"
+    schema: "pkg/migrations"
+    gen:
+      go:
+        package: "queries"
+        out: "pkg/db/queries"