# dwm数据仓库sql脚本管理系统

**Repository Path**: cmmnhm/dwm

## Basic Information

- **Project Name**: dwm数据仓库sql脚本管理系统
- **Description**: 数据仓库sql脚本管理
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-29
- **Last Updated**: 2025-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DW SQL Script Management Tool

## Project Introduction
This is a fully functional SQL script management tool primarily designed for Doris data warehouse developers. The system provides core capabilities including SQL script editing, version control, execution engine, and connection management. It supports asynchronous execution, execution monitoring, result storage, and error handling.

## Technical Architecture
- **Frontend**: React + TypeScript + Vite  
- **Backend**: Node.js + TypeScript  
- **Database**: PostgreSQL + Redis  
- **Others**: Supports Docker container deployment and provides Kubernetes deployment configurations  

## Core Features  

### SQL Editor  
- Syntax highlighting  
- Auto-completion  
- Code validation  
- Code snippet management  

### Script Management  
- Folder structure management  
- Script creation, editing, and deletion  
- Batch operations  
- Permission management  

### Version Control  
- Version history tracking  
- Version comparison  
- Version rollback  
- Version message management  

### Execution Engine  
- Asynchronous execution  
- Task queue management  
- Execution status tracking  
- Result storage  
- Error handling  
- Execution cancellation and timeout control  

### Connection Management  
- Doris database connection  
- Connection testing  
- Connection configuration management  

## Quick Start  

### Environment Requirements  
1. Node.js 18+  
2. PostgreSQL 14+  
3. Redis 6.0+  
4. Docker (optional)  

### Startup Steps  
```bash
# 1. Install dependencies
npm install

# 2. Initialize the database
npm run db:init

# 3. Start the development server
npm run dev

# 4. Build the production version
npm run build

# 5. Start the service
npm start
```

## API Documentation  
- **Execution Management API**: Provides functionalities for submitting, canceling, and querying execution status  
- **Queue Management API**: Supports viewing queue status and managing queue tasks  
- **Monitoring API**: Provides health checks and runtime monitoring functionalities  

## Development Tools  
- TypeScript type checking  
- Jest unit testing  
- ESLint code linting  
- Prettier code formatting  
- Vite development server  

## Deployment  
- Provides Docker Compose configuration files  
- Supports Kubernetes deployment  
- Includes Helm Chart configuration  
- Supports rolling updates and auto-scaling  

## Monitoring and Maintenance  
- Prometheus monitoring configuration  
- Log collection configuration  
- Health check endpoints  
- Database backup and recovery scripts  

## Contribution Guide  
1. Fork the project  
2. Create a new branch  
3. Submit code changes  
4. Run tests  
5. Submit a Pull Request  

## License  
This project is licensed under the MIT License. Please refer to the LICENSE file for details.