SchemaForge結構定義轉換器

五種結構定義格式 · 任何方向 · 不上傳

一份結構定義,五種格式,在瀏覽器裡直接轉換

資料的形狀只需要寫一次。SchemaForge 讀取 SQL DDL、TypeScript 型別、Zod 物件、Pydantic v2 模型與 JSON Schema,整理成同一個中性模型,再從這個模型寫出其餘四種。打字時就同步轉換。可選欄位與可為 null、預設值、VARCHAR 長度、數值範圍、CHECK enum、文件註解都不會被壓平消失。沒有帳號、沒有上傳、沒有伺服器呼叫:解析器與產生器都是這個分頁裡的 JavaScript。

格式 SQL · TS · Zod · Pydantic · JSON Schema方向 二十種組合網路 工具發出 0 個請求

結構定義轉換器

轉換結果

    

    不會上傳任何內容。每次按鍵都重新轉換,診斷清單顯示中性模型裝不下的東西。

    功能

    轉換工具做的事

    六件事,全部不需要伺服器。

    ANY→ANY

    五種格式,每個方向

    左邊選來源格式,右邊選目的格式。五種都能讀也能寫,所以任何組合都成立,包括 SQL 轉 Zod、Pydantic 轉 TypeScript。

    MODEL

    中間是真正的模型

    每個欄位都成為名稱、型別、是否可為 null、是否可省略,加上預設值、長度、數值範圍、樣式、enum 值與註解。輸出是從這個模型產生,而不是改寫原文。

    OPTIONAL

    可選與可為 null 分開處理

    有 DEFAULT 的欄位可以省略但不能為 null;可為 null 的欄位可以是 null 但一定要有。各格式用各自的寫法:? 與 | null、.optional() 與 .nullable()、Optional[...] 與 = None。

    CASE

    輸出時轉換鍵名寫法

    保留原樣,或把所有欄位一次改成 snake_case、camelCase 或 PascalCase。在目標語言不能用的名稱會修正成可用的形式,並告知做了什麼。

    CONSTRAINTS

    長度、範圍、enum 都留著

    VARCHAR(120) 會變成 .max(120)、max_length=120、maxLength: 120。CHECK (status IN (...)) 會變成 Zod enum、TypeScript 字面值聯合型別、Pydantic Literal 與 JSON Schema enum。

    DIAGNOSTICS

    錯誤附上行與欄

    語法錯誤會指出停在哪一行、哪一欄。中性模型裝不下的東西——外鍵、特殊的 CHECK 運算式——不會悄悄消失,而是列在警告清單裡。

    使用方式

    四個步驟,免設定

    轉換器只有一頁,每次按鍵都會重新轉換。

    01

    選擇來源格式

    SQL、TypeScript、Zod、Pydantic 或 JSON Schema。載入範例就能看到該格式的寫法。

    02

    貼上結構定義

    貼上資料表、介面、z.object 或模型。輸入時即轉換,內容不會送出。

    03

    決定目的格式與選項

    選擇輸出格式、鍵名寫法,以及有預設值或可為 null 的欄位是否算可選。

    04

    複製或下載

    結果是可複製的文字,也能用格式對應的副檔名下載:.ts、.py、.sql、.json。

    支援範圍

    各格式讀什麼、寫什麼

    一個模型,五種方言。做到哪裡寫在備註裡。

    格式讀取輸出備註
    SQL DDLCREATE TABLE、欄位型別、NOT NULL、NULL、DEFAULT、PRIMARY KEY、UNIQUE、CHECK (col IN (...))、REFERENCES、-- 與 /* */ 註解每個模型一個 CREATE TABLE,VARCHAR(n)、NUMERIC、BOOLEAN、TIMESTAMP、DATE、UUID、JSON 欄位,enum 用 CHECK IN偏向 PostgreSQL 的通用語法。資料表名稱是模型名稱的複數 snake_case。
    TypeScriptexport interface 與 type X = { … }、? 可選、| null、字串字面值聯合、T[] 與 Array<T>、行內巢狀物件、// 與 /** */ 註解每個模型一個 export interface 加 JSDoc 註解、基本型別、陣列、字面值聯合、巢狀物件型別型別描述的是 JSON 內容,所以 timestamp 是 string、integer 是 number。
    Zodz.object 與 .optional()、.nullable()、.default()、.min()、.max()、.int()、.regex()、.email()、.describe()、z.enum、z.array、z.literalz.object 串接,以及每個模型匯出的 z.infer 型別別名使用 Zod v3 的方法名稱。開啟嚴格選項時會加上 .strict()。
    Pydantic v2class X(BaseModel): 與型別標註、Optional[...]、| None、Literal[...]、list[...]、dict[...]、帶 max_length、ge、le、pattern 的 Field(...)BaseModel 類別、Field(...) 限制、Literal 聯合,嚴格時 model_config = ConfigDict(extra="forbid")使用 Pydantic v2 寫法(ConfigDict),不產生 v1 的 class Config。
    JSON SchemaDraft 2020-12 物件:properties、required、type、enum、const、format、min/max、minLength/maxLength、pattern、items、$defs、本地 $ref一份 Draft 2020-12 文件,其餘模型放在 $defs,第一個模型是進入點嚴格選項時 additionalProperties: false,可為 null 的純量用型別陣列表示。

    格式表達不了的東西會被回報,而不是猜測:外鍵、特殊的 CHECK 運算式、寫進 SQL 資料表的巢狀物件,都會出現在輸出旁的診斷清單。

    運作方式

    解析、建模、產生

    每種來源都整理成同一個小模型,每種輸出都從那個模型寫出。

    SQL · TS · Zod · Pydantic · JSON Schema→解析→中性模型→產生→其餘四種
    欄位 名稱、型別、必填、可為 null、預設值型別 string, int, number, bool, date-time, uuid, enum, array, object限制 maxLength, minLength, minimum, maximum, pattern輸出 JSDoc、docstring、SQL 註解、description

    解析器是每種格式一支、手寫的小型讀取器。SQL 讀取器沿著 CREATE TABLE 的語句走,取第一個選項關鍵字之前的型別,接著不分順序讀取 NOT NULL、DEFAULT、PRIMARY KEY、UNIQUE 與 CHECK (col IN (...))。TypeScript 讀取器切出介面或型別別名的成對大括號內容,在最上層的分號處切開欄位。Zod 與 Pydantic 讀取器分別跟著方法串接與縮排走,JSON Schema 讀取器則是先解析 JSON,再走訪 properties、$defs 與 $ref。

    五條路都停在同一個模型上:一份模型清單,每個模型有一份欄位清單。欄位有名稱、型別節點,以及三個彼此獨立的標記——必填、可為 null、可省略——再加上預設值、註解,以及來源表達過的限制。把必填、可為 null、可省略分開,正是從 SQL(NOT NULL、DEFAULT NULL)走到 TypeScript(name?: string | null)再走回來時,可選性仍然存在的原因。

    產生正好相反。名稱依鍵名選項轉換,預設值變成初始值或被省略,enum 變成目標格式的語法,註解變成目標支援的文件形式——TypeScript 與 Zod 是 JSDoc、Pydantic 是 docstring、SQL 是 -- 開頭的行、JSON Schema 是 description。

    問題

    常見問題

    結構定義會被送到伺服器嗎?

    不會。解析與產生都是這個頁面的 JavaScript:工具裡沒有 fetch、沒有 XHR、沒有 beacon,可以在瀏覽器的網路面板確認。只有頁面開頭的廣告指令碼是從外部載入。最後的結構定義與選項會存在這個瀏覽器的 localStorage,重新整理也不會消失;清除網站資料就會一起刪除。

    為什麼可選和可為 null 不同?

    它們回答不同的問題。可為 null 問的是值能不能是 null,可選問的是欄位本身能不能不存在。有 DEFAULT 的 SQL 欄位通常可以省略但不能為 null,而 API 內容可能有一直存在卻可以是 null 的鍵。把兩者分開,才會產出正確的 name?: string | null、z.string().nullable().optional()、Optional[str] = None。如果專案把兩者視為同一件事,兩個選項可以把它們合併。

    模型裝不下的東西會怎樣?

    會被回報。FOREIGN KEY、不明的 CHECK 運算式、不支援的型別,都會連同欄位名稱列在診斷清單,沒有東西被默默丟掉。外鍵是最清楚的例子:資料表關聯不是值的形狀,所以 SchemaForge 不會替它編造參照型別。

    enum 怎麼處理?

    SQL 沒有可攜的 enum,所以把 CHECK (col IN ('a','b')) 讀成 enum,也以同樣方式寫回。中間會變成 Zod 的 z.enum、TypeScript 的字串字面值聯合、Pydantic 的 Literal[...] 與 JSON Schema 的 enum。沒有 CHECK 的 VARCHAR 就只是字串。

    來回轉換會完全一致嗎?

    支援範圍表列出的元素會一致:從產生的程式碼再建一次模型,結果與原本相同。之外就不會。廠商專屬型別、資料表選項、索引、以文字描述的條件、Pydantic 驗證器都不在模型裡,所以不會回來。請把輸出當起點,提交前與原本比對。

    用的是哪種 SQL 方言?

    偏向 PostgreSQL 的通用語法:VARCHAR(n)、NUMERIC(p,s)、BOOLEAN、TIMESTAMP、DATE、UUID、JSON 欄位、引號識別字,以及以分號分隔的多個語句。它讀不了所有廠商擴充,也不會寫出其他資料庫會默默拒絕的方言專屬子句。

    誠實的極限

    這個工具不做的事

    不是完整的 SQL 解析器

    只讀 CREATE TABLE。ALTER TABLE、檢視表、索引、序列、生成欄位與方言專屬型別都不讀,含有這些的檔案請先只留下需要的 CREATE TABLE 語句。

    不建立關聯模型

    外鍵以警告回報,不會變成參照,因為其餘四種格式都不描述資料庫關聯。複合鍵會讀取,但只有主鍵標記會留下。

    型別對應是慣例

    timestamp 在 TypeScript 是 string、在 Pydantic 是 datetime、在 JSON Schema 是 format: date-time;資料列中的巢狀物件在 SQL 會變成 JSON 欄位。這些是合理的預設,但你的專案可能想要別的做法。

    產生的程式碼需要檢視

    資料表名稱依英文複數規則產生,欄位順序依來源,輸出以便於閱讀的方式排版。請依專案慣例確認名稱,再對結果跑一次型別檢查或 lint。

    輸出遵循的標準

    • JSON Schema — Draft 2020-12、$defs 與 $ref
    • Pydantic — version 2(ConfigDict、Field、Literal)
    • Zod — version 3(z.object、z.enum、z.infer)
    • 隱私 — 不上傳、免帳號、無分析;內容只留在 localStorage