gg-mysql-connector 1.0.12 → 1.0.14

package/README.md

@@ -1,4 +1,4 @@
-# gg-mysql-connector
+# GG-Mysql-Connector
 
 **`gg-mysql-connector`** is an intuitive MySQL model creator designed to simplify database management and operations by synchronizing TypeScript models with MySQL tables. This package allows you to declare and manage your MySQL database structure programmatically, with strong type enforcement.
 
@@ -95,19 +95,19 @@ const db = new GGMySQLConnector<app_INF>({
 await db.init()
 
 // Select operations
-let result_1 = await db.select("item")
-let result_2 = await db.selectByID("user", 2)
-let result_3 = await db.selectByMatchParams("item", { id: 5 })
-let result_4 = await db.selectByMatchParams("item", { name: "pen", price: 3 })
+const result_1 = await db.select("item")
+const result_2 = await db.selectByID("user", 2)
+const result_3 = await db.selectByMatchParams("item", { id: 5 })
+const result_4 = await db.selectByMatchParams("item", { name: "pen", price: 3 })
 
 // Update operations
-let result_5 = await db.update("user", { id: 3, name: "Tony" })
-let result_6 = await db.update("item", { id: 3, price: 4, name: "Ruler" })
-let result_7 = await db.updateOnlyID("item", { oldID: 7, newID: 4 })
+const result_5 = await db.update("user", { id: 3, name: "Tony" })
+const result_6 = await db.update("item", { id: 3, price: 4, name: "Ruler" })
+const result_7 = await db.updateOnlyID("item", { oldID: 7, newID: 4 })
 
 // Delete operations
-let result_8 = await db.deleteByID("item", 5)
-let result_9 = await db.deleteByMatchParams("item", { name: "pen", price: 5 })
+const result_8 = await db.deleteByID("item", 5)
+const result_9 = await db.deleteByMatchParams("item", { name: "pen", price: 5 })
 
 // raw query
 const result_10 = await db.query("SELECT * FROM item where id = ?", [5])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gg-mysql-connector",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/readme2.md

@@ -1,117 +0,0 @@
-# gg-mysql-connector
-
-gg-mysql-connector is an intuitive MySQL model creator designed to simplify database management and operations by synchronizing TypeScript models with MySQL tables. This package allows you to declare and manage your MySQL database structure programmatically while enforcing strong type constraints.
-
-Features
-
-    •	Declare Database Structure: Easily define your database tables and columns as TypeScript variables.
-    •	Sync Database Structure: Automatically synchronize your defined structures with the actual MySQL database.
-    •	Automated View Management: Automatically create or update SQL views based on your declarations.
-    •	Generate TypeScript Models: Generate interfaces that mirror your MySQL structure, ensuring type-safe operations.
-    •	Type-Safe MySQL Connector: Provides a type-enforced MySQL connector with basic functions such as:
-    •	Performing CRUD operations (Select, Update, Delete)
-
-## Installation
-
-```bash
-npm install gg-mysql-connector
-```
-
-## 1. Declare your model
-
-```typescript
-import { MyModel } from "../myModel"
-
-const model: MyModel[] = [
-  {
-    tableName: "user",
-    columns: [
-      {
-        COLUMN_NAME: "id",
-        DATA_TYPE: "int",
-        AUTO_INCREMENT: true,
-      },
-      {
-        COLUMN_NAME: "name",
-        DATA_TYPE: "varchar(512)",
-      },
-    ],
-  },
-  {
-    tableName: "item",
-    columns: [
-      {
-        COLUMN_NAME: "id",
-        DATA_TYPE: "int",
-        AUTO_INCREMENT: true,
-      },
-      {
-        COLUMN_NAME: "name",
-        DATA_TYPE: "varchar(512)",
-      },
-      {
-        COLUMN_NAME: "price",
-        DATA_TYPE: "float",
-      },
-      {
-        COLUMN_NAME: "status",
-        DATA_TYPE: "varchar(64)",
-        POSSIBLE_VALUE: ["ACTIVE", "DISABLE"],
-      },
-      {
-        COLUMN_NAME: "description",
-        DATA_TYPE: "varchar(512)",
-      },
-    ],
-  },
-]
-```
-
-## 2. Sync model and views to mysql and generate model interface file
-
-```typescript
-const migrator = new ModelGenerator(
-  {
-    host: "you-host",
-    user: "user",
-    password: "password",
-    database: "test_ggdb_connector",
-  },
-  model
-)
-await migrator.init()
-await migrator.pushModelToDB()
-await migrator.pushViewToDB("./views")
-await migrator.generateModelInterface({
-  appName: "app",
-  model: model,
-  ouputDirectory: ["./"],
-})
-process.exit()
-```
-
-## 3. CRUD with type enforced
-
-```typescript
-// app_INF is an interface that you generated from step 2
-import app_INF from "your-output-directory/app_INF"
-const db = new GGMySQLConnector<app_INF>({
-  host: "you-host",
-  user: "user",
-  password: "password",
-  database: "test_ggdb_connector",
-})
-await db.init()
-
-let result_1 = await db.select("item")
-let result_2 = await db.selectByID("user", 2)
-let result_3 = await db.selectByMatchParams("item", { id: 5 })
-let result_4 = await db.selectByMatchParams("item", { name: "pen", price: 3 })
-
-let result_5 = await db.update("user", { id: 3, name: "tony" })
-let result_6 = await db.update("item", { id: 3, price: 4, name: "ruler" })
-let result_7 = await db.updateOnlyID("item", { oldID: 7, newID: 4 })
-
-let result_8 = await db.deleteByID("item", 5)
-let result_9 = await db.deleteByMatchParams("item", { name: "pen", price: 5 })
-```