Database migrations toolkit for ENSNode Schema in ENSDb

.changeset/tasty-pigs-shine.md

@@ -0,0 +1,5 @@
+---
+"@ensnode/ensdb-sdk": minor
+---
+
+Introduced toolkit for managing ENSDb migrations for ENSNode Schema.

packages/ensdb-sdk/README.md

@@ -1,3 +1,31 @@
 # ENSDb SDK
 
 This package is a utility library for interacting with ENSDb.
+
+## Database schema definitions
+
+### ENSIndexer Schema
+
+This schema consist of database object definitions exported from `src/ensindexer` module.
+Defining database objects is done by using functionality from `ponder` package.
+
+#### Applying schema definition updates
+
+Updating database object definitions in ENSIndexer Schema _does not_ require any extra steps. ENSIndexer app is built on top of Ponder app. The Ponder app runtime takes care of generating migrations and having them executed during application runtime. In other words, ENSIndexer Schema in ENSDb gets auto-updated when ENSIndexer app starts.
+
+### ENSNode Schema
+
+This schema consist of database object definitions exported from `src/ensnode` module.
+Defining database objects is done by using functionality from `drizzle-orm` package.
+
+#### Applying schema definition updates
+
+Updating database object definitions in ENSNode Schema _does_ require an extra step: generating SQL queries to be executed for ENSNode Schema in ENSDb. 
+
+Generating SQL queries can be done with the following CLI command:
+```
+pnpm -F @ensnode/ensdb-sdk drizzle-kit:generate
+```
+
+This command will update files inside the `migrations` directory, including SQL files.
+The `migrations` directory can be later reference by application runtime (i.e. ENSIndexer app) in order to execute pending SQL migrations for ENSNode Schema in ENSDb.

packages/ensdb-sdk/drizzle.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "drizzle-kit";
+
+const ensNodeSchemaPath = "./src/ensnode/index.ts";
+
+export default defineConfig({
+  casing: "snake_case",
+  dialect: "postgresql",
+  out: "migrations",
+  schema: ensNodeSchemaPath,
+});

packages/ensdb-sdk/migrations/0000_cultured_captain_cross.sql

@@ -0,0 +1,8 @@
+CREATE SCHEMA IF NOT EXISTS ensnode;
+
+CREATE TABLE "ensnode"."metadata" (
+	"ens_indexer_schema_name" text NOT NULL,
+	"key" text NOT NULL,
+	"value" jsonb NOT NULL,
+	CONSTRAINT "metadata_pkey" PRIMARY KEY("ens_indexer_schema_name","key")
+);

packages/ensdb-sdk/migrations/meta/0000_snapshot.json

@@ -0,0 +1,55 @@
+{
+  "id": "d661dcae-f64d-4ecd-a4da-3d5783e17e2c",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "ensnode.metadata": {
+      "name": "metadata",
+      "schema": "ensnode",
+      "columns": {
+        "ens_indexer_schema_name": {
+          "name": "ens_indexer_schema_name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "key": {
+          "name": "key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "value": {
+          "name": "value",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {
+        "metadata_pkey": {
+          "name": "metadata_pkey",
+          "columns": ["ens_indexer_schema_name", "key"]
+        }
+      },
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

packages/ensdb-sdk/migrations/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1773743108514,
+      "tag": "0000_cultured_captain_cross",
+      "breakpoints": true
+    }
+  ]
+}

packages/ensdb-sdk/package.json

@@ -52,7 +52,8 @@
   "scripts": {
     "prepublish": "tsup",
     "lint": "biome check --write .",
-    "lint:ci": "biome ci"
+    "lint:ci": "biome ci",
+    "drizzle-kit:generate": "drizzle-kit generate"
   },
   "peerDependencies": {
     "drizzle-orm": "catalog:",
@@ -62,6 +63,7 @@
   "devDependencies": {
     "@ensnode/ensnode-sdk": "workspace:",
     "@ensnode/shared-configs": "workspace:*",
+    "drizzle-kit": "0.31.10",
     "drizzle-orm": "catalog:",
     "ponder": "catalog:",
     "tsup": "catalog:",