Merge pull request #75 from tablelandnetwork/table-schema

Standardize table schema format

Author: asutula

package-lock.json

@@ -13,7 +13,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@tableland/sdk": "^4.5.1",
+    "@tableland/sdk": "^4.5.2",
     "@tableland/studio-mail": "^0.0.0",
     "@tableland/studio-store": "^1.0.0",
     "@trpc/server": "^10.38.4",

packages/api/package.json

@@ -1,9 +1,20 @@
 import { Validator, helpers } from "@tableland/sdk";
-import { Store } from "@tableland/studio-store";
+import { Schema, Store } from "@tableland/studio-store";
 import { TRPCError } from "@trpc/server";
 import { z } from "zod";
 import { projectProcedure, publicProcedure, router } from "../trpc";
 
+const schemaSchema: z.ZodType<Schema> = z.object({
+  columns: z.array(
+    z.object({
+      name: z.string().nonempty(),
+      type: z.string().nonempty(),
+      constraints: z.array(z.string().nonempty()).optional(),
+    }),
+  ),
+  table_constraints: z.array(z.string().nonempty()).optional(),
+});
+
 export function tablesRouter(store: Store) {
   return router({
     projectTables: publicProcedure
@@ -15,8 +26,8 @@ export function tablesRouter(store: Store) {
       .input(
         z.object({
           name: z.string(),
-          schema: z.string(),
           description: z.string().nonempty(),
+          schema: schemaSchema,
         }),
       )
       .mutation(async ({ input }) => {
@@ -47,12 +58,11 @@ export function tablesRouter(store: Store) {
           tableId: input.tableId,
         });
 
-        // TODO: Figure out a standard way of encoding schema for both Tables created in Studio and imported tables.
         const table = await store.tables.createTable(
           input.projectId,
           input.name,
           input.description,
-          JSON.stringify(tablelandTable.schema),
+          tablelandTable.schema,
         );
         const createdAttr = tablelandTable.attributes?.find(
           (attr) => attr.traitType === "created",

packages/api/src/routers/tables.ts

@@ -44,7 +44,7 @@
   },
   "license": "MIT AND Apache-2.0",
   "dependencies": {
-    "@tableland/sdk": "^4.5.1",
+    "@tableland/sdk": "^4.5.2",
     "@tableland/sqlparser": "^1.3.0",
     "@tableland/studio-client": "^0.0.0",
     "@toruslabs/broadcast-channel": "^8.0.0",

packages/cli/package.json

@@ -13,7 +13,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@tableland/sdk": "^4.5.1",
+    "@tableland/sdk": "^4.5.2",
     "drizzle-orm": "^0.28.5",
     "iron-session": "^6.3.1"
   }

packages/store/package.json

@@ -2,6 +2,7 @@ import { Database } from "@tableland/sdk";
 import { randomUUID } from "crypto";
 import { eq } from "drizzle-orm";
 import { DrizzleD1Database } from "drizzle-orm/d1";
+import { Schema } from "../custom-types";
 import * as schema from "../schema";
 import { Table, projectTables, tables, teamProjects, teams } from "../schema";
 import { slugify } from "./utils";
@@ -15,7 +16,7 @@ export function initTables(
       projectId: string,
       name: string,
       description: string,
-      schema: string,
+      schema: Schema,
     ) {
       const tableId = randomUUID();
       const slug = slugify(name);

packages/store/src/api/tables.ts

@@ -0,0 +1,18 @@
+import { Schema as SDKSchema } from "@tableland/sdk";
+import { customType } from "drizzle-orm/sqlite-core";
+
+export type Schema = SDKSchema;
+
+export const schema = customType<{
+  data: Schema;
+}>({
+  dataType() {
+    return "text";
+  },
+  fromDriver(value: unknown): Schema {
+    return value as Schema;
+  },
+  toDriver(value: Schema): string {
+    return JSON.stringify(value);
+  },
+});

packages/store/src/custom-types/index.ts

@@ -1,6 +1,7 @@
 import { init } from "./api";
+import { Schema } from "./custom-types";
 import * as schema from "./schema";
 
 type Store = ReturnType<typeof init>;
 
-export { Store, init, schema };
+export { Schema, Store, init, schema };

packages/store/src/index.ts

@@ -6,6 +6,7 @@ import {
   text,
   uniqueIndex,
 } from "drizzle-orm/sqlite-core";
+import { schema } from "../custom-types";
 
 export const users = sqliteTable(
   "users",
@@ -80,7 +81,7 @@ export const tables = sqliteTable("tables", {
   slug: text("slug").notNull(),
   name: text("name").notNull(),
   description: text("description").notNull(),
-  schema: text("schema").notNull(),
+  schema: schema("schema").notNull(),
 });
 
 export const projectTables = sqliteTable(

packages/store/src/schema/index.ts

@@ -18,6 +18,7 @@ import {
   SelectTrigger,
   SelectValue,
 } from "@/components/ui/select";
+import { generateCreateTableStatement } from "@/lib/schema";
 import { cn } from "@/lib/utils";
 import {
   Database,
@@ -108,8 +109,9 @@ export default function ExecDeployment({
           baseUrl: helpers.getBaseUrl(chainId),
           autoWait: false,
         });
-        // TODO: Table.schema will be JSON, convert it to SQL create table statement.
-        const res = await tbl.exec(table.schema);
+
+        const stmt = generateCreateTableStatement(table.name, table.schema);
+        const res = await tbl.exec(stmt);
         if (res.error) {
           throw new Error(res.error);
         }