@syntropix/database 0.0.6 → 0.1.1

package/README.md

@@ -1,31 +1,31 @@
 # DB TypeScript SDK
 
-一个类似于 Python ORM 的 TypeScript SDK，用于数据库操作。
+A TypeScript SDK for database operations, similar to a Python ORM.
 
-## 安装
+## Installation
 
 ```bash
 yarn add reflect-metadata
 ```
 
-## 功能特性
+## Features
 
-- 🎯 **装饰器支持** - 使用 TypeScript 装饰器定义模型
-- 🔑 **自动主键** - 如果未定义主键，自动创建 `id` 字段
-- 🔗 **外键关系** - 支持外键定义和关系
-- 📝 **完整的 CRUD** - 提供 create, read, update, delete 操作
-- 🔍 **高级查询** - 支持过滤、排序、聚合、连接等
-- 🚀 **批量操作** - 支持批量创建和更新
-- 🎨 **类型安全** - 完整的 TypeScript 类型支持
+- 🎯 **Decorator Support** - Define models using TypeScript decorators
+- 🔑 **Automatic Primary Keys** - `id` field is automatically created if not defined
+- 🔗 **Foreign Key Relations** - Supports defining and handling foreign key relations
+- 📝 **Full CRUD** - Create, read, update, and delete operations
+- 🔍 **Advanced Queries** - Filtering, sorting, aggregation, joins, etc.
+- 🚀 **Batch Operations** - Bulk create and update support
+- 🎨 **Type Safety** - Full TypeScript types, type-safe models
 
-## 快速开始
+## Quick Start
 
-### 1. 定义模型
+### 1. Define Models
 
 ```typescript
 import { BaseModel, Column } from 'db-ts-sdk';
 
-// 基础审计模型
+// Audited base model
 export class Audited extends BaseModel {
   @Column({ type: 'date', name: 'created_at' })
   createdAt!: Date;
@@ -34,7 +34,7 @@ export class Audited extends BaseModel {
   updatedAt!: Date;
 }
 
-// 用户模型
+// User model
 export class User extends Audited {
   static tableName = 'users';
 
@@ -55,28 +55,28 @@ export class User extends Audited {
 }
 ```
 
-### 2. 表操作
+### 2. Table Operations
 
 ```typescript
-// 创建表
+// Create table
 await User.createTable();
 
-// 删除表
+// Drop table
 await User.dropTable();
 
-// 重命名表
+// Rename table
 await User.renameTable('new_users');
 
-// 清空表
+// Truncate table
 await User.truncateTable();
 ```
 
-### 3. 数据操作
+### 3. Data Operations
 
-#### 创建数据
+#### Create Data
 
 ```typescript
-// 单条创建
+// Single insert
 const user = await User.create({
   id: '1',
   email: 'user@example.com',
@@ -86,7 +86,7 @@ const user = await User.create({
   updatedAt: new Date(),
 });
 
-// 批量创建
+// Bulk insert
 await User.bulkCreate(
   [
     {
@@ -106,19 +106,19 @@ await User.bulkCreate(
       updatedAt: new Date(),
     },
   ],
-  32,
-); // 批次大小
+  32, // Batch size
+);
 ```
 
-#### 查询数据
+#### Query Data
 
 ```typescript
 import { AND, EQ, OR, GTE } from 'db-ts-sdk';
 
-// 获取单个记录
+// Get a single record
 const user = await User.get(OR(AND(EQ('email', 'user@example.com'))));
 
-// 过滤查询
+// Filter query
 const activeUsers = await User.filter({
   filter: OR(AND(EQ('is_active', true))),
   limit: 10,
@@ -126,38 +126,38 @@ const activeUsers = await User.filter({
   sort: { column: 'created_at', order: 'DESC' },
 });
 
-// 统计数量
+// Count records
 const count = await User.count({
   filter: OR(AND(EQ('is_active', true))),
 });
 ```
 
-#### 更新数据
+#### Update Data
 
 ```typescript
-// 实例更新
+// Instance update
 const user = await User.get(OR(AND(EQ('id', '1'))));
 user.fullName = 'Jane Doe';
 await user.save();
 
-// 批量更新
+// Bulk update
 await User.update(OR(AND(EQ('is_active', false))), { isActive: true });
 ```
 
-#### 删除数据
+#### Delete Data
 
 ```typescript
-// 实例删除
+// Instance delete
 const user = await User.get(OR(AND(EQ('id', '1'))));
 await user.remove();
 
-// 批量删除
+// Bulk delete
 await User.delete(OR(AND(EQ('is_active', false))));
 ```
 
-## 字段类型
+## Field Types
 
-SDK 支持多种字段类型：
+The SDK supports various field types:
 
 ```typescript
 import {
@@ -180,22 +180,22 @@ import {
 } from 'db-ts-sdk';
 ```
 
-### 使用装饰器
+### Using Decorators
 
 ```typescript
 @Column({
-  type: 'string',           // 字段类型
-  name: 'column_name',      // 数据库列名（可选）
-  description: 'desc',      // 描述（可选）
-  primary: false,           // 是否主键（可选）
-  nullable: false,          // 是否可为空（可选）
-  auto_increment: false,     // 是否自增（可选）
-  default: null             // 默认值（可选）
+  type: 'string',           // Field type
+  name: 'column_name',      // Database column name (optional)
+  description: 'desc',      // Description (optional)
+  primary: false,           // Is primary key (optional)
+  nullable: false,          // Nullable (optional)
+  auto_increment: false,    // Auto increment (optional)
+  default: null             // Default value (optional)
 })
 fieldName!: string;
 ```
 
-### 外键字段
+### Foreign Key Fields
 
 ```typescript
 import { ForeignKey } from 'db-ts-sdk';
@@ -208,42 +208,42 @@ import { ForeignKey } from 'db-ts-sdk';
 userId!: number;
 ```
 
-## 过滤器构建
+## Filter Builder
 
 ```typescript
 import { AND, OR, EQ, NE, GT, GTE, LT, LTE, IN, LIKE } from 'db-ts-sdk';
 
-// 等于
+// Equals
 EQ('field', value);
 
-// 不等于
+// Not equals
 NE('field', value);
 
-// 大于
+// Greater than
 GT('field', value);
 
-// 大于等于
+// Greater than or equal
 GTE('field', value);
 
-// 小于
+// Less than
 LT('field', value);
 
-// 小于等于
+// Less than or equal
 LTE('field', value);
 
-// 包含
+// In array
 IN('field', [value1, value2]);
 
-// 模糊匹配
+// Pattern matching (LIKE)
 LIKE('field', '%pattern%');
 
-// 组合条件
+// Combine conditions
 OR(AND(EQ('status', 'active'), GTE('age', 18)), AND(EQ('status', 'pending')));
 ```
 
-## 高级查询
+## Advanced Queries
 
-### 聚合查询
+### Aggregate Query
 
 ```typescript
 import { AggregateFunction } from 'db-ts-sdk';
@@ -261,7 +261,7 @@ const results = await User.filter({
 });
 ```
 
-### 连接查询
+### Join Query
 
 ```typescript
 const results = await User.filter({
@@ -274,9 +274,9 @@ const results = await User.filter({
 });
 ```
 
-## 配置
+## Configuration
 
-在 `tsconfig.json` 中确保启用装饰器支持：
+In your `tsconfig.json`, make sure to enable decorator support:
 
 ```json
 {
@@ -287,34 +287,34 @@ const results = await User.filter({
 }
 ```
 
-在应用入口导入 reflect-metadata：
+And at the entrypoint of your app, import reflect-metadata:
 
 ```typescript
 import 'reflect-metadata';
 ```
 
-## API 参考
+## API Reference
 
-### BaseModel 静态方法
+### BaseModel Static Methods
 
-- `createTable()` - 创建表
-- `dropTable()` - 删除表
-- `renameTable(newName)` - 重命名表
-- `truncateTable()` - 清空表
-- `create(data)` - 创建记录
-- `bulkCreate(datas, batchSize)` - 批量创建
-- `get(filter, select?)` - 获取单个记录
-- `filter(options)` - 过滤查询
-- `update(filter, data)` - 批量更新
-- `delete(filter)` - 批量删除
-- `count(options)` - 统计数量
+- `createTable()` - Create table
+- `dropTable()` - Drop table
+- `renameTable(newName)` - Rename table
+- `truncateTable()` - Truncate table
+- `create(data)` - Create a record
+- `bulkCreate(datas, batchSize)` - Create records in bulk
+- `get(filter, select?)` - Get a single record
+- `filter(options)` - Filter query
+- `update(filter, data)` - Bulk update
+- `delete(filter)` - Bulk delete
+- `count(options)` - Count records
 
-### BaseModel 实例方法
+### BaseModel Instance Methods
 
-- `save()` - 保存实例（创建或更新）
-- `remove(filter?)` - 删除实例
-- `toString()` - 转换为字符串
-- `toJSON()` - 转换为 JSON 对象
+- `save()` - Save instance (create or update)
+- `remove(filter?)` - Remove instance
+- `toString()` - Convert to string
+- `toJSON()` - Convert to JSON object
 
 ## License