@stacksjs/database 0.70.256 → 0.70.258

package/dist/vschema.js

@@ -0,0 +1,121 @@
+export function foreignKeyForModel(modelName) {
+  return `${modelName.replace(/([a-z0-9])([A-Z])/g, "$1_$2").replace(/([A-Z]+)([A-Z][a-z])/g, "$1_$2").toLowerCase()}_id`;
+}
+export function decideSharding(model, tableByModel) {
+  const declared = model.sharding;
+  if (declared?.unsharded)
+    return {
+      table: model.table,
+      column: null,
+      vindex: null,
+      reason: "reference table"
+    };
+  if (declared?.column)
+    return {
+      table: model.table,
+      column: declared.column,
+      vindex: declared.vindex ?? "hash",
+      reason: "explicit"
+    };
+  const parentModel = model.belongsTo[0];
+  if (parentModel) {
+    const parentTable = tableByModel.get(parentModel);
+    return {
+      table: model.table,
+      column: foreignKeyForModel(parentModel),
+      vindex: declared?.vindex ?? "hash",
+      reason: "co-located with parent",
+      parent: parentTable ?? parentModel,
+      warning: model.belongsTo.length > 1 ? `belongs to ${model.belongsTo.length} parents; sharded by ${parentModel} only, so joins through ${model.belongsTo.slice(1).join(", ")} will scatter` : void 0
+    };
+  }
+  return {
+    table: model.table,
+    column: "id",
+    vindex: declared?.vindex ?? "hash",
+    reason: "root entity"
+  };
+}
+export function deriveVSchema(models) {
+  const tableByModel = new Map(models.map((m) => [m.name, m.table])), decisions = models.map((model) => decideSharding(model, tableByModel)), vindexes = {}, tables = {};
+  for (const [index, decision] of decisions.entries()) {
+    const model = models[index];
+    if (decision.reason === "reference table") {
+      tables[decision.table] = { type: "reference" };
+      continue;
+    }
+    const vindexType = decision.vindex ?? "hash";
+    vindexes[vindexType] = { type: vindexType };
+    const table = {
+      column_vindexes: [{ column: decision.column, name: vindexType }]
+    };
+    if (!model.useUuid)
+      table.auto_increment = {
+        column: "id",
+        sequence: model.sharding?.sequence ?? `${model.table}_seq`
+      };
+    tables[decision.table] = table;
+  }
+  return {
+    vschema: { sharded: !0, vindexes, tables },
+    decisions
+  };
+}
+export function toShardableModel(definition, table) {
+  const raw = definition?.belongsTo;
+  let belongsTo = [];
+  if (typeof raw === "string")
+    belongsTo = [raw];
+  else if (Array.isArray(raw))
+    belongsTo = raw.map((entry) => typeof entry === "string" ? entry : entry?.model).filter(Boolean);
+  else if (raw && typeof raw === "object")
+    belongsTo = Object.keys(raw);
+  return {
+    name: definition?.name ?? table,
+    table,
+    belongsTo,
+    useUuid: Boolean(definition?.traits?.useUuid),
+    sharding: definition?.traits?.sharding
+  };
+}
+export function formatShardingReport(decisions) {
+  const lines = [], byReason = {
+    explicit: decisions.filter((d) => d.reason === "explicit"),
+    "co-located with parent": decisions.filter((d) => d.reason === "co-located with parent"),
+    "root entity": decisions.filter((d) => d.reason === "root entity"),
+    "reference table": decisions.filter((d) => d.reason === "reference table")
+  };
+  if (byReason["root entity"].length) {
+    lines.push("Root entities (sharded by their own id):");
+    for (const d of byReason["root entity"])
+      lines.push(`  ${d.table}  ->  ${d.column} (${d.vindex})`);
+    lines.push("");
+  }
+  if (byReason["co-located with parent"].length) {
+    lines.push("Co-located with a parent (joins to that parent stay on one shard):");
+    for (const d of byReason["co-located with parent"])
+      lines.push(`  ${d.table}  ->  ${d.column} (${d.vindex}), with ${d.parent}`);
+    lines.push("");
+  }
+  if (byReason.explicit.length) {
+    lines.push("Explicitly declared:");
+    for (const d of byReason.explicit)
+      lines.push(`  ${d.table}  ->  ${d.column} (${d.vindex})`);
+    lines.push("");
+  }
+  if (byReason["reference table"].length) {
+    lines.push("Reference tables (copied to every shard):");
+    for (const d of byReason["reference table"])
+      lines.push(`  ${d.table}`);
+    lines.push("");
+  }
+  const warnings = decisions.filter((d) => d.warning);
+  if (warnings.length) {
+    lines.push("Warnings:");
+    for (const d of warnings)
+      lines.push(`  ${d.table}: ${d.warning}`);
+    lines.push("");
+  }
+  return lines.join(`
+`);
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/database",
   "type": "module",
   "sideEffects": false,
-  "version": "0.70.256",
+  "version": "0.70.258",
   "description": "The Stacks database integration.",
   "author": "Chris Breuer",
   "contributors": [
@@ -54,19 +54,19 @@
   },
   "dependencies": {
     "@stacksjs/ts-validation": "^0.5.0",
-    "bun-query-builder": "^0.2.4",
+    "bun-query-builder": "^0.2.6",
     "dynamodb-tooling": "^0.3.2"
   },
   "devDependencies": {
-    "@stacksjs/cli": "0.70.256",
-    "@stacksjs/config": "0.70.256",
-    "@stacksjs/logging": "0.70.256",
-    "@stacksjs/router": "0.70.256",
+    "@stacksjs/cli": "0.70.258",
+    "@stacksjs/config": "0.70.258",
+    "@stacksjs/logging": "0.70.258",
+    "@stacksjs/router": "0.70.258",
     "better-dx": "^0.2.17",
-    "@stacksjs/path": "0.70.256",
-    "@stacksjs/query-builder": "0.70.256",
-    "@stacksjs/storage": "0.70.256",
-    "@stacksjs/strings": "0.70.256",
-    "@stacksjs/utils": "0.70.256"
+    "@stacksjs/path": "0.70.258",
+    "@stacksjs/query-builder": "0.70.258",
+    "@stacksjs/storage": "0.70.258",
+    "@stacksjs/strings": "0.70.258",
+    "@stacksjs/utils": "0.70.258"
   }
 }

package/dist/drivers/defaults/passwords.d.ts

@@ -1,4 +0,0 @@
-// SQLite/MySQL version
-export declare function createPasswordResetsTable(): Promise<void>;
-// PostgreSQL version
-export declare function createPostgresPasswordResetsTable(): Promise<void>;

package/dist/drivers/defaults/passwords.js

@@ -1,106 +0,0 @@
-import { log } from "@stacksjs/logging";
-function italic(str) {
-  return `\x1B[3m${str}\x1B[23m`;
-}
-import { path } from "@stacksjs/path";
-import { hasMigrationBeenCreated } from "../helpers";
-export async function createPasswordResetsTable() {
-  if (await hasMigrationBeenCreated("password_resets"))
-    return;
-  let migrationContent = `import type { Database } from '@stacksjs/database'
-`;
-  migrationContent += `import { sql } from '@stacksjs/database'
-
-`;
-  migrationContent += `export async function up(db: Database<any>) {
-`;
-  migrationContent += `  await db.schema
-`;
-  migrationContent += `    .createTable('password_resets')
-`;
-  migrationContent += `    .addColumn('email', 'varchar(255)', col => col.notNull())
-`;
-  migrationContent += `    .addColumn('token', 'varchar(255)', col => col.notNull())
-`;
-  migrationContent += `    .addColumn('created_at', 'timestamp', col => col.notNull().defaultTo(sql.raw('CURRENT_TIMESTAMP')))
-`;
-  migrationContent += `    .execute()
-
-`;
-  migrationContent += `  await db.schema
-`;
-  migrationContent += `    .createIndex('password_resets_email_index')
-`;
-  migrationContent += `    .on('password_resets')
-`;
-  migrationContent += `    .column('email')
-`;
-  migrationContent += `    .execute()
-
-`;
-  migrationContent += `  await db.schema
-`;
-  migrationContent += `    .createIndex('password_resets_token_index')
-`;
-  migrationContent += `    .on('password_resets')
-`;
-  migrationContent += `    .column('token')
-`;
-  migrationContent += `    .execute()
-`;
-  migrationContent += `}
-`;
-  const migrationFileName = `${new Date().getTime().toString()}-create-password-resets-table.ts`, migrationFilePath = path.userMigrationsPath(migrationFileName);
-  await Bun.write(migrationFilePath, migrationContent);
-  log.success(`Created migration: ${italic(migrationFileName)}`);
-}
-export async function createPostgresPasswordResetsTable() {
-  if (await hasMigrationBeenCreated("password_resets"))
-    return;
-  let migrationContent = `import type { Database } from '@stacksjs/database'
-`;
-  migrationContent += `import { sql } from '@stacksjs/database'
-
-`;
-  migrationContent += `export async function up(db: Database<any>) {
-`;
-  migrationContent += `  await db.schema
-`;
-  migrationContent += `    .createTable('password_resets')
-`;
-  migrationContent += `    .addColumn('email', 'varchar(255)', col => col.notNull())
-`;
-  migrationContent += `    .addColumn('token', 'varchar(255)', col => col.notNull())
-`;
-  migrationContent += `    .addColumn('created_at', 'timestamp', col => col.notNull().defaultTo(sql.raw('CURRENT_TIMESTAMP')))
-`;
-  migrationContent += `    .execute()
-
-`;
-  migrationContent += `  await db.schema
-`;
-  migrationContent += `    .createIndex('password_resets_email_index')
-`;
-  migrationContent += `    .on('password_resets')
-`;
-  migrationContent += `    .column('email')
-`;
-  migrationContent += `    .execute()
-
-`;
-  migrationContent += `  await db.schema
-`;
-  migrationContent += `    .createIndex('password_resets_token_index')
-`;
-  migrationContent += `    .on('password_resets')
-`;
-  migrationContent += `    .column('token')
-`;
-  migrationContent += `    .execute()
-`;
-  migrationContent += `}
-`;
-  const migrationFileName = `${new Date().getTime().toString()}-create-password-resets-table.ts`, migrationFilePath = path.userMigrationsPath(migrationFileName);
-  await Bun.write(migrationFilePath, migrationContent);
-  log.success(`Created migration: ${italic(migrationFileName)}`);
-}