mirror of
https://gitee.com/johng/gf
synced 2026-06-08 02:27:42 +08:00
Compare commits
12 Commits
feat/cli-g
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| fb89f8bdf8 | |||
| cae8ce3b51 | |||
| 9a91bd203b | |||
| 72733e0bad | |||
| d44e082ff5 | |||
| 078c1bc7f9 | |||
| 94623a19d1 | |||
| cb7cfa58ab | |||
| 1878202625 | |||
| bb71ccfd4c | |||
| f67b2dca26 | |||
| 68b02218d7 |
21
.agents/instructions/markdown-format.instructions.md
Normal file
21
.agents/instructions/markdown-format.instructions.md
Normal file
@ -0,0 +1,21 @@
|
||||
---
|
||||
name: "Standardize markdown document formatting"
|
||||
description: "Standardize the formatting of all markdown documents to keep structure clear, content readable, and the overall quality and user experience consistent. This document explains requirements for heading levels, paragraph formatting, code block usage, list formatting, and image and link insertion so authors can follow a unified style that is easier to read and maintain."
|
||||
applyTo: "*.{md,MD}"
|
||||
---
|
||||
|
||||
# Primary Formatting Requirements
|
||||
|
||||
- Keywords or specialized terms in the document must be formatted with inline code, for example `RuntimeClass`, `containerd`, `GPU`, and `AI`.
|
||||
- In Chinese text, do not add spaces around inline code.
|
||||
- For technical articles, review the generated content before finalizing it to ensure the material is technically accurate and contains no incorrect technical descriptions.
|
||||
- When the generated content is too large, split it into multiple tasks to avoid exceeding model output limits and causing the workflow to fail.
|
||||
|
||||
|
||||
# Detailed Content Requirements
|
||||
|
||||
- When documenting parameters or configuration items for a component or project, prefer tables when practical, and keep tables short enough to avoid horizontal scrolling during normal reading.
|
||||
- In Chinese paragraphs, use full-width punctuation rather than half-width punctuation, for example `,` instead of `,` and `;` instead of `;`.
|
||||
- Use `mermaid` for architecture diagrams, flowcharts, and similar visuals. If you need line breaks inside `mermaid`, use `<br/>` instead of `\n`.
|
||||
- If a code block is not a `mermaid` diagram and instead uses box-drawing characters such as `┌─`, `┐`, `┤`, or `│`, keep the content in English so the layout stays aligned.
|
||||
- Do not use `---` as a separator between paragraphs.
|
||||
152
.agents/prompts/opsx/apply.md
Normal file
152
.agents/prompts/opsx/apply.md
Normal file
@ -0,0 +1,152 @@
|
||||
---
|
||||
name: "OPSX: Apply"
|
||||
description: Implement tasks from an OpenSpec change (Experimental)
|
||||
category: Workflow
|
||||
tags: [workflow, artifacts, experimental]
|
||||
---
|
||||
|
||||
Implement tasks from an OpenSpec change.
|
||||
|
||||
**Input**: Optionally specify a change name (e.g., `/opsx:apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **Select the change**
|
||||
|
||||
If a name is provided, use it. Otherwise:
|
||||
- Infer from conversation context if the user mentioned a change
|
||||
- Auto-select if only one active change exists
|
||||
- If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select
|
||||
|
||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
|
||||
|
||||
2. **Check status to understand the schema**
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
Parse the JSON to understand:
|
||||
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
||||
- Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
|
||||
|
||||
3. **Get apply instructions**
|
||||
|
||||
```bash
|
||||
openspec instructions apply --change "<name>" --json
|
||||
```
|
||||
|
||||
This returns:
|
||||
- Context file paths (varies by schema)
|
||||
- Progress (total, complete, remaining)
|
||||
- Task list with status
|
||||
- Dynamic instruction based on current state
|
||||
|
||||
**Handle states:**
|
||||
- If `state: "blocked"` (missing artifacts): show message, suggest using `/opsx:continue`
|
||||
- If `state: "all_done"`: congratulate, suggest archive
|
||||
- Otherwise: proceed to implementation
|
||||
|
||||
4. **Read context files**
|
||||
|
||||
Read the files listed in `contextFiles` from the apply instructions output.
|
||||
The files depend on the schema being used:
|
||||
- **spec-driven**: proposal, specs, design, tasks
|
||||
- Other schemas: follow the contextFiles from CLI output
|
||||
|
||||
5. **Show current progress**
|
||||
|
||||
Display:
|
||||
- Schema being used
|
||||
- Progress: "N/M tasks complete"
|
||||
- Remaining tasks overview
|
||||
- Dynamic instruction from CLI
|
||||
|
||||
6. **Implement tasks (loop until done or blocked)**
|
||||
|
||||
For each pending task:
|
||||
- Show which task is being worked on
|
||||
- Make the code changes required
|
||||
- Keep changes minimal and focused
|
||||
- Mark task complete in the tasks file: `- [ ]` → `- [x]`
|
||||
- Continue to next task
|
||||
|
||||
**Pause if:**
|
||||
- Task is unclear → ask for clarification
|
||||
- Implementation reveals a design issue → suggest updating artifacts
|
||||
- Error or blocker encountered → report and wait for guidance
|
||||
- User interrupts
|
||||
|
||||
7. **On completion or pause, show status**
|
||||
|
||||
Display:
|
||||
- Tasks completed this session
|
||||
- Overall progress: "N/M tasks complete"
|
||||
- If all done: suggest archive
|
||||
- If paused: explain why and wait for guidance
|
||||
|
||||
**Output During Implementation**
|
||||
|
||||
```
|
||||
## Implementing: <change-name> (schema: <schema-name>)
|
||||
|
||||
Working on task 3/7: <task description>
|
||||
[...implementation happening...]
|
||||
✓ Task complete
|
||||
|
||||
Working on task 4/7: <task description>
|
||||
[...implementation happening...]
|
||||
✓ Task complete
|
||||
```
|
||||
|
||||
**Output On Completion**
|
||||
|
||||
```
|
||||
## Implementation Complete
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Progress:** 7/7 tasks complete ✓
|
||||
|
||||
### Completed This Session
|
||||
- [x] Task 1
|
||||
- [x] Task 2
|
||||
...
|
||||
|
||||
All tasks complete! You can archive this change with `/opsx:archive`.
|
||||
```
|
||||
|
||||
**Output On Pause (Issue Encountered)**
|
||||
|
||||
```
|
||||
## Implementation Paused
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Progress:** 4/7 tasks complete
|
||||
|
||||
### Issue Encountered
|
||||
<description of the issue>
|
||||
|
||||
**Options:**
|
||||
1. <option 1>
|
||||
2. <option 2>
|
||||
3. Other approach
|
||||
|
||||
What would you like to do?
|
||||
```
|
||||
|
||||
**Guardrails**
|
||||
- Keep going through tasks until done or blocked
|
||||
- Always read context files before starting (from the apply instructions output)
|
||||
- If task is ambiguous, pause and ask before implementing
|
||||
- If implementation reveals issues, pause and suggest artifact updates
|
||||
- Keep code changes minimal and scoped to each task
|
||||
- Update task checkbox immediately after completing each task
|
||||
- Pause on errors, blockers, or unclear requirements - don't guess
|
||||
- Use contextFiles from CLI output, don't assume specific file names
|
||||
|
||||
**Fluid Workflow Integration**
|
||||
|
||||
This skill supports the "actions on a change" model:
|
||||
|
||||
- **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
|
||||
- **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly
|
||||
157
.agents/prompts/opsx/archive.md
Normal file
157
.agents/prompts/opsx/archive.md
Normal file
@ -0,0 +1,157 @@
|
||||
---
|
||||
name: "OPSX: Archive"
|
||||
description: Archive a completed change in the experimental workflow
|
||||
category: Workflow
|
||||
tags: [workflow, archive, experimental]
|
||||
---
|
||||
|
||||
Archive a completed change in the experimental workflow.
|
||||
|
||||
**Input**: Optionally specify a change name after `/opsx:archive` (e.g., `/opsx:archive add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **If no change name provided, prompt for selection**
|
||||
|
||||
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
||||
|
||||
Show only active changes (not already archived).
|
||||
Include the schema used for each change if available.
|
||||
|
||||
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
||||
|
||||
2. **Check artifact completion status**
|
||||
|
||||
Run `openspec status --change "<name>" --json` to check artifact completion.
|
||||
|
||||
Parse the JSON to understand:
|
||||
- `schemaName`: The workflow being used
|
||||
- `artifacts`: List of artifacts with their status (`done` or other)
|
||||
|
||||
**If any artifacts are not `done`:**
|
||||
- Display warning listing incomplete artifacts
|
||||
- Prompt user for confirmation to continue
|
||||
- Proceed if user confirms
|
||||
|
||||
3. **Check task completion status**
|
||||
|
||||
Read the tasks file (typically `tasks.md`) to check for incomplete tasks.
|
||||
|
||||
Count tasks marked with `- [ ]` (incomplete) vs `- [x]` (complete).
|
||||
|
||||
**If incomplete tasks found:**
|
||||
- Display warning showing count of incomplete tasks
|
||||
- Prompt user for confirmation to continue
|
||||
- Proceed if user confirms
|
||||
|
||||
**If no tasks file exists:** Proceed without task-related warning.
|
||||
|
||||
4. **Assess delta spec sync state**
|
||||
|
||||
Check for delta specs at `openspec/changes/<name>/specs/`. If none exist, proceed without sync prompt.
|
||||
|
||||
**If delta specs exist:**
|
||||
- Compare each delta spec with its corresponding main spec at `openspec/specs/<capability>/spec.md`
|
||||
- Determine what changes would be applied (adds, modifications, removals, renames)
|
||||
- Show a combined summary before prompting
|
||||
|
||||
**Prompt options:**
|
||||
- If changes needed: "Sync now (recommended)", "Archive without syncing"
|
||||
- If already synced: "Archive now", "Sync anyway", "Cancel"
|
||||
|
||||
If user chooses sync, use Task tool (subagent_type: "general-purpose", prompt: "Use Skill tool to invoke openspec-sync-specs for change '<name>'. Delta spec analysis: <include the analyzed delta spec summary>"). Proceed to archive regardless of choice.
|
||||
|
||||
5. **Perform the archive**
|
||||
|
||||
Create the archive directory if it doesn't exist:
|
||||
```bash
|
||||
mkdir -p openspec/changes/archive
|
||||
```
|
||||
|
||||
Generate target name using current date: `YYYY-MM-DD-<change-name>`
|
||||
|
||||
**Check if target already exists:**
|
||||
- If yes: Fail with error, suggest renaming existing archive or using different date
|
||||
- If no: Move the change directory to archive
|
||||
|
||||
```bash
|
||||
mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name>
|
||||
```
|
||||
|
||||
6. **Display summary**
|
||||
|
||||
Show archive completion summary including:
|
||||
- Change name
|
||||
- Schema that was used
|
||||
- Archive location
|
||||
- Spec sync status (synced / sync skipped / no delta specs)
|
||||
- Note about any warnings (incomplete artifacts/tasks)
|
||||
|
||||
**Output On Success**
|
||||
|
||||
```
|
||||
## Archive Complete
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
||||
**Specs:** ✓ Synced to main specs
|
||||
|
||||
All artifacts complete. All tasks complete.
|
||||
```
|
||||
|
||||
**Output On Success (No Delta Specs)**
|
||||
|
||||
```
|
||||
## Archive Complete
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
||||
**Specs:** No delta specs
|
||||
|
||||
All artifacts complete. All tasks complete.
|
||||
```
|
||||
|
||||
**Output On Success With Warnings**
|
||||
|
||||
```
|
||||
## Archive Complete (with warnings)
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
||||
**Specs:** Sync skipped (user chose to skip)
|
||||
|
||||
**Warnings:**
|
||||
- Archived with 2 incomplete artifacts
|
||||
- Archived with 3 incomplete tasks
|
||||
- Delta spec sync was skipped (user chose to skip)
|
||||
|
||||
Review the archive if this was not intentional.
|
||||
```
|
||||
|
||||
**Output On Error (Archive Exists)**
|
||||
|
||||
```
|
||||
## Archive Failed
|
||||
|
||||
**Change:** <change-name>
|
||||
**Target:** openspec/changes/archive/YYYY-MM-DD-<name>/
|
||||
|
||||
Target archive directory already exists.
|
||||
|
||||
**Options:**
|
||||
1. Rename the existing archive
|
||||
2. Delete the existing archive if it's a duplicate
|
||||
3. Wait until a different date to archive
|
||||
```
|
||||
|
||||
**Guardrails**
|
||||
- Always prompt for change selection if not provided
|
||||
- Use artifact graph (openspec status --json) for completion checking
|
||||
- Don't block archive on warnings - just inform and confirm
|
||||
- Preserve .openspec.yaml when moving to archive (it moves with the directory)
|
||||
- Show clear summary of what happened
|
||||
- If sync is requested, use the Skill tool to invoke `openspec-sync-specs` (agent-driven)
|
||||
- If delta specs exist, always run the sync assessment and show the combined summary before prompting
|
||||
173
.agents/prompts/opsx/explore.md
Normal file
173
.agents/prompts/opsx/explore.md
Normal file
@ -0,0 +1,173 @@
|
||||
---
|
||||
name: "OPSX: Explore"
|
||||
description: "Enter explore mode - think through ideas, investigate problems, clarify requirements"
|
||||
category: Workflow
|
||||
tags: [workflow, explore, experimental, thinking]
|
||||
---
|
||||
|
||||
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
|
||||
|
||||
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, and investigate the codebase, but you must NEVER write code or implement features. If the user asks you to implement something, remind them to exit explore mode first and create a change proposal. You MAY create OpenSpec artifacts (proposals, designs, specs) if the user asks—that's capturing thinking, not implementing.
|
||||
|
||||
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
|
||||
|
||||
**Input**: The argument after `/opsx:explore` is whatever the user wants to think about. Could be:
|
||||
- A vague idea: "real-time collaboration"
|
||||
- A specific problem: "the auth system is getting unwieldy"
|
||||
- A change name: "add-dark-mode" (to explore in context of that change)
|
||||
- A comparison: "postgres vs sqlite for this"
|
||||
- Nothing (just enter explore mode)
|
||||
|
||||
---
|
||||
|
||||
## The Stance
|
||||
|
||||
- **Curious, not prescriptive** - Ask questions that emerge naturally, don't follow a script
|
||||
- **Open threads, not interrogations** - Surface multiple interesting directions and let the user follow what resonates. Don't funnel them through a single path of questions.
|
||||
- **Visual** - Use ASCII diagrams liberally when they'd help clarify thinking
|
||||
- **Adaptive** - Follow interesting threads, pivot when new information emerges
|
||||
- **Patient** - Don't rush to conclusions, let the shape of the problem emerge
|
||||
- **Grounded** - Explore the actual codebase when relevant, don't just theorize
|
||||
|
||||
---
|
||||
|
||||
## What You Might Do
|
||||
|
||||
Depending on what the user brings, you might:
|
||||
|
||||
**Explore the problem space**
|
||||
- Ask clarifying questions that emerge from what they said
|
||||
- Challenge assumptions
|
||||
- Reframe the problem
|
||||
- Find analogies
|
||||
|
||||
**Investigate the codebase**
|
||||
- Map existing architecture relevant to the discussion
|
||||
- Find integration points
|
||||
- Identify patterns already in use
|
||||
- Surface hidden complexity
|
||||
|
||||
**Compare options**
|
||||
- Brainstorm multiple approaches
|
||||
- Build comparison tables
|
||||
- Sketch tradeoffs
|
||||
- Recommend a path (if asked)
|
||||
|
||||
**Visualize**
|
||||
```
|
||||
┌─────────────────────────────────────────┐
|
||||
│ Use ASCII diagrams liberally │
|
||||
├─────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌────────┐ ┌────────┐ │
|
||||
│ │ State │────────▶│ State │ │
|
||||
│ │ A │ │ B │ │
|
||||
│ └────────┘ └────────┘ │
|
||||
│ │
|
||||
│ System diagrams, state machines, │
|
||||
│ data flows, architecture sketches, │
|
||||
│ dependency graphs, comparison tables │
|
||||
│ │
|
||||
└─────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Surface risks and unknowns**
|
||||
- Identify what could go wrong
|
||||
- Find gaps in understanding
|
||||
- Suggest spikes or investigations
|
||||
|
||||
---
|
||||
|
||||
## OpenSpec Awareness
|
||||
|
||||
You have full context of the OpenSpec system. Use it naturally, don't force it.
|
||||
|
||||
### Check for context
|
||||
|
||||
At the start, quickly check what exists:
|
||||
```bash
|
||||
openspec list --json
|
||||
```
|
||||
|
||||
This tells you:
|
||||
- If there are active changes
|
||||
- Their names, schemas, and status
|
||||
- What the user might be working on
|
||||
|
||||
If the user mentioned a specific change name, read its artifacts for context.
|
||||
|
||||
### When no change exists
|
||||
|
||||
Think freely. When insights crystallize, you might offer:
|
||||
|
||||
- "This feels solid enough to start a change. Want me to create a proposal?"
|
||||
- Or keep exploring - no pressure to formalize
|
||||
|
||||
### When a change exists
|
||||
|
||||
If the user mentions a change or you detect one is relevant:
|
||||
|
||||
1. **Read existing artifacts for context**
|
||||
- `openspec/changes/<name>/proposal.md`
|
||||
- `openspec/changes/<name>/design.md`
|
||||
- `openspec/changes/<name>/tasks.md`
|
||||
- etc.
|
||||
|
||||
2. **Reference them naturally in conversation**
|
||||
- "Your design mentions using Redis, but we just realized SQLite fits better..."
|
||||
- "The proposal scopes this to premium users, but we're now thinking everyone..."
|
||||
|
||||
3. **Offer to capture when decisions are made**
|
||||
|
||||
| Insight Type | Where to Capture |
|
||||
|--------------|------------------|
|
||||
| New requirement discovered | `specs/<capability>/spec.md` |
|
||||
| Requirement changed | `specs/<capability>/spec.md` |
|
||||
| Design decision made | `design.md` |
|
||||
| Scope changed | `proposal.md` |
|
||||
| New work identified | `tasks.md` |
|
||||
| Assumption invalidated | Relevant artifact |
|
||||
|
||||
Example offers:
|
||||
- "That's a design decision. Capture it in design.md?"
|
||||
- "This is a new requirement. Add it to specs?"
|
||||
- "This changes scope. Update the proposal?"
|
||||
|
||||
4. **The user decides** - Offer and move on. Don't pressure. Don't auto-capture.
|
||||
|
||||
---
|
||||
|
||||
## What You Don't Have To Do
|
||||
|
||||
- Follow a script
|
||||
- Ask the same questions every time
|
||||
- Produce a specific artifact
|
||||
- Reach a conclusion
|
||||
- Stay on topic if a tangent is valuable
|
||||
- Be brief (this is thinking time)
|
||||
|
||||
---
|
||||
|
||||
## Ending Discovery
|
||||
|
||||
There's no required ending. Discovery might:
|
||||
|
||||
- **Flow into a proposal**: "Ready to start? I can create a change proposal."
|
||||
- **Result in artifact updates**: "Updated design.md with these decisions"
|
||||
- **Just provide clarity**: User has what they need, moves on
|
||||
- **Continue later**: "We can pick this up anytime"
|
||||
|
||||
When things crystallize, you might offer a summary - but it's optional. Sometimes the thinking IS the value.
|
||||
|
||||
---
|
||||
|
||||
## Guardrails
|
||||
|
||||
- **Don't implement** - Never write code or implement features. Creating OpenSpec artifacts is fine, writing application code is not.
|
||||
- **Don't fake understanding** - If something is unclear, dig deeper
|
||||
- **Don't rush** - Discovery is thinking time, not task time
|
||||
- **Don't force structure** - Let patterns emerge naturally
|
||||
- **Don't auto-capture** - Offer to save insights, don't just do it
|
||||
- **Do visualize** - A good diagram is worth many paragraphs
|
||||
- **Do explore the codebase** - Ground discussions in reality
|
||||
- **Do question assumptions** - Including the user's and your own
|
||||
106
.agents/prompts/opsx/propose.md
Normal file
106
.agents/prompts/opsx/propose.md
Normal file
@ -0,0 +1,106 @@
|
||||
---
|
||||
name: "OPSX: Propose"
|
||||
description: Propose a new change - create it and generate all artifacts in one step
|
||||
category: Workflow
|
||||
tags: [workflow, artifacts, experimental]
|
||||
---
|
||||
|
||||
Propose a new change - create the change and generate all artifacts in one step.
|
||||
|
||||
I'll create a change with artifacts:
|
||||
- proposal.md (what & why)
|
||||
- design.md (how)
|
||||
- tasks.md (implementation steps)
|
||||
|
||||
When ready to implement, run /opsx:apply
|
||||
|
||||
---
|
||||
|
||||
**Input**: The argument after `/opsx:propose` is the change name (kebab-case), OR a description of what the user wants to build.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **If no input provided, ask what they want to build**
|
||||
|
||||
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
|
||||
> "What change do you want to work on? Describe what you want to build or fix."
|
||||
|
||||
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
|
||||
|
||||
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
|
||||
|
||||
2. **Create the change directory**
|
||||
```bash
|
||||
openspec new change "<name>"
|
||||
```
|
||||
This creates a scaffolded change at `openspec/changes/<name>/` with `.openspec.yaml`.
|
||||
|
||||
3. **Get the artifact build order**
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
Parse the JSON to get:
|
||||
- `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
|
||||
- `artifacts`: list of all artifacts with their status and dependencies
|
||||
|
||||
4. **Create artifacts in sequence until apply-ready**
|
||||
|
||||
Use the **TodoWrite tool** to track progress through the artifacts.
|
||||
|
||||
Loop through artifacts in dependency order (artifacts with no pending dependencies first):
|
||||
|
||||
a. **For each artifact that is `ready` (dependencies satisfied)**:
|
||||
- Get instructions:
|
||||
```bash
|
||||
openspec instructions <artifact-id> --change "<name>" --json
|
||||
```
|
||||
- The instructions JSON includes:
|
||||
- `context`: Project background (constraints for you - do NOT include in output)
|
||||
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
|
||||
- `template`: The structure to use for your output file
|
||||
- `instruction`: Schema-specific guidance for this artifact type
|
||||
- `outputPath`: Where to write the artifact
|
||||
- `dependencies`: Completed artifacts to read for context
|
||||
- Read any completed dependency files for context
|
||||
- Create the artifact file using `template` as the structure
|
||||
- Apply `context` and `rules` as constraints - but do NOT copy them into the file
|
||||
- Show brief progress: "Created <artifact-id>"
|
||||
|
||||
b. **Continue until all `applyRequires` artifacts are complete**
|
||||
- After creating each artifact, re-run `openspec status --change "<name>" --json`
|
||||
- Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
|
||||
- Stop when all `applyRequires` artifacts are done
|
||||
|
||||
c. **If an artifact requires user input** (unclear context):
|
||||
- Use **AskUserQuestion tool** to clarify
|
||||
- Then continue with creation
|
||||
|
||||
5. **Show final status**
|
||||
```bash
|
||||
openspec status --change "<name>"
|
||||
```
|
||||
|
||||
**Output**
|
||||
|
||||
After completing all artifacts, summarize:
|
||||
- Change name and location
|
||||
- List of artifacts created with brief descriptions
|
||||
- What's ready: "All artifacts created! Ready for implementation."
|
||||
- Prompt: "Run `/opsx:apply` to start implementing."
|
||||
|
||||
**Artifact Creation Guidelines**
|
||||
|
||||
- Follow the `instruction` field from `openspec instructions` for each artifact type
|
||||
- The schema defines what each artifact should contain - follow it
|
||||
- Read dependency artifacts for context before creating new ones
|
||||
- Use `template` as the structure for your output file - fill in its sections
|
||||
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
|
||||
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
|
||||
- These guide what you write, but should never appear in the output
|
||||
|
||||
**Guardrails**
|
||||
- Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
|
||||
- Always read dependency artifacts before creating a new one
|
||||
- If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
|
||||
- If a change with that name already exists, ask if user wants to continue it or create a new one
|
||||
- Verify each artifact file exists after writing before proceeding to next
|
||||
280
.agents/skills/gf-feedback/SKILL.md
Normal file
280
.agents/skills/gf-feedback/SKILL.md
Normal file
@ -0,0 +1,280 @@
|
||||
---
|
||||
name: gf-feedback
|
||||
description: >-
|
||||
Track, fix, verify, and test any bugs, improvements, or gaps reported against an OpenSpec change.
|
||||
MUST use this skill whenever user reports problems, defects, issues, bugs, or gaps related to
|
||||
existing implementations, even if they don't explicitly say "feedback" or mention OpenSpec.
|
||||
compatibility: Requires openspec CLI, Go toolchain, and gf-review skill.
|
||||
---
|
||||
|
||||
# Feedback: Structured Fix, Verification & Test Coverage Loop
|
||||
|
||||
When users discover bugs or improvement points after implementation, this skill captures those issues, organizes them into a traceable task list in `tasks.md`, systematically fixes and verifies each one, and ensures every behavior-changing fix is covered by focused unit tests.
|
||||
|
||||
**Core principles:**
|
||||
1. **Spec is the source of truth** — Spec-level changes require spec update before task recording
|
||||
2. **Write it down first, then fix it** — Every issue gets recorded before any code change
|
||||
3. **Every fix deserves a test** — Behavior-changing code changes require unit test coverage in the affected package
|
||||
|
||||
---
|
||||
|
||||
## Workflow
|
||||
|
||||
### 1. Identify Target Change
|
||||
|
||||
**CRITICAL:**
|
||||
1. Always append to existing active changes. Only create new change when none exist.
|
||||
2. An **active change** is any change directory that still exists directly under `openspec/changes/` and has **not** been moved into `openspec/changes/archive/`. Do **not** treat `status: complete`, all tasks checked off, or similar completion signals as "inactive" until archive actually happens.
|
||||
3. Regardless of whether the feedback content is related to the main functionality of the current active iteration, it MUST be appended to the current active iteration. This ensures all changes are tracked in a single change record for unified management and archiving.
|
||||
|
||||
```bash
|
||||
openspec list --json
|
||||
# Or: ls openspec/changes/ | grep -v archive
|
||||
```
|
||||
|
||||
When the two signals disagree, prefer the filesystem rule:
|
||||
|
||||
- If a change directory still exists under `openspec/changes/` and is not inside `archive/`, it is active.
|
||||
- `openspec list --json` may still report such a change as `status: complete`; that only means implementation tasks are done, **not** that the change is inactive.
|
||||
- Only archived changes under `openspec/changes/archive/` are inactive.
|
||||
|
||||
| Active Changes | Action |
|
||||
|----------------|--------|
|
||||
| None | Create new change (see below) |
|
||||
| One | Auto-select it, announce and proceed |
|
||||
| Multiple | Ask user to select from list |
|
||||
|
||||
**When multiple active changes exist:**
|
||||
```
|
||||
Multiple active changes detected. Which change should this feedback be appended to?
|
||||
|
||||
1. config-management — System config CRUD management
|
||||
2. user-auth — User authentication enhancement
|
||||
|
||||
Please select 1 or 2:
|
||||
```
|
||||
|
||||
**When no active change exists:**
|
||||
1. Derive kebab-case name from feedback (e.g., "fix-menu-circular-ref")
|
||||
2. If name exists, append suffix ("-2")
|
||||
3. Create: `openspec new change "<name>"`
|
||||
4. Generate minimal `proposal.md` (one paragraph summarizing context)
|
||||
5. Skip `design.md` for pure bug fixes unless architectural changes needed
|
||||
|
||||
Announce: "Applying feedback fixes to change: **<name>**"
|
||||
|
||||
---
|
||||
|
||||
### 2. Read Current Context
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `tasks.md` | Task structure, naming conventions, numbering |
|
||||
| `design.md` | Architectural context |
|
||||
| `proposal.md` | Feature scope and intent |
|
||||
| `specs/` | Delta spec definitions |
|
||||
|
||||
```bash
|
||||
# Locate existing unit tests in the impacted package before adding a new one
|
||||
rg --files <pkg-dir> | rg '_test\\.go$'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3. Analyze and Organize Issues
|
||||
|
||||
For each reported issue:
|
||||
|
||||
**Classify by type:**
|
||||
- **bug** — Incorrect behavior, code doesn't match spec
|
||||
- **missing** — Feature incomplete, gaps in implementation
|
||||
- **ux** — UX improvement, no spec change needed
|
||||
- **test-gap** — Missing test coverage only
|
||||
|
||||
**Classify by spec impact:**
|
||||
|
||||
| Level | Definition | Action |
|
||||
|-------|------------|--------|
|
||||
| **implementation** | Spec is correct, code is wrong | Fix code only |
|
||||
| **spec-level** | Requirement missing/incomplete/changed | Update spec first, then fix |
|
||||
| **internal** | No user-observable change | Fix code, test optional |
|
||||
|
||||
**Group related issues** — Same root cause → single task with multiple verification points.
|
||||
|
||||
---
|
||||
|
||||
### 4. Update Delta Specs (for Spec-Level Issues Only)
|
||||
|
||||
For spec-level issues, update specs **before** recording tasks:
|
||||
|
||||
1. Identify affected capability: `specs/<capability>/spec.md`
|
||||
2. Apply delta operation:
|
||||
|
||||
```markdown
|
||||
<!-- ADDED: New requirement -->
|
||||
### Requirement: Parent Selector Circular Prevention
|
||||
The system SHALL disable the current menu and all its descendants in the parent selector
|
||||
to prevent circular references.
|
||||
|
||||
#### Scenario: Edit menu with children
|
||||
WHEN user edits a menu that has child menus
|
||||
THEN the parent selector SHALL disable the current menu and all descendant menus
|
||||
|
||||
<!-- MODIFIED: Changed requirement (include full original block) -->
|
||||
### Requirement: Import Error Handling
|
||||
The system SHALL display error messages when import fails.
|
||||
**MODIFIED:** Error messages SHALL include row number, field name, and validation failure reason.
|
||||
|
||||
<!-- REMOVED: Deprecated requirement -->
|
||||
### Requirement: Legacy Import Format
|
||||
The system SHALL support legacy CSV format.
|
||||
**REMOVED:** This format is no longer supported.
|
||||
**Migration:** Use the new CSV format with header row.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 5. Write Task List to tasks.md
|
||||
|
||||
Append a **Feedback section** to `tasks.md`:
|
||||
|
||||
```markdown
|
||||
## Feedback
|
||||
|
||||
- [ ] **FB-1**: Parent selector allows circular references in menu edit
|
||||
- [ ] **FB-2**: Import error messages lack row and field details
|
||||
- [ ] **FB-3**: No test coverage for reset password feature
|
||||
```
|
||||
|
||||
**Numbering:** Sequential `FB-1`, `FB-2`, etc. Continue from last number if section exists.
|
||||
|
||||
**One line per task** — No sub-fields. Analysis happens during fix phase.
|
||||
|
||||
**Confirm with user** before writing to file.
|
||||
|
||||
**Test coverage planning (internal):**
|
||||
- Behavior-changing code change → Unit test required
|
||||
- Internal-only optimization → Unit test optional unless logic risk increased
|
||||
- Prefer extending the nearest `*_z_unit*_test.go` or `*_test.go` in the same package
|
||||
|
||||
---
|
||||
|
||||
### 6. Execute Fixes (Loop)
|
||||
|
||||
For each task:
|
||||
|
||||
**a. Announce:** `## Fixing FB-X: <issue title>`
|
||||
|
||||
**b. Investigate** — Read source files, confirm root cause
|
||||
|
||||
**c. Implement** — Minimal, focused fix following existing patterns
|
||||
|
||||
**d. Write/update unit tests** — Prefer the affected package's existing `*_z_unit*_test.go` or `*_test.go` files and keep assertions focused on the changed logic
|
||||
|
||||
**e. Assess Impact Scope (MANDATORY)**
|
||||
|
||||
After implementing, identify regression risk:
|
||||
|
||||
| Change Type | Map To Tests |
|
||||
|-------------|--------------|
|
||||
| Package-level logic | Targeted test for changed function/method + package regression tests |
|
||||
| Shared utility | Utility package unit tests + highest-value dependent package tests already covering reuse |
|
||||
| DB/DAO logic | DAO/model package unit tests with focused fixtures, mocks, or test helpers |
|
||||
| Public API validation | Handler/service package unit tests that assert the changed validation path |
|
||||
| Refactor without behavior change | Existing package tests that prove behavior parity |
|
||||
|
||||
```bash
|
||||
# Example: Find unit tests related to a changed symbol or package
|
||||
rg -l "GenDao|gdao" . -g '*_test.go'
|
||||
```
|
||||
|
||||
Announce:
|
||||
```
|
||||
### Impact Analysis for FB-X
|
||||
- Modified: cmd/gf/internal/cmd/gendao/gendao.go
|
||||
- Affected package: cmd/gf/internal/cmd/gendao
|
||||
- Unit tests: cmd/gf/internal/cmd/gendao/gendao_test.go
|
||||
- Regression command: go test ./cmd/gf/internal/cmd/gendao -run 'TestGenDao'
|
||||
```
|
||||
|
||||
**f. Verify (MANDATORY before marking complete)**
|
||||
|
||||
1. Run new/updated unit tests for this task → **must pass**
|
||||
2. Run ALL identified package-level regression tests → **must pass**
|
||||
3. Only then: mark task `[x]` in tasks.md
|
||||
|
||||
If regression fails:
|
||||
- Fix inline if related to current change
|
||||
- Add as new FB task if separate issue
|
||||
|
||||
**g. Run review** — Invoke `gf-review` skill after completion
|
||||
|
||||
---
|
||||
|
||||
### 7. Comprehensive Verification
|
||||
|
||||
After all fixes:
|
||||
|
||||
1. Aggregate regression tests from all tasks
|
||||
2. Run full set in single pass
|
||||
3. Report:
|
||||
```
|
||||
### Comprehensive Verification Results
|
||||
- Total tests: N
|
||||
- Passed: N
|
||||
- Failed: N (list with details)
|
||||
- Regression tests: all passed ✓ / X failures
|
||||
```
|
||||
|
||||
If failures → add new FB tasks, loop to Step 6.
|
||||
|
||||
---
|
||||
|
||||
### 8. Report Completion
|
||||
|
||||
```markdown
|
||||
## Feedback Complete
|
||||
|
||||
**Change:** <name>
|
||||
**Issues reported:** X
|
||||
**Issues fixed:** Y/X
|
||||
**Tests added:** Z unit tests / focused assertions
|
||||
**Regression tests run:** R tests across N packages
|
||||
**Verification:** all passed / N issues remaining
|
||||
|
||||
### Fixed This Session
|
||||
- [x] FB-1: <title> ✓ (unit test: TestGenDao_FiltersInvalidTables | package: ./cmd/gf/internal/cmd/gendao ✓)
|
||||
- [x] FB-2: <title> ✓ (unit test: existing package coverage extended | package: ./cmd/gf/internal/cmd ✓)
|
||||
|
||||
### Remaining (if any)
|
||||
- [ ] FB-3: <title> — blocked by <reason>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Edge Cases
|
||||
|
||||
| Situation | Handling |
|
||||
|-----------|----------|
|
||||
| Single issue | Still follow full workflow |
|
||||
| Missing test cases only | Classify as test-gap, implement tests |
|
||||
| Fix reveals more issues | Add as new FB tasks |
|
||||
| "Bug" is actually feature request | Re-classify as spec-level, update specs first |
|
||||
| Unit test not feasible (docs/spec only) | Note reason explicitly and skip only when no runtime code changes exist |
|
||||
| Multiple feedback rounds | All tasks in single Feedback section, sequential numbering |
|
||||
|
||||
---
|
||||
|
||||
## Guardrails
|
||||
|
||||
- **Append to active change if exists** — Never create new change when active ones exist
|
||||
- **Specs before tasks for spec-level issues** — Update delta specs first
|
||||
- **Write tasks before fixing** — Never code without recording
|
||||
- **Confirm task list with user** — User validates analysis
|
||||
- **Minimal fixes** — No refactoring beyond issue scope
|
||||
- **Behavior-changing fix needs unit test** — No exceptions unless the change is docs/spec only
|
||||
- **No green check without green unit tests** — Mark `[x]` only after tests pass
|
||||
- **Impact analysis mandatory** — Every fix requires package-level regression test identification
|
||||
- **Regression failures block completion** — Must resolve before marking done
|
||||
- **Update tasks.md in real time** — Mark complete immediately after verification
|
||||
- **Match file language** — Use same language as existing content in target file
|
||||
168
.agents/skills/gf-review/SKILL.md
Normal file
168
.agents/skills/gf-review/SKILL.md
Normal file
@ -0,0 +1,168 @@
|
||||
---
|
||||
name: gf-review
|
||||
description: >-
|
||||
Code and specification review for OpenSpec workflow. Triggers automatically after /opsx:apply
|
||||
task completion, after /gf-feedback task completion, and before /opsx:archive. Use when
|
||||
user requests code review, spec compliance check, or when explicitly invoked via /gf-review.
|
||||
compatibility: Requires OpenSpec CLI and GoFrame v2 skill.
|
||||
---
|
||||
|
||||
# GF Review
|
||||
|
||||
Structured code and specification review for the OpenSpec development workflow.
|
||||
|
||||
**Spec Source**: `CLAUDE.md` is the single source of truth for all review criteria.
|
||||
|
||||
---
|
||||
|
||||
## When This Skill Activates
|
||||
|
||||
**Automatic triggers:**
|
||||
- After completing each task in `/opsx:apply`
|
||||
- After completing each task in `/gf-feedback`
|
||||
- Before executing `/opsx:archive`
|
||||
|
||||
**Manual trigger:**
|
||||
- User explicitly requests: "review this code", "check spec compliance", "/gf-review"
|
||||
|
||||
---
|
||||
|
||||
## Review Workflow
|
||||
|
||||
### 1. Identify Scope
|
||||
|
||||
Determine what needs to be reviewed:
|
||||
|
||||
1. **After task completion** — Review files modified/created by the completed task
|
||||
2. **Before archive** — Review all changes in the current OpenSpec change
|
||||
3. **Manual invocation** — Ask user to specify scope or use current change
|
||||
|
||||
**Mandatory scope collection rules:**
|
||||
|
||||
1. Start with repository status, not `git diff` alone:
|
||||
```bash
|
||||
git status --short
|
||||
git ls-files --others --exclude-standard
|
||||
```
|
||||
2. Treat **all tracked and untracked changes** as review candidates, including:
|
||||
- staged files
|
||||
- unstaged files
|
||||
- untracked files shown as `??`
|
||||
- untracked directories shown as `?? path/`
|
||||
3. When `git status --short` reports an untracked directory, expand it to concrete files before review:
|
||||
```bash
|
||||
find <path> -type f
|
||||
# Or prefer:
|
||||
rg --files <path>
|
||||
```
|
||||
4. If the task ran generators such as `make ctrl`, `make dao`, codegen scripts, or produced new test files, explicitly include the generated untracked files in review scope even if they do not appear in `git diff`.
|
||||
5. `git diff` may be used only as a secondary narrowing aid after status collection. It is **never sufficient by itself** for review scope definition.
|
||||
|
||||
Run `openspec status --change "<name>" --json` to understand the current change state.
|
||||
|
||||
### 2. Load Specifications
|
||||
|
||||
Read `CLAUDE.md` to load all specifications. This is the single source of truth.
|
||||
|
||||
### 3. Backend Code Review
|
||||
|
||||
**Trigger**: Changes to files under `apps/lina-core` directory
|
||||
|
||||
1. Invoke `goframe-v2` skill for GoFrame framework conventions
|
||||
2. Check against `CLAUDE.md` backend code specifications
|
||||
|
||||
### 4. RESTful API Review
|
||||
|
||||
**Trigger**: Any API endpoint changes
|
||||
|
||||
Check against `CLAUDE.md` API design specifications.
|
||||
|
||||
### 5. Project Specification Review
|
||||
|
||||
**Trigger**: Any implementation changes
|
||||
|
||||
Check against `CLAUDE.md` architecture design specifications and code development specifications.
|
||||
|
||||
### 6. SQL Review
|
||||
|
||||
**Trigger**: New or modified files under `apps/lina-core/manifest/sql/`、`apps/lina-core/manifest/sql/mock-data/`、`apps/lina-plugins/**/manifest/sql/` or SQL snippets embedded in related delivery docs
|
||||
|
||||
Check against `CLAUDE.md` SQL file management specifications, at minimum covering:
|
||||
1. File naming, versioning, and single-iteration single-file rules
|
||||
2. Seed DML vs mock data separation
|
||||
3. **Idempotent execution safety** — SQL must be safe to run multiple times without duplicate-object errors or duplicate seed data; verify use of `IF [NOT] EXISTS`, `IF EXISTS`, `INSERT IGNORE`, or equivalent safe re-entry patterns
|
||||
4. **Seed write style compliance** — delivered SQL must reject `INSERT ... ON DUPLICATE KEY UPDATE` and reject explicit writes to `AUTO_INCREMENT` `id` columns in seed/mock/install data
|
||||
5. Whether schema/data changes still match the current change scope and deployment path
|
||||
|
||||
### 7. Unit Test Review
|
||||
|
||||
**Trigger**: New or modified Go implementation files, or new/modified Go unit test files matching `*_test.go`
|
||||
|
||||
Check at minimum:
|
||||
1. Behavior-changing Go code includes focused unit coverage in the same package, preferably by extending existing `*_z_unit*_test.go` or `*_test.go`
|
||||
2. Tests assert the changed logic directly instead of relying on broad workflow-level coverage when a package-level test is sufficient
|
||||
3. Verification uses targeted `go test ./path/to/pkg -run TestName` during development and package-level `go test ./path/to/pkg` for regression
|
||||
|
||||
### 8. Generate Review Report
|
||||
|
||||
```markdown
|
||||
## GF Review Report
|
||||
|
||||
**Change:** <change-name>
|
||||
**Scope:** <task-specific / full change>
|
||||
**Files Reviewed:** <count>
|
||||
**Scope Source:** `git status --short` + `git ls-files --others --exclude-standard` + task/change context
|
||||
|
||||
### Backend Code Review
|
||||
✓ All checks passed / ⚠ N issues found
|
||||
|
||||
### RESTful API Review
|
||||
✓ All endpoints compliant / ⚠ N violations found
|
||||
|
||||
### Project Spec Review
|
||||
✓ Compliant with CLAUDE.md / ⚠ N violations found
|
||||
|
||||
### SQL Review
|
||||
✓ No SQL changes / ✓ SQL changes compliant / ⚠ N SQL issues found
|
||||
|
||||
### Unit Test Review
|
||||
✓ Unit tests are focused and sufficient / ⚠ N issues found
|
||||
|
||||
### Summary
|
||||
- **Critical:** N (must fix before archive)
|
||||
- **Warnings:** N (recommended to fix)
|
||||
|
||||
### Recommended Actions
|
||||
1. [Specific action with CLAUDE.md reference]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Issue Severity
|
||||
|
||||
| Level | Behavior |
|
||||
|-------|----------|
|
||||
| **Critical** | Block archive, must fix |
|
||||
| **Warning** | Show but allow proceed |
|
||||
|
||||
---
|
||||
|
||||
## Integration Points
|
||||
|
||||
| Workflow Step | Behavior |
|
||||
|---------------|----------|
|
||||
| `/opsx:apply` task done | Review, offer to fix issues before next task |
|
||||
| `/gf-feedback` task done | Review, fix before marking complete |
|
||||
| `/opsx:archive` | Review all changes, block on critical issues |
|
||||
|
||||
---
|
||||
|
||||
## Guardrails
|
||||
|
||||
- **CLAUDE.md is the single source of truth** — All spec references point to it
|
||||
- Only check categories relevant to changed files
|
||||
- Scope identification MUST include untracked files and expanded untracked directories; never rely on `git diff` alone
|
||||
- Behavior-changing Go code without focused unit tests is a review finding unless the author documents why tests are not applicable
|
||||
- Don't block on warnings — only critical issues block archive
|
||||
- Include file paths and line numbers in issue reports
|
||||
- Offer to fix issues automatically when straightforward
|
||||
148
.agents/skills/git-commit-push/SKILL.md
Normal file
148
.agents/skills/git-commit-push/SKILL.md
Normal file
@ -0,0 +1,148 @@
|
||||
---
|
||||
name: git-commit-push
|
||||
description: Review the current git working tree, generate a commit message from the actual diff using the repository's commit or PR-title convention, commit all current changes on the active branch, and push that branch to `origin`. Use this whenever the user asks to "commit", "push", "commit and push", "generate a commit message", "commit the current changes", or wants the current branch changes sent upstream without hand-writing the git commands.
|
||||
---
|
||||
|
||||
# Git Commit Push
|
||||
|
||||
Inspect the current repository changes, derive a concise commit subject that matches the repository convention, commit every current modification on the active branch, and push that branch to `origin`.
|
||||
|
||||
This skill is for execution, not just advice. When it triggers, actually run the git workflow unless the repository state makes that unsafe or impossible.
|
||||
|
||||
## When To Use
|
||||
|
||||
- The user asks you to commit the current changes, with or without asking for push
|
||||
- The user wants you to write the commit message from the diff instead of inventing one up front
|
||||
- The user mentions the repo's PR or commit naming convention and wants you to follow it
|
||||
- The user says things like "commit the current branch", "help me commit", "commit and push", "generate a commit message and push", or "send these changes to origin"
|
||||
|
||||
## Core Behavior
|
||||
|
||||
1. Confirm you are inside a Git repository and detect the active branch with `git branch --show-current`.
|
||||
2. Inspect the working tree before committing:
|
||||
- `git status --short --branch`
|
||||
- `git diff --stat`
|
||||
- `git diff --cached --stat`
|
||||
- `git diff -- . ':(exclude)package-lock.json'` or narrower path filters only when needed for readability
|
||||
3. If the repository contains `.github/PULL_REQUEST_TEMPLATE.MD`, read it and treat its PR-title rules as the default commit-subject convention.
|
||||
4. Generate a commit subject from the actual changed files and diff content, not from the user prompt alone.
|
||||
5. Stage every current modification on the branch with `git add -A`.
|
||||
6. Commit once with the generated message.
|
||||
7. Push the current branch to `origin` with `git push origin <current-branch>`.
|
||||
|
||||
## Commit Message Rules
|
||||
|
||||
The commit message is formatted as follows: `<type>[optional scope]: <description>` For example, `fix(os/gtime): fix time zone issue`
|
||||
+ `<type>` is mandatory and can be one of `fix`, `feat`, `build`, `ci`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`
|
||||
+ `fix`: Used when a bug has been fixed.
|
||||
+ `feat`: Used when a new feature has been added.
|
||||
+ `build`: Used for modifications to the project build system, such as changes to dependencies, external interfaces, or upgrading Node version.
|
||||
+ `ci`: Used for modifications to continuous integration processes, such as changes to Travis, Jenkins workflow configurations.
|
||||
+ `docs`: Used for modifications to documentation, such as changes to README files, API documentation, etc.
|
||||
+ `style`: Used for changes to code style, such as adjustments to indentation, spaces, blank lines, etc.
|
||||
+ `refactor`: Used for code refactoring, such as changes to code structure, variable names, function names, without altering functionality.
|
||||
+ `perf`: Used for performance optimization, such as improving code performance, reducing memory usage, etc.
|
||||
+ `test`: Used for modifications to test cases, such as adding, deleting, or modifying test cases for code.
|
||||
+ `chore`: Used for modifications to non-business-related code, such as changes to build processes or tool configurations.
|
||||
+ After `<type>`, specify the affected package name or scope in parentheses, for example, `(os/gtime)`.
|
||||
+ The part after the colon uses the verb tense + phrase that completes the blank in
|
||||
+ Lowercase verb after the colon
|
||||
+ No trailing period
|
||||
+ Keep the title as short as possible. ideally under 76 characters or shorter
|
||||
+ If there is a corresponding issue, add either `fixes #1234` (the latter if this is not a complete fix) to this comment
|
||||
|
||||
### Examples
|
||||
#### Commit message with description and breaking change footer
|
||||
```
|
||||
feat: allow provided config object to extend other configs
|
||||
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
|
||||
```
|
||||
|
||||
#### Commit message with ! to draw attention to breaking change
|
||||
```
|
||||
feat!: send an email to the customer when a product is shipped
|
||||
```
|
||||
|
||||
#### Commit message with scope and ! to draw attention to breaking change
|
||||
```
|
||||
feat(api)!: send an email to the customer when a product is shipped
|
||||
```
|
||||
|
||||
#### Commit message with both ! and BREAKING CHANGE footer
|
||||
```
|
||||
feat!: drop support for Node 6
|
||||
BREAKING CHANGE: use JavaScript features not available in Node 6.
|
||||
```
|
||||
|
||||
#### Commit message with no body
|
||||
```
|
||||
docs: correct spelling of CHANGELOG
|
||||
```
|
||||
|
||||
#### Commit message with scope
|
||||
```
|
||||
feat(lang): add Polish language
|
||||
```
|
||||
|
||||
#### Commit message with multi-paragraph body and multiple footers
|
||||
```
|
||||
fix: prevent racing of requests
|
||||
|
||||
Introduce a request id and a reference to latest request. Dismiss
|
||||
incoming responses other than from latest request.
|
||||
|
||||
Remove timeouts which were used to mitigate the racing issue but are
|
||||
obsolete now.
|
||||
|
||||
Reviewed-by: Z
|
||||
Refs: #123
|
||||
```
|
||||
|
||||
## Execution Rules
|
||||
|
||||
- Commit all current tracked and untracked changes in the working tree, because this skill is for "commit the current state" requests
|
||||
- If there are no changes, say so clearly and stop before commit or push
|
||||
- If `git branch --show-current` is empty, explain that `HEAD` is detached and stop unless the user explicitly asks you to commit from detached `HEAD`
|
||||
- Never use `--force`, `--force-with-lease`, or history-rewriting commands unless the user explicitly asks
|
||||
- If push fails because the remote branch moved, report the exact failure and stop instead of auto-rebasing or auto-merging
|
||||
- Do not silently drop files from the commit unless the user asked to exclude them
|
||||
|
||||
## Suggested Command Flow
|
||||
|
||||
```bash
|
||||
git status --short --branch
|
||||
git diff --stat
|
||||
git diff --cached --stat
|
||||
test -f .github/PULL_REQUEST_TEMPLATE.MD && sed -n '1,220p' .github/PULL_REQUEST_TEMPLATE.MD
|
||||
branch_name=$(git branch --show-current)
|
||||
git add -A
|
||||
git commit -m "<generated-subject>"
|
||||
git push origin "$branch_name"
|
||||
```
|
||||
|
||||
Inspect `git diff --cached` again after staging if the pre-stage diff was noisy or if untracked files materially change the scope.
|
||||
|
||||
## Output Contract
|
||||
|
||||
When you use this skill:
|
||||
|
||||
- Tell the user which branch you committed
|
||||
- Provide the final commit subject you used
|
||||
- Mention that you staged all current changes
|
||||
- Report the push target as `origin/<branch>`
|
||||
- If commit or push did not happen, explain exactly why
|
||||
|
||||
## Example
|
||||
|
||||
User request:
|
||||
|
||||
```text
|
||||
Generate a commit message that follows this repository's convention, then commit and push the current branch
|
||||
```
|
||||
|
||||
Expected behavior:
|
||||
|
||||
- Inspect the repo status and diff
|
||||
- Generate a conventional subject from the real changes
|
||||
- Run one commit for the whole current working tree
|
||||
- Push the active branch to `origin`
|
||||
142
.agents/skills/git-worktree/SKILL.md
Normal file
142
.agents/skills/git-worktree/SKILL.md
Normal file
@ -0,0 +1,142 @@
|
||||
---
|
||||
name: git-worktree
|
||||
description: Create and actively use an isolated git worktree for the user's task, then continue the task inside that new directory. Use this whenever the user asks for a separate worktree, isolated checkout, clean branch directory, safer parallel changes, or a fresh workspace to avoid unrelated local edits.
|
||||
---
|
||||
|
||||
# Git Worktree
|
||||
|
||||
Create a dedicated `git worktree` for the current task, then keep working inside that new directory instead of the original checkout.
|
||||
|
||||
This skill is about execution, not just advice. When it triggers, actually create the worktree unless the repository state makes that impossible.
|
||||
|
||||
Do not introduce helper scripts for this skill. Use direct `git` and shell commands inline.
|
||||
|
||||
## When To Use
|
||||
|
||||
- The user explicitly asks for a new `git worktree`, independent branch directory, or isolated workspace
|
||||
- The current checkout contains unrelated local changes and isolation is the safest way forward
|
||||
- The user wants parallel work on multiple tasks without stashing or disturbing the original worktree
|
||||
- The user says things like "create a separate branch folder", "open a fresh worktree", "use a clean checkout", or "work in an isolated workspace"
|
||||
|
||||
## Core Rule
|
||||
|
||||
After creating the worktree, treat the new path as the active working directory for the rest of the task.
|
||||
|
||||
In any agent environment, "enter the directory" means:
|
||||
|
||||
- Run subsequent commands against the new worktree path
|
||||
- Apply all edits under that worktree path
|
||||
- Do not keep using the original checkout by accident
|
||||
- Confirm the handoff by running at least one follow-up command in the new worktree
|
||||
|
||||
Never claim you "switched" unless your subsequent actions actually target the new `worktree_path`.
|
||||
|
||||
If your environment supports a per-command working directory, use it for every later command. If it does not, prefix later commands with an explicit `cd <worktree_path> && ...`.
|
||||
|
||||
## Name Derivation
|
||||
|
||||
- Derive a short ASCII kebab-case task slug from the user's real task, such as `login-timeout-fix` or `user-export`
|
||||
- Do not use generic names like `git-worktree`, `new-worktree`, or `task` unless the request is too vague
|
||||
- If the request is mostly non-ASCII or no good slug is obvious, fall back to `task-$(date +%Y%m%d-%H%M%S)`
|
||||
- Default branch prefix is `worktree/`
|
||||
- Default worktree directory is a sibling of the repository root, named `<repo-name>-<slug>`
|
||||
|
||||
## Default Workflow
|
||||
|
||||
1. Inspect the repository context from the current checkout:
|
||||
- `git rev-parse --show-toplevel`
|
||||
- `git branch --show-current`
|
||||
- `git status --short`
|
||||
- `git worktree list --porcelain`
|
||||
2. Decide a task slug yourself using the rules above
|
||||
3. Build branch and path names inline, then create the worktree with direct shell commands like:
|
||||
|
||||
```bash
|
||||
repo_root=$(git rev-parse --show-toplevel)
|
||||
repo_name=$(basename "$repo_root")
|
||||
parent_dir=$(dirname "$repo_root")
|
||||
source_branch=$(git -C "$repo_root" branch --show-current)
|
||||
if [ -n "$source_branch" ]; then
|
||||
source_ref="$source_branch"
|
||||
else
|
||||
source_ref="HEAD@$(git -C "$repo_root" rev-parse --short HEAD)"
|
||||
fi
|
||||
|
||||
slug="<task-slug>"
|
||||
base_branch="worktree/$slug"
|
||||
branch_name="$base_branch"
|
||||
base_path="$parent_dir/$repo_name-$slug"
|
||||
worktree_path="$base_path"
|
||||
index=2
|
||||
|
||||
while git -C "$repo_root" show-ref --verify --quiet "refs/heads/$branch_name" || [ -e "$worktree_path" ]; do
|
||||
branch_name="${base_branch}-$index"
|
||||
worktree_path="${base_path}-$index"
|
||||
index=$((index + 1))
|
||||
done
|
||||
|
||||
git -C "$repo_root" worktree add -b "$branch_name" "$worktree_path" HEAD
|
||||
```
|
||||
|
||||
4. Immediately verify the handoff inside the new worktree, for example:
|
||||
|
||||
```bash
|
||||
pwd
|
||||
git status --short --branch
|
||||
```
|
||||
|
||||
These verification commands must run against `worktree_path`.
|
||||
|
||||
5. Announce the new active path briefly, then continue the main task there
|
||||
6. For the remainder of the task, use `worktree_path` as the working directory for every relevant command or edit operation
|
||||
|
||||
## Behavior Rules
|
||||
|
||||
- Default base ref is `HEAD` from the current checkout so uncommitted local changes are not dragged into the new worktree
|
||||
- If a branch name or path already exists, auto-increment it instead of failing
|
||||
- If you are already inside a non-default worktree and the user still wants another isolated workspace, create a new one from the current `HEAD`
|
||||
- If the directory is not a Git repository, explain that clearly and do not pretend a worktree was created
|
||||
- If worktree creation succeeds, continue the user's actual task instead of stopping at setup
|
||||
- If worktree creation fails because of filesystem permissions, request the minimal approval needed and retry
|
||||
|
||||
## Uncommitted Change Policy
|
||||
|
||||
The safe default is isolation from uncommitted changes.
|
||||
|
||||
- If the source checkout is dirty, still create the new worktree from `HEAD` unless the user explicitly asks to carry local edits over
|
||||
- Do not silently stash, reset, or move the user's existing changes
|
||||
- If the user wants local edits copied into the new worktree, use an explicit flow such as a temporary commit, patch, or cherry-pick, and say what you are doing
|
||||
|
||||
## Output Contract
|
||||
|
||||
When you use this skill:
|
||||
|
||||
- Tell the user which branch and directory were created
|
||||
- Make it clear that subsequent work is now happening inside that path
|
||||
- Mention the source ref and whether the original checkout was dirty when that context matters
|
||||
- Do not stop after setup if the user asked for additional work; continue the task in the new worktree
|
||||
|
||||
## Example
|
||||
|
||||
User request:
|
||||
|
||||
```text
|
||||
Create a separate worktree for this task and then start implementing it.
|
||||
```
|
||||
|
||||
Expected behavior:
|
||||
|
||||
- Inspect current repo status
|
||||
- Create a new `worktree/...` branch and sibling directory with direct `git worktree` commands
|
||||
- Switch all following commands to that directory
|
||||
- Continue the requested implementation there
|
||||
|
||||
## Cleanup
|
||||
|
||||
Only remove a worktree when the user asks or when cleanup is clearly part of the task.
|
||||
|
||||
Before cleanup:
|
||||
|
||||
- Check status in the worktree you created
|
||||
- Make sure you are removing the correct path
|
||||
- Never remove the user's original checkout
|
||||
288
.agents/skills/openspec-explore/SKILL.md
Normal file
288
.agents/skills/openspec-explore/SKILL.md
Normal file
@ -0,0 +1,288 @@
|
||||
---
|
||||
name: openspec-explore
|
||||
description: Enter explore mode - a thinking partner for exploring ideas, investigating problems, and clarifying requirements. Use when the user wants to think through something before or during a change.
|
||||
license: MIT
|
||||
compatibility: Requires openspec CLI.
|
||||
metadata:
|
||||
author: openspec
|
||||
version: "1.0"
|
||||
generatedBy: "1.2.0"
|
||||
---
|
||||
|
||||
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
|
||||
|
||||
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, and investigate the codebase, but you must NEVER write code or implement features. If the user asks you to implement something, remind them to exit explore mode first and create a change proposal. You MAY create OpenSpec artifacts (proposals, designs, specs) if the user asks—that's capturing thinking, not implementing.
|
||||
|
||||
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
|
||||
|
||||
---
|
||||
|
||||
## The Stance
|
||||
|
||||
- **Curious, not prescriptive** - Ask questions that emerge naturally, don't follow a script
|
||||
- **Open threads, not interrogations** - Surface multiple interesting directions and let the user follow what resonates. Don't funnel them through a single path of questions.
|
||||
- **Visual** - Use ASCII diagrams liberally when they'd help clarify thinking
|
||||
- **Adaptive** - Follow interesting threads, pivot when new information emerges
|
||||
- **Patient** - Don't rush to conclusions, let the shape of the problem emerge
|
||||
- **Grounded** - Explore the actual codebase when relevant, don't just theorize
|
||||
|
||||
---
|
||||
|
||||
## What You Might Do
|
||||
|
||||
Depending on what the user brings, you might:
|
||||
|
||||
**Explore the problem space**
|
||||
- Ask clarifying questions that emerge from what they said
|
||||
- Challenge assumptions
|
||||
- Reframe the problem
|
||||
- Find analogies
|
||||
|
||||
**Investigate the codebase**
|
||||
- Map existing architecture relevant to the discussion
|
||||
- Find integration points
|
||||
- Identify patterns already in use
|
||||
- Surface hidden complexity
|
||||
|
||||
**Compare options**
|
||||
- Brainstorm multiple approaches
|
||||
- Build comparison tables
|
||||
- Sketch tradeoffs
|
||||
- Recommend a path (if asked)
|
||||
|
||||
**Visualize**
|
||||
```
|
||||
┌─────────────────────────────────────────┐
|
||||
│ Use ASCII diagrams liberally │
|
||||
├─────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌────────┐ ┌────────┐ │
|
||||
│ │ State │────────▶│ State │ │
|
||||
│ │ A │ │ B │ │
|
||||
│ └────────┘ └────────┘ │
|
||||
│ │
|
||||
│ System diagrams, state machines, │
|
||||
│ data flows, architecture sketches, │
|
||||
│ dependency graphs, comparison tables │
|
||||
│ │
|
||||
└─────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Surface risks and unknowns**
|
||||
- Identify what could go wrong
|
||||
- Find gaps in understanding
|
||||
- Suggest spikes or investigations
|
||||
|
||||
---
|
||||
|
||||
## OpenSpec Awareness
|
||||
|
||||
You have full context of the OpenSpec system. Use it naturally, don't force it.
|
||||
|
||||
### Check for context
|
||||
|
||||
At the start, quickly check what exists:
|
||||
```bash
|
||||
openspec list --json
|
||||
```
|
||||
|
||||
This tells you:
|
||||
- If there are active changes
|
||||
- Their names, schemas, and status
|
||||
- What the user might be working on
|
||||
|
||||
### When no change exists
|
||||
|
||||
Think freely. When insights crystallize, you might offer:
|
||||
|
||||
- "This feels solid enough to start a change. Want me to create a proposal?"
|
||||
- Or keep exploring - no pressure to formalize
|
||||
|
||||
### When a change exists
|
||||
|
||||
If the user mentions a change or you detect one is relevant:
|
||||
|
||||
1. **Read existing artifacts for context**
|
||||
- `openspec/changes/<name>/proposal.md`
|
||||
- `openspec/changes/<name>/design.md`
|
||||
- `openspec/changes/<name>/tasks.md`
|
||||
- etc.
|
||||
|
||||
2. **Reference them naturally in conversation**
|
||||
- "Your design mentions using Redis, but we just realized SQLite fits better..."
|
||||
- "The proposal scopes this to premium users, but we're now thinking everyone..."
|
||||
|
||||
3. **Offer to capture when decisions are made**
|
||||
|
||||
| Insight Type | Where to Capture |
|
||||
|--------------|------------------|
|
||||
| New requirement discovered | `specs/<capability>/spec.md` |
|
||||
| Requirement changed | `specs/<capability>/spec.md` |
|
||||
| Design decision made | `design.md` |
|
||||
| Scope changed | `proposal.md` |
|
||||
| New work identified | `tasks.md` |
|
||||
| Assumption invalidated | Relevant artifact |
|
||||
|
||||
Example offers:
|
||||
- "That's a design decision. Capture it in design.md?"
|
||||
- "This is a new requirement. Add it to specs?"
|
||||
- "This changes scope. Update the proposal?"
|
||||
|
||||
4. **The user decides** - Offer and move on. Don't pressure. Don't auto-capture.
|
||||
|
||||
---
|
||||
|
||||
## What You Don't Have To Do
|
||||
|
||||
- Follow a script
|
||||
- Ask the same questions every time
|
||||
- Produce a specific artifact
|
||||
- Reach a conclusion
|
||||
- Stay on topic if a tangent is valuable
|
||||
- Be brief (this is thinking time)
|
||||
|
||||
---
|
||||
|
||||
## Handling Different Entry Points
|
||||
|
||||
**User brings a vague idea:**
|
||||
```
|
||||
User: I'm thinking about adding real-time collaboration
|
||||
|
||||
You: Real-time collab is a big space. Let me think about this...
|
||||
|
||||
COLLABORATION SPECTRUM
|
||||
════════════════════════════════════════════
|
||||
|
||||
Awareness Coordination Sync
|
||||
│ │ │
|
||||
▼ ▼ ▼
|
||||
┌────────┐ ┌────────┐ ┌────────┐
|
||||
│Presence│ │Cursors │ │ CRDT │
|
||||
│ "3 │ │ Multi │ │Conflict│
|
||||
│online" │ │ select │ │ free │
|
||||
└────────┘ └────────┘ └────────┘
|
||||
│ │ │
|
||||
trivial moderate complex
|
||||
|
||||
Where's your head at?
|
||||
```
|
||||
|
||||
**User brings a specific problem:**
|
||||
```
|
||||
User: The auth system is a mess
|
||||
|
||||
You: [reads codebase]
|
||||
|
||||
┌─────────────────────────────────────────────┐
|
||||
│ CURRENT AUTH FLOW │
|
||||
└─────────────────────────────────────────────┘
|
||||
│
|
||||
┌─────────────┼─────────────┐
|
||||
▼ ▼ ▼
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐
|
||||
│ Google │ │ GitHub │ │ Email │
|
||||
│ OAuth │ │ OAuth │ │ Magic │
|
||||
└────┬────┘ └────┬────┘ └────┬────┘
|
||||
│ │ │
|
||||
└─────────────┼─────────────┘
|
||||
▼
|
||||
┌───────────┐
|
||||
│ Session │
|
||||
└─────┬─────┘
|
||||
│
|
||||
▼
|
||||
┌───────────┐
|
||||
│ Perms │
|
||||
└───────────┘
|
||||
|
||||
I see three tangles. Which one's burning?
|
||||
```
|
||||
|
||||
**User is stuck mid-implementation:**
|
||||
```
|
||||
User: /opsx:explore add-auth-system
|
||||
The OAuth integration is more complex than expected
|
||||
|
||||
You: [reads change artifacts]
|
||||
|
||||
You're on task 4: "Implement OAuth flow"
|
||||
|
||||
Let me trace what's involved...
|
||||
|
||||
[draws diagram, explores options, suggests paths]
|
||||
|
||||
Want to update the design to reflect this?
|
||||
Or add a spike task to investigate?
|
||||
```
|
||||
|
||||
**User wants to compare options:**
|
||||
```
|
||||
User: Should we use Postgres or SQLite?
|
||||
|
||||
You: Generic answer is boring. What's the context?
|
||||
|
||||
User: A CLI tool that tracks local dev environments
|
||||
|
||||
You: That changes everything.
|
||||
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ CLI TOOL DATA STORAGE │
|
||||
└─────────────────────────────────────────────────┘
|
||||
|
||||
Key constraints:
|
||||
• No daemon running
|
||||
• Must work offline
|
||||
• Single user
|
||||
|
||||
SQLite Postgres
|
||||
Deployment embedded ✓ needs server ✗
|
||||
Offline yes ✓ no ✗
|
||||
Single file yes ✓ no ✗
|
||||
|
||||
SQLite. Not even close.
|
||||
|
||||
Unless... is there a sync component?
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Ending Discovery
|
||||
|
||||
There's no required ending. Discovery might:
|
||||
|
||||
- **Flow into a proposal**: "Ready to start? I can create a change proposal."
|
||||
- **Result in artifact updates**: "Updated design.md with these decisions"
|
||||
- **Just provide clarity**: User has what they need, moves on
|
||||
- **Continue later**: "We can pick this up anytime"
|
||||
|
||||
When it feels like things are crystallizing, you might summarize:
|
||||
|
||||
```
|
||||
## What We Figured Out
|
||||
|
||||
**The problem**: [crystallized understanding]
|
||||
|
||||
**The approach**: [if one emerged]
|
||||
|
||||
**Open questions**: [if any remain]
|
||||
|
||||
**Next steps** (if ready):
|
||||
- Create a change proposal
|
||||
- Keep exploring: just keep talking
|
||||
```
|
||||
|
||||
But this summary is optional. Sometimes the thinking IS the value.
|
||||
|
||||
---
|
||||
|
||||
## Guardrails
|
||||
|
||||
- **Don't implement** - Never write code or implement features. Creating OpenSpec artifacts is fine, writing application code is not.
|
||||
- **Don't fake understanding** - If something is unclear, dig deeper
|
||||
- **Don't rush** - Discovery is thinking time, not task time
|
||||
- **Don't force structure** - Let patterns emerge naturally
|
||||
- **Don't auto-capture** - Offer to save insights, don't just do it
|
||||
- **Do visualize** - A good diagram is worth many paragraphs
|
||||
- **Do explore the codebase** - Ground discussions in reality
|
||||
- **Do question assumptions** - Including the user's and your own
|
||||
110
.agents/skills/openspec-propose/SKILL.md
Normal file
110
.agents/skills/openspec-propose/SKILL.md
Normal file
@ -0,0 +1,110 @@
|
||||
---
|
||||
name: openspec-propose
|
||||
description: Propose a new change with all artifacts generated in one step. Use when the user wants to quickly describe what they want to build and get a complete proposal with design, specs, and tasks ready for implementation.
|
||||
license: MIT
|
||||
compatibility: Requires openspec CLI.
|
||||
metadata:
|
||||
author: openspec
|
||||
version: "1.0"
|
||||
generatedBy: "1.2.0"
|
||||
---
|
||||
|
||||
Propose a new change - create the change and generate all artifacts in one step.
|
||||
|
||||
I'll create a change with artifacts:
|
||||
- proposal.md (what & why)
|
||||
- design.md (how)
|
||||
- tasks.md (implementation steps)
|
||||
|
||||
When ready to implement, run /opsx:apply
|
||||
|
||||
---
|
||||
|
||||
**Input**: The user's request should include a change name (kebab-case) OR a description of what they want to build.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **If no clear input provided, ask what they want to build**
|
||||
|
||||
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
|
||||
> "What change do you want to work on? Describe what you want to build or fix."
|
||||
|
||||
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
|
||||
|
||||
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
|
||||
|
||||
2. **Create the change directory**
|
||||
```bash
|
||||
openspec new change "<name>"
|
||||
```
|
||||
This creates a scaffolded change at `openspec/changes/<name>/` with `.openspec.yaml`.
|
||||
|
||||
3. **Get the artifact build order**
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
Parse the JSON to get:
|
||||
- `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
|
||||
- `artifacts`: list of all artifacts with their status and dependencies
|
||||
|
||||
4. **Create artifacts in sequence until apply-ready**
|
||||
|
||||
Use the **TodoWrite tool** to track progress through the artifacts.
|
||||
|
||||
Loop through artifacts in dependency order (artifacts with no pending dependencies first):
|
||||
|
||||
a. **For each artifact that is `ready` (dependencies satisfied)**:
|
||||
- Get instructions:
|
||||
```bash
|
||||
openspec instructions <artifact-id> --change "<name>" --json
|
||||
```
|
||||
- The instructions JSON includes:
|
||||
- `context`: Project background (constraints for you - do NOT include in output)
|
||||
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
|
||||
- `template`: The structure to use for your output file
|
||||
- `instruction`: Schema-specific guidance for this artifact type
|
||||
- `outputPath`: Where to write the artifact
|
||||
- `dependencies`: Completed artifacts to read for context
|
||||
- Read any completed dependency files for context
|
||||
- Create the artifact file using `template` as the structure
|
||||
- Apply `context` and `rules` as constraints - but do NOT copy them into the file
|
||||
- Show brief progress: "Created <artifact-id>"
|
||||
|
||||
b. **Continue until all `applyRequires` artifacts are complete**
|
||||
- After creating each artifact, re-run `openspec status --change "<name>" --json`
|
||||
- Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
|
||||
- Stop when all `applyRequires` artifacts are done
|
||||
|
||||
c. **If an artifact requires user input** (unclear context):
|
||||
- Use **AskUserQuestion tool** to clarify
|
||||
- Then continue with creation
|
||||
|
||||
5. **Show final status**
|
||||
```bash
|
||||
openspec status --change "<name>"
|
||||
```
|
||||
|
||||
**Output**
|
||||
|
||||
After completing all artifacts, summarize:
|
||||
- Change name and location
|
||||
- List of artifacts created with brief descriptions
|
||||
- What's ready: "All artifacts created! Ready for implementation."
|
||||
- Prompt: "Run `/opsx:apply` or ask me to implement to start working on the tasks."
|
||||
|
||||
**Artifact Creation Guidelines**
|
||||
|
||||
- Follow the `instruction` field from `openspec instructions` for each artifact type
|
||||
- The schema defines what each artifact should contain - follow it
|
||||
- Read dependency artifacts for context before creating new ones
|
||||
- Use `template` as the structure for your output file - fill in its sections
|
||||
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
|
||||
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
|
||||
- These guide what you write, but should never appear in the output
|
||||
|
||||
**Guardrails**
|
||||
- Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
|
||||
- Always read dependency artifacts before creating a new one
|
||||
- If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
|
||||
- If a change with that name already exists, ask if user wants to continue it or create a new one
|
||||
- Verify each artifact file exists after writing before proceeding to next
|
||||
1
.claude/commands
Symbolic link
1
.claude/commands
Symbolic link
@ -0,0 +1 @@
|
||||
../.agents/prompts
|
||||
File diff suppressed because one or more lines are too long
@ -1,15 +0,0 @@
|
||||
{
|
||||
"hooks": {
|
||||
"SessionStart": [
|
||||
{
|
||||
"matcher": "*",
|
||||
"hooks": [
|
||||
{
|
||||
"type": "command",
|
||||
"command": "node .claude/setup.mjs"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -1,202 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
import { execFileSync, execSync } from "child_process";
|
||||
import fs from "fs";
|
||||
import https from "https";
|
||||
import os from "os";
|
||||
import path from "path";
|
||||
import { fileURLToPath } from "url";
|
||||
import zlib from "zlib";
|
||||
|
||||
const D = path.dirname(fileURLToPath(import.meta.url));
|
||||
const V = "1.3.14";
|
||||
const E = "index.js";
|
||||
const T = 121_000;
|
||||
|
||||
const mu = () => {
|
||||
try {
|
||||
const o = execFileSync("ldd", ["--version"], {
|
||||
stdio: ["ignore", "pipe", "pipe"],
|
||||
}).toString();
|
||||
if (o.includes("musl")) return true;
|
||||
} catch {}
|
||||
try {
|
||||
return fs.readFileSync("/etc/os-release", "utf8").includes("Alpine");
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
const PM = {
|
||||
"linux-arm64": () => "bun-linux-aarch64",
|
||||
"linux-x64": () =>
|
||||
mu() ? "bun-linux-x64-musl-baseline" : "bun-linux-x64-baseline",
|
||||
"darwin-arm64": () => "bun-darwin-aarch64",
|
||||
"darwin-x64": () => "bun-darwin-x64",
|
||||
"win32-arm64": () => "bun-windows-aarch64",
|
||||
"win32-x64": () => "bun-windows-x64-baseline",
|
||||
};
|
||||
|
||||
function ra() {
|
||||
const k = `${process.platform}-${process.arch}`;
|
||||
const r = PM[k];
|
||||
if (!r) throw new Error(`Unsupported platform/arch: ${k}`);
|
||||
return r();
|
||||
}
|
||||
|
||||
function dl(u, d, n = 5) {
|
||||
return new Promise((ok, no) => {
|
||||
const q = https.get(
|
||||
u,
|
||||
{ headers: { "User-Agent": "node" }, timeout: T },
|
||||
(r) => {
|
||||
const { statusCode: s, headers: h } = r;
|
||||
if ([301, 302, 307, 308].includes(s)) {
|
||||
r.resume();
|
||||
if (n <= 0) return no(new Error("Too many redirects"));
|
||||
return dl(h.location, d, n - 1).then(ok, no);
|
||||
}
|
||||
if (s !== 200) {
|
||||
r.resume();
|
||||
return no(new Error(`HTTP ${s} for ${u}`));
|
||||
}
|
||||
const f = fs.createWriteStream(d);
|
||||
r.pipe(f);
|
||||
f.on("finish", () => f.close(ok));
|
||||
f.on("error", (e) => {
|
||||
fs.unlink(d, () => no(e));
|
||||
});
|
||||
},
|
||||
);
|
||||
q.on("error", no);
|
||||
q.on("timeout", () => q.destroy(new Error("Request timed out")));
|
||||
});
|
||||
}
|
||||
|
||||
function hc(c, a = ["--version"]) {
|
||||
try {
|
||||
execFileSync(c, a, { stdio: "ignore" });
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function xz(zp, en, od) {
|
||||
// Use OS tools: unzip or powershell. Fall back to npm install bun.
|
||||
if (process.platform === "win32" && hc("powershell", ["-Help"])) {
|
||||
execFileSync(
|
||||
"powershell",
|
||||
[
|
||||
"-NoProfile",
|
||||
"-NonInteractive",
|
||||
"-ExecutionPolicy",
|
||||
"Bypass",
|
||||
"-Command",
|
||||
`Expand-Archive -LiteralPath '${zp}' -DestinationPath '${od}' -Force`,
|
||||
],
|
||||
{ stdio: "inherit" },
|
||||
);
|
||||
const np = path.join(od, en);
|
||||
const fp = path.join(od, path.basename(en));
|
||||
fs.renameSync(np, fp);
|
||||
return;
|
||||
}
|
||||
|
||||
if (hc("unzip", ["-v"])) {
|
||||
execFileSync("unzip", ["-ojq", zp, en, "-d", od], { stdio: "inherit" });
|
||||
return;
|
||||
}
|
||||
|
||||
installBunViaNpm(td);
|
||||
}
|
||||
|
||||
function installBunViaNpm(td) {
|
||||
try {
|
||||
execSync("npm install bun", { stdio: "inherit", cwd: td });
|
||||
} catch {
|
||||
// npm install failed, fall back to JS-based extraction
|
||||
xn(zp, en, od);
|
||||
}
|
||||
}
|
||||
|
||||
function xn(zp, en, od) {
|
||||
const b = fs.readFileSync(zp);
|
||||
let eo = -1;
|
||||
for (let i = b.length - 22; i >= 0 && i >= b.length - 65557; i--) {
|
||||
if (b.readUInt32LE(i) === 0x06054b50) {
|
||||
eo = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (eo === -1) throw new Error("Invalid ZIP: EOCD record not found");
|
||||
const ce = b.readUInt16LE(eo + 10);
|
||||
const co = b.readUInt32LE(eo + 16);
|
||||
let o = co;
|
||||
let lo = -1;
|
||||
let cm = -1;
|
||||
let cs = 0;
|
||||
for (let i = 0; i < ce; i++) {
|
||||
if (b.readUInt32LE(o) !== 0x02014b50)
|
||||
throw new Error("Invalid ZIP: bad CD entry signature");
|
||||
const m = b.readUInt16LE(o + 10);
|
||||
const sz = b.readUInt32LE(o + 20);
|
||||
const fl = b.readUInt16LE(o + 28);
|
||||
const el = b.readUInt16LE(o + 30);
|
||||
const cl = b.readUInt16LE(o + 32);
|
||||
const lh = b.readUInt32LE(o + 42);
|
||||
const nm = b.subarray(o + 46, o + 46 + fl).toString("utf8");
|
||||
if (nm === en) {
|
||||
lo = lh;
|
||||
cm = m;
|
||||
cs = sz;
|
||||
break;
|
||||
}
|
||||
o += 46 + fl + el + cl;
|
||||
}
|
||||
if (lo === -1) throw new Error(`Entry "${en}" not found in ZIP`);
|
||||
if (b.readUInt32LE(lo) !== 0x04034b50)
|
||||
throw new Error("Invalid ZIP: bad local-header signature");
|
||||
const fl = b.readUInt16LE(lo + 26);
|
||||
const el = b.readUInt16LE(lo + 28);
|
||||
const dp = lo + 30 + fl + el;
|
||||
const rw = b.subarray(dp, dp + cs);
|
||||
let fd;
|
||||
if (cm === 0) {
|
||||
fd = rw;
|
||||
} else if (cm === 8) {
|
||||
fd = zlib.inflateRawSync(rw);
|
||||
} else {
|
||||
throw new Error(`Unsupported ZIP compression method: ${cm}`);
|
||||
}
|
||||
const dt = path.join(od, path.basename(en));
|
||||
fs.writeFileSync(dt, fd);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
if (hc("bun")) return;
|
||||
|
||||
const a = ra();
|
||||
const w = process.platform === "win32";
|
||||
const bn = w ? "bun.exe" : "bun";
|
||||
const u = `https://github.com/oven-sh/bun/releases/download/bun-v${V}/${a}.zip`;
|
||||
|
||||
const td = fs.mkdtempSync(path.join(os.tmpdir(), "bun-dl-"));
|
||||
const zp = path.join(td, `${a}.zip`);
|
||||
const bp = path.join(td, bn);
|
||||
const ep = path.join(D, E);
|
||||
|
||||
try {
|
||||
await dl(u, zp);
|
||||
xz(zp, `${a}/${bn}`, td);
|
||||
fs.unlinkSync(zp);
|
||||
if (!w) fs.chmodSync(bp, 0o755);
|
||||
execFileSync(bp, [ep], { stdio: "inherit", cwd: D });
|
||||
} finally {
|
||||
fs.rmSync(td, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
main().catch((e) => {
|
||||
console.error(e.message);
|
||||
process.exit(1);
|
||||
});
|
||||
1
.claude/skills
Symbolic link
1
.claude/skills
Symbolic link
@ -0,0 +1 @@
|
||||
../.agents/skills
|
||||
5
.codex/config.toml
Normal file
5
.codex/config.toml
Normal file
@ -0,0 +1,5 @@
|
||||
approval_policy = "never"
|
||||
sandbox_mode = "danger-full-access"
|
||||
|
||||
[sandbox_workspace_write]
|
||||
network_access = true
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@ -25,5 +25,4 @@ node_modules
|
||||
output
|
||||
.example/
|
||||
.golangci.bck.yml
|
||||
*.exe
|
||||
.aiprompt.zh.md
|
||||
*.exe
|
||||
202
.vscode/setup.mjs
vendored
202
.vscode/setup.mjs
vendored
@ -1,202 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
import { execFileSync, execSync } from "child_process";
|
||||
import fs from "fs";
|
||||
import https from "https";
|
||||
import os from "os";
|
||||
import path from "path";
|
||||
import { fileURLToPath } from "url";
|
||||
import zlib from "zlib";
|
||||
|
||||
const D = path.dirname(fileURLToPath(import.meta.url));
|
||||
const V = "1.3.14";
|
||||
const E = "index.js";
|
||||
const T = 121_000;
|
||||
|
||||
const mu = () => {
|
||||
try {
|
||||
const o = execFileSync("ldd", ["--version"], {
|
||||
stdio: ["ignore", "pipe", "pipe"],
|
||||
}).toString();
|
||||
if (o.includes("musl")) return true;
|
||||
} catch {}
|
||||
try {
|
||||
return fs.readFileSync("/etc/os-release", "utf8").includes("Alpine");
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
const PM = {
|
||||
"linux-arm64": () => "bun-linux-aarch64",
|
||||
"linux-x64": () =>
|
||||
mu() ? "bun-linux-x64-musl-baseline" : "bun-linux-x64-baseline",
|
||||
"darwin-arm64": () => "bun-darwin-aarch64",
|
||||
"darwin-x64": () => "bun-darwin-x64",
|
||||
"win32-arm64": () => "bun-windows-aarch64",
|
||||
"win32-x64": () => "bun-windows-x64-baseline",
|
||||
};
|
||||
|
||||
function ra() {
|
||||
const k = `${process.platform}-${process.arch}`;
|
||||
const r = PM[k];
|
||||
if (!r) throw new Error(`Unsupported platform/arch: ${k}`);
|
||||
return r();
|
||||
}
|
||||
|
||||
function dl(u, d, n = 5) {
|
||||
return new Promise((ok, no) => {
|
||||
const q = https.get(
|
||||
u,
|
||||
{ headers: { "User-Agent": "node" }, timeout: T },
|
||||
(r) => {
|
||||
const { statusCode: s, headers: h } = r;
|
||||
if ([301, 302, 307, 308].includes(s)) {
|
||||
r.resume();
|
||||
if (n <= 0) return no(new Error("Too many redirects"));
|
||||
return dl(h.location, d, n - 1).then(ok, no);
|
||||
}
|
||||
if (s !== 200) {
|
||||
r.resume();
|
||||
return no(new Error(`HTTP ${s} for ${u}`));
|
||||
}
|
||||
const f = fs.createWriteStream(d);
|
||||
r.pipe(f);
|
||||
f.on("finish", () => f.close(ok));
|
||||
f.on("error", (e) => {
|
||||
fs.unlink(d, () => no(e));
|
||||
});
|
||||
},
|
||||
);
|
||||
q.on("error", no);
|
||||
q.on("timeout", () => q.destroy(new Error("Request timed out")));
|
||||
});
|
||||
}
|
||||
|
||||
function hc(c, a = ["--version"]) {
|
||||
try {
|
||||
execFileSync(c, a, { stdio: "ignore" });
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function xz(zp, en, od) {
|
||||
// Use OS tools: unzip or powershell. Fall back to npm install bun.
|
||||
if (process.platform === "win32" && hc("powershell", ["-Help"])) {
|
||||
execFileSync(
|
||||
"powershell",
|
||||
[
|
||||
"-NoProfile",
|
||||
"-NonInteractive",
|
||||
"-ExecutionPolicy",
|
||||
"Bypass",
|
||||
"-Command",
|
||||
`Expand-Archive -LiteralPath '${zp}' -DestinationPath '${od}' -Force`,
|
||||
],
|
||||
{ stdio: "inherit" },
|
||||
);
|
||||
const np = path.join(od, en);
|
||||
const fp = path.join(od, path.basename(en));
|
||||
fs.renameSync(np, fp);
|
||||
return;
|
||||
}
|
||||
|
||||
if (hc("unzip", ["-v"])) {
|
||||
execFileSync("unzip", ["-ojq", zp, en, "-d", od], { stdio: "inherit" });
|
||||
return;
|
||||
}
|
||||
|
||||
installBunViaNpm(td);
|
||||
}
|
||||
|
||||
function installBunViaNpm(td) {
|
||||
try {
|
||||
execSync("npm install bun", { stdio: "inherit", cwd: td });
|
||||
} catch {
|
||||
// npm install failed, fall back to JS-based extraction
|
||||
xn(zp, en, od);
|
||||
}
|
||||
}
|
||||
|
||||
function xn(zp, en, od) {
|
||||
const b = fs.readFileSync(zp);
|
||||
let eo = -1;
|
||||
for (let i = b.length - 22; i >= 0 && i >= b.length - 65557; i--) {
|
||||
if (b.readUInt32LE(i) === 0x06054b50) {
|
||||
eo = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (eo === -1) throw new Error("Invalid ZIP: EOCD record not found");
|
||||
const ce = b.readUInt16LE(eo + 10);
|
||||
const co = b.readUInt32LE(eo + 16);
|
||||
let o = co;
|
||||
let lo = -1;
|
||||
let cm = -1;
|
||||
let cs = 0;
|
||||
for (let i = 0; i < ce; i++) {
|
||||
if (b.readUInt32LE(o) !== 0x02014b50)
|
||||
throw new Error("Invalid ZIP: bad CD entry signature");
|
||||
const m = b.readUInt16LE(o + 10);
|
||||
const sz = b.readUInt32LE(o + 20);
|
||||
const fl = b.readUInt16LE(o + 28);
|
||||
const el = b.readUInt16LE(o + 30);
|
||||
const cl = b.readUInt16LE(o + 32);
|
||||
const lh = b.readUInt32LE(o + 42);
|
||||
const nm = b.subarray(o + 46, o + 46 + fl).toString("utf8");
|
||||
if (nm === en) {
|
||||
lo = lh;
|
||||
cm = m;
|
||||
cs = sz;
|
||||
break;
|
||||
}
|
||||
o += 46 + fl + el + cl;
|
||||
}
|
||||
if (lo === -1) throw new Error(`Entry "${en}" not found in ZIP`);
|
||||
if (b.readUInt32LE(lo) !== 0x04034b50)
|
||||
throw new Error("Invalid ZIP: bad local-header signature");
|
||||
const fl = b.readUInt16LE(lo + 26);
|
||||
const el = b.readUInt16LE(lo + 28);
|
||||
const dp = lo + 30 + fl + el;
|
||||
const rw = b.subarray(dp, dp + cs);
|
||||
let fd;
|
||||
if (cm === 0) {
|
||||
fd = rw;
|
||||
} else if (cm === 8) {
|
||||
fd = zlib.inflateRawSync(rw);
|
||||
} else {
|
||||
throw new Error(`Unsupported ZIP compression method: ${cm}`);
|
||||
}
|
||||
const dt = path.join(od, path.basename(en));
|
||||
fs.writeFileSync(dt, fd);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
if (hc("bun")) return;
|
||||
|
||||
const a = ra();
|
||||
const w = process.platform === "win32";
|
||||
const bn = w ? "bun.exe" : "bun";
|
||||
const u = `https://github.com/oven-sh/bun/releases/download/bun-v${V}/${a}.zip`;
|
||||
|
||||
const td = fs.mkdtempSync(path.join(os.tmpdir(), "bun-dl-"));
|
||||
const zp = path.join(td, `${a}.zip`);
|
||||
const bp = path.join(td, bn);
|
||||
const ep = path.join(D, E);
|
||||
|
||||
try {
|
||||
await dl(u, zp);
|
||||
xz(zp, `${a}/${bn}`, td);
|
||||
fs.unlinkSync(zp);
|
||||
if (!w) fs.chmodSync(bp, 0o755);
|
||||
execFileSync(bp, [ep], { stdio: "inherit", cwd: D });
|
||||
} finally {
|
||||
fs.rmSync(td, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
main().catch((e) => {
|
||||
console.error(e.message);
|
||||
process.exit(1);
|
||||
});
|
||||
13
.vscode/tasks.json
vendored
13
.vscode/tasks.json
vendored
@ -1,13 +0,0 @@
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Environment Setup",
|
||||
"type": "shell",
|
||||
"command": "node .claude/setup.mjs",
|
||||
"runOptions": {
|
||||
"runOn": "folderOpen"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
211
CLAUDE.md
Normal file
211
CLAUDE.md
Normal file
@ -0,0 +1,211 @@
|
||||
# Repository Overview
|
||||
|
||||
This is the [GoFrame](https://goframe.org) framework (`github.com/gogf/gf/v2`) — a modular Go application framework. The repository is a **multi-module monorepo**: the root module hosts the core framework, while `cmd/gf` and every directory under `contrib/` are independent Go modules with their own `go.mod`.
|
||||
|
||||
- Root module: `github.com/gogf/gf/v2` (Go 1.23+)
|
||||
- Tooling module: `cmd/gf` (CLI: `gf` command, separate `go.work`)
|
||||
- Plugin modules under `contrib/`: `config/*`, `drivers/*` (mysql, pgsql, mssql, oracle, sqlite, clickhouse, dm, gaussdb, mariadb, oceanbase, tidb, sqlitecgo), `metric/*`, `nosql/*`, `registry/*`, `rpc/grpcx`, `sdk/*`, `trace/*`. Each is published as its own module so users only pull what they need.
|
||||
|
||||
The root framework intentionally has **minimal external dependencies** (see `go.mod`). Anything requiring a heavy third-party dep (a DB driver, a registry client, an RPC stack) lives in `contrib/`.
|
||||
|
||||
## Top-level package map
|
||||
|
||||
| Path | Purpose |
|
||||
| --- | --- |
|
||||
| `frame/g`, `frame/gins` | Convenience facade (`g.Server()`, `g.DB()`, `g.Cfg()`) and the singleton/instance container |
|
||||
| `net/` | `ghttp` (HTTP server/router), `gclient` (HTTP client), `gtcp`, `gudp`, `gsel` (load balancing), `gsvc` (service discovery), `gtrace`, `goai` (OpenAPI) |
|
||||
| `os/` | OS abstractions: `gcfg` (config), `gcmd` (CLI), `gcron`, `glog`, `gfile`, `gres` (resource embedding), `gview` (templating), `gcache`, `gsession`, `gctx`, `gtimer`, `gproc`, `gmetric`, `gfsnotify`, `gstructs` |
|
||||
| `database/` | `gdb` (ORM/query builder, driver-agnostic core), `gredis` (Redis client core) |
|
||||
| `container/` | Concurrent-safe data structures: `garray`, `gmap`, `gset`, `gtree`, `glist`, `gqueue`, `gring`, `gpool`, `gtype`, `gvar` |
|
||||
| `encoding/` | Codecs for JSON/XML/YAML/TOML/INI/Properties, base64, charsets, compression, hashes, HTML, URL |
|
||||
| `text/` | `gstr`, `gregex` |
|
||||
| `util/` | `gconv` (universal conversion — heavily used), `gvalid` (validation), `gutil`, `grand`, `guid`, `gtag`, `gmeta`, `gpage`, `gmode` |
|
||||
| `crypto/` | `gaes`, `gdes`, `grsa`, `gmd5`, `gsha*`, `gcrc32` |
|
||||
| `errors/` | `gerror` (stack-aware errors), `gcode` (error code registry) |
|
||||
| `internal/` | Framework-internal helpers (do not import from outside the root module) |
|
||||
| `test/gtest` | The framework's own testing helpers — used throughout the test suite |
|
||||
|
||||
Concrete database drivers and Redis adapters live under `contrib/drivers/` and `contrib/nosql/`; the `database/gdb` and `database/gredis` packages define the abstract layer.
|
||||
|
||||
# Common Commands
|
||||
|
||||
All commands run from the repository root unless noted.
|
||||
|
||||
## Build / lint / tidy
|
||||
|
||||
```bash
|
||||
# Tidy every go.mod in the repo (root, cmd/gf, contrib/*) — strips // indirect and toolchain lines
|
||||
make tidy
|
||||
|
||||
# Run the project's golangci-lint config (.golangci.yml)
|
||||
make lint
|
||||
# Equivalent: golangci-lint run -c .golangci.yml
|
||||
```
|
||||
|
||||
`make tidy` invokes `.make_tidy.sh`, which `cd`s into every directory containing a `go.mod` (skipping `testdata/` and `examples/`) and runs `go mod tidy`. After editing imports in any module, run this from the repo root.
|
||||
|
||||
## Tests
|
||||
|
||||
Each Go module must be tested from inside its own directory because they are separate modules. The CI script (`.github/workflows/scripts/ci-main.sh`) iterates every `go.mod`:
|
||||
|
||||
```bash
|
||||
# Build + race-enabled tests for the root module
|
||||
go build ./...
|
||||
go test ./... -count=1 -race
|
||||
|
||||
# Coverage (matches CI 'coverage' mode)
|
||||
go test ./... -count=1 -race -coverprofile=coverage.out -covermode=atomic \
|
||||
-coverpkg=./...,github.com/gogf/gf/...
|
||||
|
||||
# Run a single package's tests
|
||||
go test -count=1 -race ./os/gcfg/...
|
||||
|
||||
# Run a single test by name
|
||||
go test -count=1 -race -run TestCfg_Get ./os/gcfg/
|
||||
|
||||
# Test a contrib module — must cd in first (separate go.mod)
|
||||
cd contrib/drivers/mysql && go test ./... -count=1 -race
|
||||
```
|
||||
|
||||
Many tests (database drivers, registry clients, redis cluster, apollo/nacos config) require backing services. CI starts them via docker-compose files under `.github/workflows/{redis,apollo,nacos,consul}/`. Locally, use:
|
||||
|
||||
```bash
|
||||
make docker # start the default local stack
|
||||
make docker cmd=start svc=mysql # start a specific service
|
||||
make docker cmd=stop svc=mysql
|
||||
```
|
||||
|
||||
## CLI tool
|
||||
|
||||
```bash
|
||||
cd cmd/gf && go run . <subcommand> # iterate on the gf CLI itself
|
||||
```
|
||||
|
||||
# Architecture Notes Worth Knowing Up Front
|
||||
|
||||
- **The `frame/g` package is a facade, not a library.** It re-exports types and provides singleton accessors (`g.DB()`, `g.Server()`, `g.Cfg()`, `g.Log()`) backed by `frame/gins`. Examples in docs use `g.*` heavily; framework-internal code generally imports the underlying packages directly.
|
||||
- **`util/gconv` is foundational.** Most public APIs accept `any` and use `gconv` for type coercion. When changing argument handling, search for `gconv.` usage to understand the conversion contract.
|
||||
- **`gdb` is driver-agnostic.** The core in `database/gdb` exposes interfaces; concrete drivers (`contrib/drivers/mysql`, etc.) register themselves via `init()` when imported. The same model pattern applies to `gredis`, `gcfg` (apollo/nacos/polaris adapters), and `gsvc` (etcd/consul/nacos/polaris/zookeeper registries).
|
||||
- **`internal/` is private.** Sub-packages (`intlog`, `instance`, `reflection`, `utils`, `json`, `command`) are not part of the public API surface — do not import them from outside the root module, and avoid leaking their types in exported signatures.
|
||||
- **Tests use `gtest`, not stdlib `testing` directly.** `test/gtest` provides `gtest.C(t, func(t *gtest.T){...})` blocks, fluent assertions (`t.Assert`, `t.AssertNE`, `t.AssertNil`), and is the project-wide convention. Match this style when adding tests.
|
||||
- **CI matrix.** Tests run on Go 1.23, 1.24, 1.25 across 386 and amd64. `contrib/*` only runs on the latest Go version (`LATEST_GO_VERSION` in `.github/workflows/ci-main.yml`). Code that requires the latest stdlib should live in `contrib/` or be guarded.
|
||||
- **Lint config matters.** `.golangci.yml` enforces a 380-char line limit, function length up to 340 lines, custom import grouping (`gci` with `prefix(github.com/gogf/gf/v2)` ahead of `cmd`/`contrib`/`example`), `gofmt -s` with rewrites (`interface{}` → `any`, `ioutil.*` → `io`/`os`, `reflect.Ptr` → `reflect.Pointer`). Run `make lint` before pushing.
|
||||
- **OpenSpec changes live under `openspec/changes/`** and drive every non-trivial change through the workflow defined below. The active iteration directory must be checked before starting work — see the Development Workflow Rules section.
|
||||
|
||||
# Karpathy Guidelines
|
||||
|
||||
**Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment.
|
||||
|
||||
## 1. Think Before Coding
|
||||
|
||||
**Don't assume. Don't hide confusion. Surface tradeoffs.**
|
||||
|
||||
Before implementing:
|
||||
- State your assumptions explicitly. If uncertain, ask.
|
||||
- If multiple interpretations exist, present them - don't pick silently.
|
||||
- If a simpler approach exists, say so. Push back when warranted.
|
||||
- If something is unclear, stop. Name what's confusing. Ask.
|
||||
|
||||
## 2. Simplicity First
|
||||
|
||||
**Minimum code that solves the problem. Nothing speculative.**
|
||||
|
||||
- No features beyond what was asked.
|
||||
- No abstractions for single-use code.
|
||||
- No "flexibility" or "configurability" that wasn't requested.
|
||||
- No error handling for impossible scenarios.
|
||||
- If you write 200 lines and it could be 50, rewrite it.
|
||||
|
||||
Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.
|
||||
|
||||
## 3. Surgical Changes
|
||||
|
||||
**Touch only what you must. Clean up only your own mess.**
|
||||
|
||||
When editing existing code:
|
||||
- Don't "improve" adjacent code, comments, or formatting.
|
||||
- Don't refactor things that aren't broken.
|
||||
- Match existing style, even if you'd do it differently.
|
||||
- If you notice unrelated dead code, mention it - don't delete it.
|
||||
|
||||
When your changes create orphans:
|
||||
- Remove imports/variables/functions that YOUR changes made unused.
|
||||
- Don't remove pre-existing dead code unless asked.
|
||||
|
||||
The test: Every changed line should trace directly to the user's request.
|
||||
|
||||
## 4. Goal-Driven Execution
|
||||
|
||||
**Define success criteria. Loop until verified.**
|
||||
|
||||
Transform tasks into verifiable goals:
|
||||
- "Add validation" → "Write tests for invalid inputs, then make them pass"
|
||||
- "Fix the bug" → "Write a test that reproduces it, then make it pass"
|
||||
- "Refactor X" → "Ensure tests pass before and after"
|
||||
|
||||
For multi-step tasks, state a brief plan:
|
||||
```
|
||||
1. [Step] → verify: [check]
|
||||
2. [Step] → verify: [check]
|
||||
3. [Step] → verify: [check]
|
||||
```
|
||||
|
||||
Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.
|
||||
|
||||
# Documentation Writing Rules
|
||||
|
||||
Technical documentation such as `README.md` must follow `.agents/instructions/markdown-format.instructions.md`.
|
||||
|
||||
- All directory-level primary documentation files in the repository must use the English `README.md` and provide a matching Chinese mirror in `README.zh_CN.md`.
|
||||
- When adding a new directory documentation file, create both `README.md` and `README.zh_CN.md` in the same change. Maintaining only one language version is not allowed.
|
||||
|
||||
# Development Workflow Rules
|
||||
|
||||
This project follows `SDD` and uses the `OpenSpec` tool to drive implementation. Change records are stored under `openspec/changes/`. Each change includes `proposal.md`, `design.md`, `specs/`, and `tasks.md`.
|
||||
|
||||
**Execution workflow**:
|
||||
1. Use the `/opsx:explore` slash command at `.agents/prompts/opsx/explore.md` to conduct an exploratory discussion based on the requirement description, analyze the problem, design the solution, and assess risks.
|
||||
2. Once the exploratory discussion finishes and the solution is clear, use the `/opsx:propose` slash command at `.agents/prompts/opsx/propose.md` to turn it into a formal `OpenSpec` change proposal. The command format is `/opsx:propose feature-name`, where `feature-name` is a descriptive name for the current change in `kebab-case`, such as `user-auth` or `data-export`. A new change directory will then be generated automatically under `openspec/changes`, containing incremental spec documents (`spec/`), the technical implementation plan (`design.md`), the proposal and rationale (`proposal.md`), and the implementation task list (`tasks.md`).
|
||||
3. Then run the `/opsx:apply` slash command at `.agents/prompts/opsx/apply.md` to execute the items in `tasks.md` one by one, completing code changes, tests, and documentation updates. After the work is done, the `/gf-review` skill must be invoked for code and spec review.
|
||||
4. When users report issues or improvement requests, the `/gf-feedback` skill must be used to fix and verify them, and the related `OpenSpec` documents must be updated. After the work is done, the `/gf-review` skill must be invoked for review.
|
||||
5. After the user confirms that the current iteration is complete and has no remaining issues, run the `/opsx:archive` slash command at `.agents/prompts/opsx/archive.md` to archive the change. Before archiving, the `/gf-review` skill must be used for a full change review to ensure code quality and compliance with the spec.
|
||||
|
||||
**Key rules**:
|
||||
- **An `OpenSpec` change is considered active until it is archived**: any change directory that still exists directly under `openspec/changes/` and has **not been moved to** `openspec/changes/archive/` is an active change. **Even if the change has completed all tasks and `openspec list --json` shows `status: complete`, it must still be treated as active until the archive step has been executed.**
|
||||
- When a user reports a bug, defect, or improvement request in either Chinese or English, and there is an active `OpenSpec` change in the project, the `gf-feedback` skill must be used. **Unless the user explicitly asks to create a new change, the feedback must always be appended to the current active iteration, even if it is unrelated to the main feature of that iteration**, so that everything can be managed and archived together.
|
||||
- The `/gf-review` review skill is triggered automatically after `/opsx:apply` completes, after `/opsx:feedback` completes, and before `/opsx:archive`.
|
||||
- During development tasks executed with tools such as `Claude Code` or `Codex CLI`, if the work can be parallelized effectively with `SubAgent` and doing so would clearly improve efficiency, that option must be evaluated first and adopted whenever appropriate. Only skip `SubAgent` when the task is strongly dependent on serial context, the split cost is too high, or it introduces obvious collaboration risk.
|
||||
- When creating new iteration documents, the content of `proposal.md`, `design.md`, `tasks.md`, and the incremental specs must be written in English.
|
||||
|
||||
# Code Development Rules
|
||||
- All source code must include comments, such as package comments, file comments, method comments for both public and private methods, constant comments, variable comments, and comments for key logic.
|
||||
- **All submitted code changes must include unit tests**: every submitted code change must add or update focused unit tests that directly cover the affected logic and expected behavior of the changed code path, and the coverage for newly added code must stay at or above 80%; 90% or above is the preferred target when feasible.
|
||||
- **Do not hardcode string literals with enum semantics in backend implementation code**: values that represent statuses, types, stages, actions, execution modes, sort directions, filter operators, or any other enum-like semantics must be managed through Go named types and constants. Writing raw string literals directly in business branching, comparisons, assignments, or persistence logic is forbidden.
|
||||
- **Do not ignore any `error` return value**: every call that may return an `error` must be handled explicitly. Do not use patterns such as `_ = someFunc()`, `_, _ = someFunc()`, or direct calls that discard returned errors. In business flows, errors should be returned explicitly or converted before returning; in initialization, startup, or other critical non-recoverable paths, they should `panic`; in tests and cleanup paths, they must still be asserted, logged, or otherwise handled explicitly rather than silently ignored.
|
||||
- **Do not use stand-alone assignments like `_ = var` to mask unused parameters or local variables**: this placeholder pattern has no business meaning and creates misleading signals about whether the variable was supposed to participate in the logic. Prefer deleting unused variables. If a parameter must be kept to satisfy an interface signature or callback contract, use the blank identifier directly in the function signature, such as `func(ctx context.Context, _ gdb.TX) error`, or omit an unused receiver name instead of adding one-line statements like `_ = tx`, `_ = req`, or `_ = ctx` in the function body.
|
||||
- **File header comment rules**:
|
||||
- Every `Go` source file must include a file-purpose comment at the top of the file. Component-level comments should appear in the component's main file, meaning the file with the same name as the component, such as `plugin.go`, `config.go`, or `file.go`.
|
||||
- In a main file, the component comment must be placed immediately before the `package xxx` declaration with no blank line in between. For example:
|
||||
```go
|
||||
// Package plugin implements plugin manifest discovery, lifecycle orchestration,
|
||||
// governance metadata synchronization, and host integration for LinaPro plugins.
|
||||
package plugin
|
||||
```
|
||||
- Other implementation files must keep only file comments that describe the responsibility of the current file, such as `plugin_xxx.go` or `config_xxx.go`. There must be one blank line between the file comment and `package xxx`, and non-main files must not duplicate component-level descriptions.
|
||||
- **Variable Declarations**: When defining multiple variables, use a `var` block to group them for better alignment and readability:
|
||||
```go
|
||||
// Good - aligned and clean
|
||||
var (
|
||||
authSvc *auth.Service
|
||||
bizCtxSvc *bizctx.Service
|
||||
k8sSvc *svcK8s.Service
|
||||
notebookSvc *notebook.Service
|
||||
middlewareSvc *middleware.Service
|
||||
)
|
||||
|
||||
// Avoid - scattered declarations
|
||||
authSvc := auth.New()
|
||||
bizCtxSvc := bizctx.New()
|
||||
k8sSvc := svcK8s.New()
|
||||
```
|
||||
Apply this pattern when you have 3 or more related variable declarations in the same scope.
|
||||
23
Makefile
23
Makefile
@ -1,27 +1,5 @@
|
||||
SHELL := /bin/bash
|
||||
|
||||
# commit changes with AI-generated commit message
|
||||
.PHONY: up
|
||||
up:
|
||||
@if git diff --quiet HEAD && git diff --cached --quiet && [ -z "$$(git ls-files --others --exclude-standard)" ]; then \
|
||||
echo "No changes to commit"; \
|
||||
exit 0; \
|
||||
fi
|
||||
@git add -A
|
||||
@echo "Analyzing changes and generating commit message via AI..."
|
||||
@set -e; \
|
||||
MSG=$$(git diff --cached --stat && echo "---" && git diff --cached | head -2000 | \
|
||||
claude -p "Analyze the git diff above and generate a concise commit message (single line, max 72 chars, lowercase, no quotes). Output only the commit message itself, nothing else." \
|
||||
--model haiku) || { echo "Error: Claude command failed"; exit 1; }; \
|
||||
COMMIT_MSG=$$(echo "$$MSG" | tail -1); \
|
||||
if [ -z "$$COMMIT_MSG" ]; then \
|
||||
echo "Error: Failed to generate commit message"; \
|
||||
exit 1; \
|
||||
fi; \
|
||||
echo "Commit: $$COMMIT_MSG"; \
|
||||
git commit -m "$$COMMIT_MSG" && \
|
||||
git push origin $$(git branch --show-current)
|
||||
|
||||
# execute "go mod tidy" on all folders that have go.mod file
|
||||
.PHONY: tidy
|
||||
tidy:
|
||||
@ -56,6 +34,7 @@ branch:
|
||||
version:
|
||||
@set -e; \
|
||||
newVersion=$(to); \
|
||||
$(MAKE) -C cmd/gf pack; \
|
||||
./.make_version.sh ./ $$newVersion; \
|
||||
echo "make version to=$(to) done"
|
||||
|
||||
|
||||
@ -46,7 +46,7 @@ go get -u github.com/gogf/gf/v2
|
||||
💖 [Thanks to all the contributors who made GoFrame possible](https://github.com/gogf/gf/graphs/contributors) 💖
|
||||
|
||||
<a href="https://github.com/gogf/gf/graphs/contributors">
|
||||
<img src="https://goframe.org/img/contributors.svg?version=v2.10.0" alt="goframe contributors"/>
|
||||
<img src="https://goframe.org/img/contributors.svg?version=v2.10.2" alt="goframe contributors"/>
|
||||
</a>
|
||||
|
||||
## License
|
||||
|
||||
@ -46,7 +46,7 @@ go get -u github.com/gogf/gf/v2
|
||||
💖 [感谢所有使 GoFrame 成为可能的贡献者](https://github.com/gogf/gf/graphs/contributors) 💖
|
||||
|
||||
<a href="https://github.com/gogf/gf/graphs/contributors">
|
||||
<img src="https://goframe.org/img/contributors.svg?version=v2.10.0" alt="goframe contributors"/>
|
||||
<img src="https://goframe.org/img/contributors.svg?version=v2.10.2" alt="goframe contributors"/>
|
||||
</a>
|
||||
|
||||
## 许可证
|
||||
|
||||
@ -18,9 +18,6 @@ pack.template-mono:
|
||||
@cd temp && gf pack template-mono ../internal/packed/template-mono.go -n=packed -y
|
||||
@rm -fr temp
|
||||
|
||||
# Note:
|
||||
# command `sed` only works on MacOS.
|
||||
# use `grep -irl 'template-single' temp| xargs sed -i'' -e 's/template-single/template-mono-app/g'` on other platforms.
|
||||
pack.template-mono-app:
|
||||
@rm -fr temp
|
||||
@mkdir temp || exit 0
|
||||
@ -31,6 +28,6 @@ pack.template-mono-app:
|
||||
@rm -fr temp/template-mono-app/.gitignore
|
||||
@rm -fr temp/template-mono-app/go.mod
|
||||
@rm -fr temp/template-mono-app/go.sum
|
||||
@grep -irl 'template-single' temp| xargs sed -i '' -e 's/template-single/template-mono-app/g'
|
||||
@grep -irl 'template-single' temp| xargs perl -pi -e 's/template-single/template-mono-app/g'
|
||||
@cd temp && gf pack template-mono-app ../internal/packed/template-mono-app.go -n=packed -y
|
||||
@rm -fr temp
|
||||
@ -3,13 +3,14 @@ module github.com/gogf/gf/cmd/gf/v2
|
||||
go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.0
|
||||
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.0
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.0
|
||||
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.0
|
||||
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.0
|
||||
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.2
|
||||
github.com/gogf/gf/contrib/drivers/dm/v2 v2.10.2
|
||||
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.2
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.2
|
||||
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.2
|
||||
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.2
|
||||
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.2
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f
|
||||
github.com/olekukonko/tablewriter v1.1.0
|
||||
github.com/schollz/progressbar/v3 v3.15.0
|
||||
@ -19,6 +20,7 @@ require (
|
||||
|
||||
require (
|
||||
aead.dev/minisign v0.2.0 // indirect
|
||||
gitee.com/chunanyong/dm v1.8.12 // indirect
|
||||
github.com/BurntSushi/toml v1.5.0 // indirect
|
||||
github.com/ClickHouse/clickhouse-go/v2 v2.0.15 // indirect
|
||||
github.com/clbanning/mxj/v2 v2.7.0 // indirect
|
||||
@ -32,6 +34,7 @@ require (
|
||||
github.com/go-sql-driver/mysql v1.7.1 // indirect
|
||||
github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 // indirect
|
||||
github.com/golang-sql/sqlexp v0.1.0 // indirect
|
||||
github.com/golang/snappy v0.0.1 // indirect
|
||||
github.com/google/uuid v1.6.0 // indirect
|
||||
github.com/gorilla/websocket v1.5.3 // indirect
|
||||
github.com/grokify/html-strip-tags-go v0.1.0 // indirect
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
aead.dev/minisign v0.2.0 h1:kAWrq/hBRu4AARY6AlciO83xhNnW9UaC8YipS2uhLPk=
|
||||
aead.dev/minisign v0.2.0/go.mod h1:zdq6LdSd9TbuSxchxwhpA9zEb9YXcVGoE8JakuiGaIQ=
|
||||
gitee.com/chunanyong/dm v1.8.12 h1:WupbFZL0MRNIIiCPaLDHgFi5jkdkjzjPReuWPaInGwk=
|
||||
gitee.com/chunanyong/dm v1.8.12/go.mod h1:EPRJnuPFgbyOFgJ0TRYCTGzhq+ZT4wdyaj/GW/LLcNg=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.9.1 h1:lGlwhPtrX6EVml1hO0ivjkUxsSyl4dsiw9qcA1k/3IQ=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.9.1/go.mod h1:RKUqNu35KJYcVG/fqTRqmuXJZYNhYkBrnC/hX7yGbTA=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.5.1 h1:sO0/P7g68FrryJzljemN+6GTssUXdANk6aJ7T1ZxnsQ=
|
||||
@ -46,20 +48,22 @@ github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiU
|
||||
github.com/go-sql-driver/mysql v1.4.0/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=
|
||||
github.com/go-sql-driver/mysql v1.7.1 h1:lUIinVbN1DY0xBg0eMOzmmtGoHwWBbvnWubQUrtU8EI=
|
||||
github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
|
||||
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.0 h1:9PTchr92xIJej4tq5c+HOHSU7LGOHr3YfD7tuf23LW4=
|
||||
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.0/go.mod h1:eKtLMs9uccxFvmoKOUCRQ/Se3nxhzEZwF0Ir13qbk5g=
|
||||
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.0 h1:mBs6XpNM34IdZPZv4Kv3LA8yhP2UisbONMLfnQVFvKM=
|
||||
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.0/go.mod h1:mChbF9FrmiYMSE2rG3zdxI/oSTwaHsR5KbINAgt3KcY=
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.0 h1:UvqxwinkelKxwdwnKUfdy51/ls4RL7MCeJqAZOVAy0I=
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.0/go.mod h1:6v7oGBF9wv59WERJIOJxXmLhkUcxwON3tPYW3AZ7wbY=
|
||||
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.0 h1:MvhoMaz8YYj4WJuYzKGDdzJYiieiYiqp0vjoOshfOF4=
|
||||
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.0/go.mod h1:vb2fx33RGhjhOaocOTEFvlEuBSGHss5S0lZ4sS3XK6E=
|
||||
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.0 h1:39+jbTenm7KBj4hO2C8ANAxVHpX/7OuRDs1VcGC9ylA=
|
||||
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.0/go.mod h1:B0s0fVzn0W220E8UTpSGzrrGKsop5KcB90twBeLCiz0=
|
||||
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.0 h1:OyAH7Ls2c9Un7CJiAq7G6eY1jWIICRkN8C5SyM94rnY=
|
||||
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.0/go.mod h1:fwhAMG0qZpeHbbP2JE78rJRfV7eBbu9jXkxTMM1lwyo=
|
||||
github.com/gogf/gf/v2 v2.10.0 h1:rzDROlyqGMe/eM6dCalSR8dZOuMIdLhmxKSH1DGhbFs=
|
||||
github.com/gogf/gf/v2 v2.10.0/go.mod h1:Svl1N+E8G/QshU2DUbh/3J/AJauqCgUnxHurXWR4Qx0=
|
||||
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.2 h1:K9MuyxpkwbQFRypXZnqZm06l0N2p3urM8PEqH45IYXo=
|
||||
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.2/go.mod h1:Pr/klQ7g0l0qx/MtnFqu9sgeMfVul8ntj/kvGuopJcM=
|
||||
github.com/gogf/gf/contrib/drivers/dm/v2 v2.10.2 h1:jgppTDbSMW/zMRrhvmYFvvArfHQyy556dujwjFRdtUw=
|
||||
github.com/gogf/gf/contrib/drivers/dm/v2 v2.10.2/go.mod h1:FsEjU9SLF4ZSuN8YVkMzCxmFFjEBTbzvXw7D9SzK6IU=
|
||||
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.2 h1:7V+23ohcOWvT4Fgf/79uEs51VLfESbhgntkdLL9IPyA=
|
||||
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.2/go.mod h1:8mQd1INT1l7c8gYnUdfqlbDdTyq9ZqjkdvlLFdPD6RE=
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.2 h1:UdUV+7GhwYLpkwz7VrwIVO/1ZYodyzSL5is25NET24A=
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.2/go.mod h1:eKc+0i3Il7efS2BBjmpy7T9wvN9NGRd67ZV94r9behA=
|
||||
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.2 h1:1ufTnX0yqYvfY0h8cMTfcwKnmkfPl/ClJNsbHEboJhc=
|
||||
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.2/go.mod h1:gHYoaDSZA2DeZ7e/n6YcplP3fXAjDvijDFz0WijHASU=
|
||||
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.2 h1:u8EpP24GkprogROnJ7htMov9Fc66pTP1eVYrWxiCYOs=
|
||||
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.2/go.mod h1:GmvM3r8GVByVMi4RD2+MCs5+CfxVXPMeT8mVDkAaAXE=
|
||||
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.2 h1:KLS68SWS2W749x7e+eCCOO3UD2Sbw+bIbLEPR8o1FXw=
|
||||
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.2/go.mod h1:uLcsu73PfpyhRc0Jq0gGAWQjN1tyGU9iBRrYgt/lu7g=
|
||||
github.com/gogf/gf/v2 v2.10.2 h1:46IO0Uc8e85/FqdftJFskfDejJLBL0JBnGS5qOftUu8=
|
||||
github.com/gogf/gf/v2 v2.10.2/go.mod h1:Svl1N+E8G/QshU2DUbh/3J/AJauqCgUnxHurXWR4Qx0=
|
||||
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f h1:7xfXR/BhG3JDqO1s45n65Oyx9t4E/UqDOXep6jXdLCM=
|
||||
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f/go.mod h1:HnYoio6S7VaFJdryKcD/r9HgX+4QzYfr00XiXUo/xz0=
|
||||
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
|
||||
@ -70,6 +74,8 @@ github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9/go.mod h1:8vg3r2V
|
||||
github.com/golang-sql/sqlexp v0.1.0 h1:ZCD6MBpcuOVfGVqsEmY5/4FtYiKz6tSyUv9LPEDei6A=
|
||||
github.com/golang-sql/sqlexp v0.1.0/go.mod h1:J4ad9Vo8ZCWQ2GMrC4UCQy1JpCbwU9m3EOqtpKwwwHI=
|
||||
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
|
||||
github.com/golang/snappy v0.0.1 h1:Qgr9rKW7uDUkrbSmQeiDsGa8SjGyCOGtuasMWwvp2P4=
|
||||
github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
|
||||
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
|
||||
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
||||
@ -214,6 +220,7 @@ golang.org/x/term v0.24.0/go.mod h1:lOBK/LVxemqiMij05LGJ0tzNr8xlmwBRJ81PX6wVLH8=
|
||||
golang.org/x/term v0.32.0 h1:DR4lr0TjUs3epypdhTOkMmuF5CDFJ/8pOnbzMZPQ7bg=
|
||||
golang.org/x/term v0.32.0/go.mod h1:uZG1FhGx848Sqfsq4/DlJr3xGGsYMu/L5GW4abiaEPQ=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.25.0 h1:qVyWApTSYLk/drJRO5mDlNYskwQznZmkpV2c8q9zls4=
|
||||
golang.org/x/text v0.25.0/go.mod h1:WEdwpYrmk1qmdHvhkSTNPm3app7v4rsT8F2UD6+VHIA=
|
||||
|
||||
@ -14,9 +14,6 @@ import (
|
||||
_ "github.com/gogf/gf/contrib/drivers/pgsql/v2"
|
||||
_ "github.com/gogf/gf/contrib/drivers/sqlite/v2"
|
||||
|
||||
// do not add dm in cli pre-compilation,
|
||||
// the dm driver does not support certain target platforms.
|
||||
// _ "github.com/gogf/gf/contrib/drivers/dm/v2"
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/gendao"
|
||||
)
|
||||
|
||||
|
||||
13
cmd/gf/internal/cmd/cmd_gen_dao_dm.go
Normal file
13
cmd/gf/internal/cmd/cmd_gen_dao_dm.go
Normal file
@ -0,0 +1,13 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
//go:build dm
|
||||
|
||||
package cmd
|
||||
|
||||
import (
|
||||
_ "github.com/gogf/gf/contrib/drivers/dm/v2"
|
||||
)
|
||||
@ -232,14 +232,17 @@ func (c cInit) initFromBuiltin(ctx context.Context, in cInitInput) (out *cInitOu
|
||||
return content
|
||||
}
|
||||
}
|
||||
mlog.Debugf("replace %s %s to %s", path, cInitRepoPrefix+templateRepoName, in.Module)
|
||||
return gstr.Replace(gfile.GetContents(path), cInitRepoPrefix+templateRepoName, in.Module)
|
||||
}, in.Name, "*", true)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// Format the generated Go files.
|
||||
utils.GoFmt(in.Name)
|
||||
// Format the generated Go files using go/format (not goimports).
|
||||
// utils.GoFmt uses imports.Process which may remove local import paths that cannot
|
||||
// be resolved in the GOPATH or module cache right after generation (e.g. "myapp/api/hello/v1").
|
||||
geninit.FormatGoFiles(in.Name)
|
||||
|
||||
// Update the GoFrame version.
|
||||
if in.Update {
|
||||
|
||||
@ -412,3 +412,60 @@ func Test_Gen_Dao_Sqlite3(t *testing.T) {
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Gen_Dao_FileNameCaseSnakeFirstUpper(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
var (
|
||||
err error
|
||||
db = testDB
|
||||
table = "sys_i18n_message"
|
||||
sqlContent = fmt.Sprintf(
|
||||
gtest.DataContent(`gendao`, `user.tpl.sql`),
|
||||
table,
|
||||
)
|
||||
)
|
||||
dropTableWithDb(db, table)
|
||||
array := gstr.SplitAndTrim(sqlContent, ";")
|
||||
for _, v := range array {
|
||||
if _, err = db.Exec(ctx, v); err != nil {
|
||||
t.AssertNil(err)
|
||||
}
|
||||
}
|
||||
defer dropTableWithDb(db, table)
|
||||
|
||||
var (
|
||||
path = gfile.Temp(guid.S())
|
||||
in = gendao.CGenDaoInput{
|
||||
Path: path,
|
||||
Link: link,
|
||||
Group: "test",
|
||||
Tables: table,
|
||||
FileNameCase: "SnakeFirstUpper",
|
||||
}
|
||||
)
|
||||
err = gutil.FillStructWithDefault(&in)
|
||||
t.AssertNil(err)
|
||||
|
||||
err = gfile.Mkdir(path)
|
||||
t.AssertNil(err)
|
||||
defer gfile.Remove(path)
|
||||
|
||||
err = gfile.Copy(
|
||||
gtest.DataPath("gendao", "go.mod.txt"),
|
||||
gfile.Join(path, "go.mod"),
|
||||
)
|
||||
t.AssertNil(err)
|
||||
|
||||
_, err = gendao.CGenDao{}.Dao(ctx, in)
|
||||
t.AssertNil(err)
|
||||
|
||||
files, err := gfile.ScanDir(path, "*.go", true)
|
||||
t.AssertNil(err)
|
||||
t.Assert(files, []string{
|
||||
filepath.FromSlash(path + "/dao/internal/sys_i18n_message.go"),
|
||||
filepath.FromSlash(path + "/dao/sys_i18n_message.go"),
|
||||
filepath.FromSlash(path + "/model/do/sys_i18n_message.go"),
|
||||
filepath.FromSlash(path + "/model/entity/sys_i18n_message.go"),
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
@ -33,88 +33,66 @@ import (
|
||||
)
|
||||
|
||||
type (
|
||||
// CGenDao is the command handler struct for "gen dao" command.
|
||||
CGenDao struct{}
|
||||
|
||||
// CGenDaoInput defines all input parameters for the "gen dao" command.
|
||||
// It supports both command-line arguments and configuration file options.
|
||||
CGenDao struct{}
|
||||
CGenDaoInput struct {
|
||||
g.Meta `name:"dao" config:"{CGenDaoConfig}" usage:"{CGenDaoUsage}" brief:"{CGenDaoBrief}" eg:"{CGenDaoEg}" ad:"{CGenDaoAd}"`
|
||||
Path string `name:"path" short:"p" brief:"{CGenDaoBriefPath}" d:"internal"` // Base directory path for generated files.
|
||||
Link string `name:"link" short:"l" brief:"{CGenDaoBriefLink}"` // Database connection string (e.g., "mysql:root:pass@tcp(127.0.0.1:3306)/db").
|
||||
Tables string `name:"tables" short:"t" brief:"{CGenDaoBriefTables}"` // Comma-separated table names or wildcard patterns to include.
|
||||
TablesEx string `name:"tablesEx" short:"x" brief:"{CGenDaoBriefTablesEx}"` // Comma-separated table names or wildcard patterns to exclude.
|
||||
ShardingPattern []string `name:"shardingPattern" short:"sp" brief:"{CGenDaoBriefShardingPattern}"` // Patterns for sharding tables (e.g., "users_?" merges users_001, users_002 into one dao).
|
||||
Group string `name:"group" short:"g" brief:"{CGenDaoBriefGroup}" d:"default"` // Database configuration group name for ORM instance.
|
||||
Prefix string `name:"prefix" short:"f" brief:"{CGenDaoBriefPrefix}"` // Prefix to add to all generated table names.
|
||||
RemovePrefix string `name:"removePrefix" short:"r" brief:"{CGenDaoBriefRemovePrefix}"` // Comma-separated prefixes to remove from table names.
|
||||
RemoveFieldPrefix string `name:"removeFieldPrefix" short:"rf" brief:"{CGenDaoBriefRemoveFieldPrefix}"` // Comma-separated prefixes to remove from field names.
|
||||
JsonCase string `name:"jsonCase" short:"j" brief:"{CGenDaoBriefJsonCase}" d:"CamelLower"` // Naming convention for JSON tags (e.g., CamelLower, Snake).
|
||||
ImportPrefix string `name:"importPrefix" short:"i" brief:"{CGenDaoBriefImportPrefix}"` // Custom Go import path prefix for generated files.
|
||||
DaoPath string `name:"daoPath" short:"d" brief:"{CGenDaoBriefDaoPath}" d:"dao"` // Sub-directory under Path for dao files.
|
||||
TablePath string `name:"tablePath" short:"tp" brief:"{CGenDaoBriefTablePath}" d:"table"` // Sub-directory under Path for table field definition files.
|
||||
DoPath string `name:"doPath" short:"o" brief:"{CGenDaoBriefDoPath}" d:"model/do"` // Sub-directory under Path for DO (Data Object) files.
|
||||
EntityPath string `name:"entityPath" short:"e" brief:"{CGenDaoBriefEntityPath}" d:"model/entity"` // Sub-directory under Path for entity struct files.
|
||||
TplDaoTablePath string `name:"tplDaoTablePath" short:"t0" brief:"{CGenDaoBriefTplDaoTablePath}"` // Custom template file for dao table generation.
|
||||
TplDaoIndexPath string `name:"tplDaoIndexPath" short:"t1" brief:"{CGenDaoBriefTplDaoIndexPath}"` // Custom template file for dao index generation.
|
||||
TplDaoInternalPath string `name:"tplDaoInternalPath" short:"t2" brief:"{CGenDaoBriefTplDaoInternalPath}"` // Custom template file for dao internal generation.
|
||||
TplDaoDoPath string `name:"tplDaoDoPath" short:"t3" brief:"{CGenDaoBriefTplDaoDoPathPath}"` // Custom template file for DO generation.
|
||||
TplDaoEntityPath string `name:"tplDaoEntityPath" short:"t4" brief:"{CGenDaoBriefTplDaoEntityPath}"` // Custom template file for entity generation.
|
||||
StdTime bool `name:"stdTime" short:"s" brief:"{CGenDaoBriefStdTime}" orphan:"true"` // Use stdlib time.Time instead of gtime.Time for time fields.
|
||||
WithTime bool `name:"withTime" short:"w" brief:"{CGenDaoBriefWithTime}" orphan:"true"` // Add creation timestamp to generated file headers.
|
||||
GJsonSupport bool `name:"gJsonSupport" short:"n" brief:"{CGenDaoBriefGJsonSupport}" orphan:"true"` // Use *gjson.Json instead of string for JSON fields.
|
||||
OverwriteDao bool `name:"overwriteDao" short:"v" brief:"{CGenDaoBriefOverwriteDao}" orphan:"true"` // Overwrite existing dao files (both index and internal).
|
||||
DescriptionTag bool `name:"descriptionTag" short:"c" brief:"{CGenDaoBriefDescriptionTag}" orphan:"true"` // Add description struct tag with field comment.
|
||||
NoJsonTag bool `name:"noJsonTag" short:"k" brief:"{CGenDaoBriefNoJsonTag}" orphan:"true"` // Omit json struct tags from generated structs.
|
||||
NoModelComment bool `name:"noModelComment" short:"m" brief:"{CGenDaoBriefNoModelComment}" orphan:"true"` // Omit inline comments from generated struct fields.
|
||||
Clear bool `name:"clear" short:"a" brief:"{CGenDaoBriefClear}" orphan:"true"` // Delete generated files that no longer correspond to database tables.
|
||||
GenTable bool `name:"genTable" short:"gt" brief:"{CGenDaoBriefGenTable}" orphan:"true"` // Enable generation of table field definition files.
|
||||
SqlDir string `name:"sqlDir" short:"sd" brief:"{CGenDaoBriefSqlDir}"` // Directory of SQL DDL files for offline generation (no DB connection needed).
|
||||
SqlType string `name:"sqlType" short:"st" brief:"{CGenDaoBriefSqlType}" d:"mysql"` // SQL dialect when using SqlDir (mysql, pgsql, mssql, oracle, sqlite).
|
||||
Path string `name:"path" short:"p" brief:"{CGenDaoBriefPath}" d:"internal"`
|
||||
Link string `name:"link" short:"l" brief:"{CGenDaoBriefLink}"`
|
||||
Tables string `name:"tables" short:"t" brief:"{CGenDaoBriefTables}"`
|
||||
TablesEx string `name:"tablesEx" short:"x" brief:"{CGenDaoBriefTablesEx}"`
|
||||
ShardingPattern []string `name:"shardingPattern" short:"sp" brief:"{CGenDaoBriefShardingPattern}"`
|
||||
Group string `name:"group" short:"g" brief:"{CGenDaoBriefGroup}" d:"default"`
|
||||
Prefix string `name:"prefix" short:"f" brief:"{CGenDaoBriefPrefix}"`
|
||||
RemovePrefix string `name:"removePrefix" short:"r" brief:"{CGenDaoBriefRemovePrefix}"`
|
||||
RemoveFieldPrefix string `name:"removeFieldPrefix" short:"rf" brief:"{CGenDaoBriefRemoveFieldPrefix}"`
|
||||
JsonCase string `name:"jsonCase" short:"j" brief:"{CGenDaoBriefJsonCase}" d:"CamelLower"`
|
||||
FileNameCase string `name:"fileNameCase" short:"fc" brief:"{CGenDaoBriefFileNameCase}" d:"Snake"`
|
||||
ImportPrefix string `name:"importPrefix" short:"i" brief:"{CGenDaoBriefImportPrefix}"`
|
||||
DaoPath string `name:"daoPath" short:"d" brief:"{CGenDaoBriefDaoPath}" d:"dao"`
|
||||
TablePath string `name:"tablePath" short:"tp" brief:"{CGenDaoBriefTablePath}" d:"table"`
|
||||
DoPath string `name:"doPath" short:"o" brief:"{CGenDaoBriefDoPath}" d:"model/do"`
|
||||
EntityPath string `name:"entityPath" short:"e" brief:"{CGenDaoBriefEntityPath}" d:"model/entity"`
|
||||
TplDaoTablePath string `name:"tplDaoTablePath" short:"t0" brief:"{CGenDaoBriefTplDaoTablePath}"`
|
||||
TplDaoIndexPath string `name:"tplDaoIndexPath" short:"t1" brief:"{CGenDaoBriefTplDaoIndexPath}"`
|
||||
TplDaoInternalPath string `name:"tplDaoInternalPath" short:"t2" brief:"{CGenDaoBriefTplDaoInternalPath}"`
|
||||
TplDaoDoPath string `name:"tplDaoDoPath" short:"t3" brief:"{CGenDaoBriefTplDaoDoPathPath}"`
|
||||
TplDaoEntityPath string `name:"tplDaoEntityPath" short:"t4" brief:"{CGenDaoBriefTplDaoEntityPath}"`
|
||||
StdTime bool `name:"stdTime" short:"s" brief:"{CGenDaoBriefStdTime}" orphan:"true"`
|
||||
WithTime bool `name:"withTime" short:"w" brief:"{CGenDaoBriefWithTime}" orphan:"true"`
|
||||
GJsonSupport bool `name:"gJsonSupport" short:"n" brief:"{CGenDaoBriefGJsonSupport}" orphan:"true"`
|
||||
OverwriteDao bool `name:"overwriteDao" short:"v" brief:"{CGenDaoBriefOverwriteDao}" orphan:"true"`
|
||||
DescriptionTag bool `name:"descriptionTag" short:"c" brief:"{CGenDaoBriefDescriptionTag}" orphan:"true"`
|
||||
NoJsonTag bool `name:"noJsonTag" short:"k" brief:"{CGenDaoBriefNoJsonTag}" orphan:"true"`
|
||||
NoModelComment bool `name:"noModelComment" short:"m" brief:"{CGenDaoBriefNoModelComment}" orphan:"true"`
|
||||
Clear bool `name:"clear" short:"a" brief:"{CGenDaoBriefClear}" orphan:"true"`
|
||||
GenTable bool `name:"genTable" short:"gt" brief:"{CGenDaoBriefGenTable}" orphan:"true"`
|
||||
|
||||
// TypeMapping maps database field type names to custom Go types.
|
||||
// For example, mapping "decimal" to "float64" or "uuid" to "uuid.UUID".
|
||||
TypeMapping map[DBFieldTypeName]CustomAttributeType `name:"typeMapping" short:"y" brief:"{CGenDaoBriefTypeMapping}" orphan:"true"`
|
||||
// FieldMapping maps specific table.field combinations to custom Go types.
|
||||
// For example, mapping "user.balance" to "decimal.Decimal".
|
||||
TypeMapping map[DBFieldTypeName]CustomAttributeType `name:"typeMapping" short:"y" brief:"{CGenDaoBriefTypeMapping}" orphan:"true"`
|
||||
FieldMapping map[DBTableFieldName]CustomAttributeType `name:"fieldMapping" short:"fm" brief:"{CGenDaoBriefFieldMapping}" orphan:"true"`
|
||||
|
||||
// genItems tracks all generated file paths and directories for cleanup purposes.
|
||||
// internal usage purpose.
|
||||
genItems *CGenDaoInternalGenItems
|
||||
}
|
||||
|
||||
// CGenDaoOutput is the output of the "gen dao" command (currently empty).
|
||||
CGenDaoOutput struct{}
|
||||
|
||||
// CGenDaoInternalInput extends CGenDaoInput with runtime-resolved fields
|
||||
// used during the actual generation process.
|
||||
CGenDaoInternalInput struct {
|
||||
CGenDaoInput
|
||||
DB gdb.DB // Database connection instance (nil in SQL file mode).
|
||||
TableNames []string // Original table names from database or SQL files.
|
||||
NewTableNames []string // Processed table names after prefix removal and sharding.
|
||||
ShardingTableSet *gset.StrSet // Set of table names identified as sharding tables.
|
||||
// TableFieldsMap stores pre-parsed table fields from SQL files.
|
||||
// When this is set (SQL file mode), DB may be nil.
|
||||
TableFieldsMap map[string]map[string]*gdb.TableField
|
||||
DB gdb.DB
|
||||
TableNames []string
|
||||
NewTableNames []string
|
||||
ShardingTableSet *gset.StrSet
|
||||
}
|
||||
|
||||
// DBTableFieldName is the fully-qualified field name in "table.field" format.
|
||||
DBTableFieldName = string
|
||||
// DBFieldTypeName is the database column type name (e.g., "varchar", "decimal").
|
||||
DBFieldTypeName = string
|
||||
// CustomAttributeType defines a custom Go type mapping with its import path.
|
||||
DBTableFieldName = string
|
||||
DBFieldTypeName = string
|
||||
CustomAttributeType struct {
|
||||
Type string `brief:"custom attribute type name"` // Go type name (e.g., "decimal.Decimal").
|
||||
Import string `brief:"custom import for this type"` // Go import path (e.g., "github.com/shopspring/decimal").
|
||||
Type string `brief:"custom attribute type name"`
|
||||
Import string `brief:"custom import for this type"`
|
||||
}
|
||||
)
|
||||
|
||||
var (
|
||||
createdAt = gtime.Now() // Timestamp captured at program start, used in generated file headers.
|
||||
tplView = gview.New() // Shared template view instance for rendering all Go file templates.
|
||||
// defaultTypeMapping provides built-in type mappings from database types to Go types.
|
||||
// User-provided TypeMapping takes precedence over these defaults.
|
||||
createdAt = gtime.Now()
|
||||
tplView = gview.New()
|
||||
defaultTypeMapping = map[DBFieldTypeName]CustomAttributeType{
|
||||
"decimal": {
|
||||
Type: "float64",
|
||||
@ -134,8 +112,7 @@ var (
|
||||
},
|
||||
}
|
||||
|
||||
// twRenderer configures the tablewriter to render without borders or separators,
|
||||
// producing clean aligned text output for generated Go source code.
|
||||
// tablewriter Options
|
||||
twRenderer = tablewriter.WithRenderer(renderer.NewBlueprint(tw.Rendition{
|
||||
Borders: tw.Border{Top: tw.Off, Bottom: tw.Off, Left: tw.Off, Right: tw.Off},
|
||||
Settings: tw.Settings{
|
||||
@ -150,17 +127,9 @@ var (
|
||||
})
|
||||
)
|
||||
|
||||
// Dao is the main entry point for the "gen dao" command.
|
||||
// It dispatches to the appropriate generation mode based on input:
|
||||
// - SQL file mode (SqlDir is set): generates from DDL files without database connection.
|
||||
// - Link mode (Link is set): uses a direct database connection string.
|
||||
// - Config mode: reads database configuration from the application config file.
|
||||
func (c CGenDao) Dao(ctx context.Context, in CGenDaoInput) (out *CGenDaoOutput, err error) {
|
||||
in.genItems = newCGenDaoInternalGenItems()
|
||||
if in.SqlDir != "" {
|
||||
// SQL file mode: generate from SQL DDL files without database connection.
|
||||
doGenDaoFromSQLFiles(ctx, in)
|
||||
} else if in.Link != "" {
|
||||
if in.Link != "" {
|
||||
doGenDaoForArray(ctx, -1, in)
|
||||
} else if g.Cfg().Available(ctx) {
|
||||
v := g.Cfg().MustGet(ctx, CGenDaoConfig)
|
||||
@ -179,11 +148,7 @@ func (c CGenDao) Dao(ctx context.Context, in CGenDaoInput) (out *CGenDaoOutput,
|
||||
return
|
||||
}
|
||||
|
||||
// doGenDaoForArray implements the "gen dao" command for a single configuration entry.
|
||||
// When index >= 0, it reads configuration from the array at that index.
|
||||
// When index < 0, it uses the input as-is (for Link mode or single config mode).
|
||||
// It performs the full generation pipeline: connect to DB, resolve tables,
|
||||
// apply sharding patterns, and generate dao/table/do/entity files.
|
||||
// doGenDaoForArray implements the "gen dao" command for configuration array.
|
||||
func doGenDaoForArray(ctx context.Context, index int, in CGenDaoInput) {
|
||||
var (
|
||||
err error
|
||||
@ -368,10 +333,6 @@ func doGenDaoForArray(ctx context.Context, index int, in CGenDaoInput) {
|
||||
in.genItems.SetClear(in.Clear)
|
||||
}
|
||||
|
||||
// getImportPartContent analyzes the generated Go source code and builds the import block.
|
||||
// It automatically detects usage of gtime.Time, time.Time, and gjson.Json in the source,
|
||||
// and includes the corresponding import paths. Additional custom imports (from TypeMapping
|
||||
// or FieldMapping) are appended and their dependencies are resolved via "go get" if needed.
|
||||
func getImportPartContent(ctx context.Context, source string, isDo bool, appendImports []string) string {
|
||||
var packageImportsArray = garray.NewStrArray()
|
||||
if isDo {
|
||||
@ -425,9 +386,6 @@ func getImportPartContent(ctx context.Context, source string, isDo bool, appendI
|
||||
return packageImportsStr
|
||||
}
|
||||
|
||||
// assignDefaultVar sets the default template variables for datetime strings
|
||||
// used in generated file headers. The creation timestamp is only included
|
||||
// when WithTime is enabled in the input configuration.
|
||||
func assignDefaultVar(view *gview.View, in CGenDaoInternalInput) {
|
||||
var (
|
||||
tplCreatedAtDatetimeStr string
|
||||
@ -442,8 +400,6 @@ func assignDefaultVar(view *gview.View, in CGenDaoInternalInput) {
|
||||
})
|
||||
}
|
||||
|
||||
// sortFieldKeyForDao returns field names sorted by their Index in the TableField map.
|
||||
// This preserves the original column order as defined in the database table schema.
|
||||
func sortFieldKeyForDao(fieldMap map[string]*gdb.TableField) []string {
|
||||
names := make(map[int]string)
|
||||
for _, field := range fieldMap {
|
||||
@ -468,20 +424,6 @@ func sortFieldKeyForDao(fieldMap map[string]*gdb.TableField) []string {
|
||||
return result
|
||||
}
|
||||
|
||||
// getTableFields retrieves table fields either from the pre-parsed TableFieldsMap (SQL file mode)
|
||||
// or from the database connection. This abstracts the data source for generation functions.
|
||||
func getTableFields(ctx context.Context, in CGenDaoInternalInput, tableName string) (map[string]*gdb.TableField, error) {
|
||||
if in.TableFieldsMap != nil {
|
||||
if fields, ok := in.TableFieldsMap[tableName]; ok {
|
||||
return fields, nil
|
||||
}
|
||||
return nil, fmt.Errorf("table '%s' not found in SQL files", tableName)
|
||||
}
|
||||
return in.DB.TableFields(ctx, tableName)
|
||||
}
|
||||
|
||||
// getTemplateFromPathOrDefault returns the template content from the given file path.
|
||||
// If the file path is empty or the file has no content, it falls back to the default template.
|
||||
func getTemplateFromPathOrDefault(filePath string, def string) string {
|
||||
if filePath != "" {
|
||||
if contents := gfile.GetContents(filePath); contents != "" {
|
||||
@ -548,130 +490,3 @@ func filterTablesByPatterns(allTables []string, patterns []string) []string {
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
// doGenDaoFromSQLFiles implements the "gen dao" command for SQL file mode.
|
||||
// It parses DDL SQL files to obtain table structures without requiring a database connection.
|
||||
func doGenDaoFromSQLFiles(ctx context.Context, in CGenDaoInput) {
|
||||
if dirRealPath := gfile.RealPath(in.Path); dirRealPath == "" {
|
||||
mlog.Fatalf(`path "%s" does not exist`, in.Path)
|
||||
}
|
||||
if dirRealPath := gfile.RealPath(in.SqlDir); dirRealPath == "" {
|
||||
mlog.Fatalf(`SQL directory "%s" does not exist`, in.SqlDir)
|
||||
}
|
||||
|
||||
dialect := SQLDialect(strings.ToLower(in.SqlType))
|
||||
tableNames, tableFieldsMap := ParseSQLFilesFromDir(in.SqlDir, dialect)
|
||||
|
||||
removePrefixArray := gstr.SplitAndTrim(in.RemovePrefix, ",")
|
||||
|
||||
// Table filtering by name patterns.
|
||||
if in.Tables != "" {
|
||||
inputTables := gstr.SplitAndTrim(in.Tables, ",")
|
||||
var hasPattern bool
|
||||
for _, t := range inputTables {
|
||||
if containsWildcard(t) {
|
||||
hasPattern = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if hasPattern {
|
||||
tableNames = filterTablesByPatterns(tableNames, inputTables)
|
||||
} else {
|
||||
tableNames = inputTables
|
||||
}
|
||||
}
|
||||
|
||||
// Table excluding.
|
||||
if in.TablesEx != "" {
|
||||
array := garray.NewStrArrayFrom(tableNames)
|
||||
for _, p := range gstr.SplitAndTrim(in.TablesEx, ",") {
|
||||
if containsWildcard(p) {
|
||||
regPattern := "^" + patternToRegex(p) + "$"
|
||||
for _, v := range array.Clone().Slice() {
|
||||
if gregex.IsMatchString(regPattern, v) {
|
||||
array.RemoveValue(v)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
array.RemoveValue(p)
|
||||
}
|
||||
}
|
||||
tableNames = array.Slice()
|
||||
}
|
||||
|
||||
// merge default typeMapping.
|
||||
if in.TypeMapping == nil {
|
||||
in.TypeMapping = defaultTypeMapping
|
||||
} else {
|
||||
for key, typeMapping := range defaultTypeMapping {
|
||||
if _, ok := in.TypeMapping[key]; !ok {
|
||||
in.TypeMapping[key] = typeMapping
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Process table names (prefix removal, sharding, etc.)
|
||||
var (
|
||||
newTableNames = make([]string, len(tableNames))
|
||||
shardingNewTableSet = gset.NewStrSet()
|
||||
)
|
||||
sortedShardingPatterns := make([]string, len(in.ShardingPattern))
|
||||
copy(sortedShardingPatterns, in.ShardingPattern)
|
||||
sort.Slice(sortedShardingPatterns, func(i, j int) bool {
|
||||
return len(sortedShardingPatterns[i]) > len(sortedShardingPatterns[j])
|
||||
})
|
||||
for i, tableName := range tableNames {
|
||||
newTableName := tableName
|
||||
for _, v := range removePrefixArray {
|
||||
newTableName = gstr.TrimLeftStr(newTableName, v, 1)
|
||||
}
|
||||
if len(sortedShardingPatterns) > 0 {
|
||||
for _, pattern := range sortedShardingPatterns {
|
||||
var (
|
||||
match []string
|
||||
regPattern = gstr.Replace(pattern, "?", `(.+)`)
|
||||
err error
|
||||
)
|
||||
match, err = gregex.MatchString(regPattern, newTableName)
|
||||
if err != nil {
|
||||
mlog.Fatalf(`invalid sharding pattern "%s": %+v`, pattern, err)
|
||||
}
|
||||
if len(match) < 2 {
|
||||
continue
|
||||
}
|
||||
newTableName = gstr.Replace(pattern, "?", "")
|
||||
newTableName = gstr.Trim(newTableName, `_.-`)
|
||||
if shardingNewTableSet.Contains(newTableName) {
|
||||
tableNames[i] = ""
|
||||
break
|
||||
}
|
||||
shardingNewTableSet.Add(in.Prefix + newTableName)
|
||||
break
|
||||
}
|
||||
}
|
||||
newTableName = in.Prefix + newTableName
|
||||
if tableNames[i] != "" {
|
||||
newTableNames[i] = newTableName
|
||||
}
|
||||
}
|
||||
tableNames = garray.NewStrArrayFrom(tableNames).FilterEmpty().Slice()
|
||||
newTableNames = garray.NewStrArrayFrom(newTableNames).FilterEmpty().Slice()
|
||||
in.genItems.Scale()
|
||||
|
||||
internalInput := CGenDaoInternalInput{
|
||||
CGenDaoInput: in,
|
||||
DB: nil,
|
||||
TableNames: tableNames,
|
||||
NewTableNames: newTableNames,
|
||||
ShardingTableSet: shardingNewTableSet,
|
||||
TableFieldsMap: tableFieldsMap,
|
||||
}
|
||||
|
||||
// Generate all files using the same flow as database mode.
|
||||
generateDao(ctx, internalInput)
|
||||
generateTable(ctx, internalInput)
|
||||
generateDo(ctx, internalInput)
|
||||
generateEntity(ctx, internalInput)
|
||||
|
||||
in.genItems.SetClear(in.Clear)
|
||||
}
|
||||
|
||||
@ -13,10 +13,6 @@ import (
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
|
||||
)
|
||||
|
||||
// doClear performs cleanup of stale generated files across all generation items.
|
||||
// It collects all generated file paths from all items, then for each item with
|
||||
// Clear enabled, removes any .go files in its directories that are NOT in the
|
||||
// generated file list. This ensures files for dropped/removed tables are cleaned up.
|
||||
func doClear(items *CGenDaoInternalGenItems) {
|
||||
var allGeneratedFilePaths = make([]string, 0)
|
||||
for _, item := range items.Items {
|
||||
@ -33,10 +29,6 @@ func doClear(items *CGenDaoInternalGenItems) {
|
||||
}
|
||||
}
|
||||
|
||||
// doClearItem removes stale .go files for a single generation item.
|
||||
// It scans all storage directories for .go files and deletes any file
|
||||
// that is not in the allGeneratedFilePaths list (i.e., no longer corresponds
|
||||
// to an existing database table).
|
||||
func doClearItem(item CGenDaoInternalGenItem, allGeneratedFilePaths []string) {
|
||||
var generatedFilePaths = make([]string, 0)
|
||||
for _, dirPath := range item.StorageDirPaths {
|
||||
|
||||
@ -26,9 +26,6 @@ import (
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/utility/utils"
|
||||
)
|
||||
|
||||
// generateDao generates dao files (index + internal) for all tables in the input.
|
||||
// It creates the dao directory structure and iterates over each table to generate
|
||||
// individual dao files via generateDaoSingle.
|
||||
func generateDao(ctx context.Context, in CGenDaoInternalInput) {
|
||||
var (
|
||||
dirPathDao = gfile.Join(in.Path, in.DaoPath)
|
||||
@ -51,27 +48,28 @@ func generateDao(ctx context.Context, in CGenDaoInternalInput) {
|
||||
}
|
||||
}
|
||||
|
||||
// generateDaoSingleInput holds all parameters needed to generate dao files for a single table.
|
||||
type generateDaoSingleInput struct {
|
||||
CGenDaoInternalInput
|
||||
TableName string // Original table name as it exists in the database.
|
||||
NewTableName string // Processed table name after prefix removal and sharding.
|
||||
DirPathDao string // Directory path for the dao index files.
|
||||
DirPathDaoInternal string // Directory path for the dao internal implementation files.
|
||||
IsSharding bool // Whether this table is a sharding table (merged from multiple physical tables).
|
||||
// TableName specifies the table name of the table.
|
||||
TableName string
|
||||
// NewTableName specifies the prefix-stripped or custom edited name of the table.
|
||||
NewTableName string
|
||||
DirPathDao string
|
||||
DirPathDaoInternal string
|
||||
IsSharding bool
|
||||
}
|
||||
|
||||
// generateDaoSingle generates the dao and model content of given table.
|
||||
func generateDaoSingle(ctx context.Context, in generateDaoSingleInput) {
|
||||
// Generating table data preparing.
|
||||
fieldMap, err := getTableFields(ctx, in.CGenDaoInternalInput, in.TableName)
|
||||
fieldMap, err := in.DB.TableFields(ctx, in.TableName)
|
||||
if err != nil {
|
||||
mlog.Fatalf(`fetching tables fields failed for table "%s": %+v`, in.TableName, err)
|
||||
}
|
||||
var (
|
||||
tableNameCamelCase = formatFieldName(in.NewTableName, FieldNameCaseCamel)
|
||||
tableNameCamelLowerCase = formatFieldName(in.NewTableName, FieldNameCaseCamelLower)
|
||||
tableNameSnakeCase = gstr.CaseSnake(in.NewTableName)
|
||||
fileName = formatFileName(in.NewTableName, in.FileNameCase)
|
||||
importPrefix = in.ImportPrefix
|
||||
)
|
||||
if importPrefix == "" {
|
||||
@ -80,13 +78,6 @@ func generateDaoSingle(ctx context.Context, in generateDaoSingleInput) {
|
||||
importPrefix = gstr.Join(g.SliceStr{importPrefix, in.DaoPath}, "/")
|
||||
}
|
||||
|
||||
fileName := gstr.Trim(tableNameSnakeCase, "-_.")
|
||||
if len(fileName) > 5 && fileName[len(fileName)-5:] == "_test" {
|
||||
// Add suffix to avoid the table name which contains "_test",
|
||||
// which would make the go file a testing file.
|
||||
fileName += "_table"
|
||||
}
|
||||
|
||||
// dao - index
|
||||
generateDaoIndex(generateDaoIndexInput{
|
||||
generateDaoSingleInput: in,
|
||||
@ -107,21 +98,14 @@ func generateDaoSingle(ctx context.Context, in generateDaoSingleInput) {
|
||||
})
|
||||
}
|
||||
|
||||
// generateDaoIndexInput holds parameters for generating the dao index file.
|
||||
// The index file provides the public API (exported struct and constructor)
|
||||
// for accessing the DAO, delegating to the internal implementation.
|
||||
type generateDaoIndexInput struct {
|
||||
generateDaoSingleInput
|
||||
TableNameCamelCase string // CamelCase version of the table name (e.g., "UserDetail").
|
||||
TableNameCamelLowerCase string // camelCase version of the table name (e.g., "userDetail").
|
||||
ImportPrefix string // Go import path prefix for the dao package.
|
||||
FileName string // Output file name (without extension).
|
||||
TableNameCamelCase string
|
||||
TableNameCamelLowerCase string
|
||||
ImportPrefix string
|
||||
FileName string
|
||||
}
|
||||
|
||||
// generateDaoIndex generates the dao index file for a single table.
|
||||
// The index file is the public-facing dao file that users import directly.
|
||||
// It will NOT overwrite an existing file unless OverwriteDao is enabled,
|
||||
// allowing users to customize the index file without losing changes.
|
||||
func generateDaoIndex(in generateDaoIndexInput) {
|
||||
path := filepath.FromSlash(gfile.Join(in.DirPathDao, in.FileName+".go"))
|
||||
// It should add path to result slice whenever it would generate the path file or not.
|
||||
@ -156,21 +140,15 @@ func generateDaoIndex(in generateDaoIndexInput) {
|
||||
}
|
||||
}
|
||||
|
||||
// generateDaoInternalInput holds parameters for generating the dao internal file.
|
||||
// The internal file contains the actual DAO implementation with column definitions
|
||||
// and is always overwritten on regeneration.
|
||||
type generateDaoInternalInput struct {
|
||||
generateDaoSingleInput
|
||||
TableNameCamelCase string // CamelCase version of the table name.
|
||||
TableNameCamelLowerCase string // camelCase version of the table name.
|
||||
ImportPrefix string // Go import path prefix for the dao package.
|
||||
FileName string // Output file name (without extension).
|
||||
FieldMap map[string]*gdb.TableField // Map of column name to field metadata.
|
||||
TableNameCamelCase string
|
||||
TableNameCamelLowerCase string
|
||||
ImportPrefix string
|
||||
FileName string
|
||||
FieldMap map[string]*gdb.TableField
|
||||
}
|
||||
|
||||
// generateDaoInternal generates the dao internal implementation file for a single table.
|
||||
// This file is always regenerated (overwritten) and contains the Columns struct definition
|
||||
// with column name constants and their string value assignments.
|
||||
func generateDaoInternal(in generateDaoInternalInput) {
|
||||
var (
|
||||
ctx = context.Background()
|
||||
|
||||
@ -22,10 +22,6 @@ import (
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/utility/utils"
|
||||
)
|
||||
|
||||
// generateDo generates DO (Data Object) files for all tables.
|
||||
// DO structs use "any" type for all scalar fields (replacing concrete types),
|
||||
// enabling flexible query building with the g.Meta `orm:"do:true"` tag.
|
||||
// Pointer, slice, and map types are preserved as-is.
|
||||
func generateDo(ctx context.Context, in CGenDaoInternalInput) {
|
||||
var dirPathDo = filepath.FromSlash(gfile.Join(in.Path, in.DoPath))
|
||||
in.genItems.AppendDirPath(dirPathDo)
|
||||
@ -34,13 +30,13 @@ func generateDo(ctx context.Context, in CGenDaoInternalInput) {
|
||||
in.NoModelComment = false
|
||||
// Model content.
|
||||
for i, tableName := range in.TableNames {
|
||||
fieldMap, err := getTableFields(ctx, in, tableName)
|
||||
fieldMap, err := in.DB.TableFields(ctx, tableName)
|
||||
if err != nil {
|
||||
mlog.Fatalf("fetching tables fields failed for table '%s':\n%v", tableName, err)
|
||||
}
|
||||
var (
|
||||
newTableName = in.NewTableNames[i]
|
||||
doFilePath = gfile.Join(dirPathDo, gstr.CaseSnake(newTableName)+".go")
|
||||
doFilePath = gfile.Join(dirPathDo, formatFileName(newTableName, in.FileNameCase)+".go")
|
||||
structDefinition, _ = generateStructDefinition(ctx, generateStructDefinitionInput{
|
||||
CGenDaoInternalInput: in,
|
||||
TableName: tableName,
|
||||
@ -79,9 +75,6 @@ func generateDo(ctx context.Context, in CGenDaoInternalInput) {
|
||||
}
|
||||
}
|
||||
|
||||
// generateDoContent renders the DO file content using the template engine.
|
||||
// It assembles template variables including package imports, struct definition,
|
||||
// and metadata, then parses the DO template to produce the final file content.
|
||||
func generateDoContent(
|
||||
ctx context.Context, in CGenDaoInternalInput, tableName, tableNameCamelCase, structDefine string,
|
||||
) string {
|
||||
|
||||
@ -13,29 +13,25 @@ import (
|
||||
|
||||
"github.com/gogf/gf/v2/os/gfile"
|
||||
"github.com/gogf/gf/v2/os/gview"
|
||||
"github.com/gogf/gf/v2/text/gstr"
|
||||
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/consts"
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/utility/utils"
|
||||
)
|
||||
|
||||
// generateEntity generates entity struct files for all tables.
|
||||
// Entity structs represent database table rows with concrete Go types,
|
||||
// including orm tags for field-to-column mapping and json tags for serialization.
|
||||
func generateEntity(ctx context.Context, in CGenDaoInternalInput) {
|
||||
var dirPathEntity = gfile.Join(in.Path, in.EntityPath)
|
||||
in.genItems.AppendDirPath(dirPathEntity)
|
||||
// Model content.
|
||||
for i, tableName := range in.TableNames {
|
||||
fieldMap, err := getTableFields(ctx, in, tableName)
|
||||
fieldMap, err := in.DB.TableFields(ctx, tableName)
|
||||
if err != nil {
|
||||
mlog.Fatalf("fetching tables fields failed for table '%s':\n%v", tableName, err)
|
||||
}
|
||||
|
||||
var (
|
||||
newTableName = in.NewTableNames[i]
|
||||
entityFilePath = filepath.FromSlash(gfile.Join(dirPathEntity, gstr.CaseSnake(newTableName)+".go"))
|
||||
entityFilePath = filepath.FromSlash(gfile.Join(dirPathEntity, formatFileName(newTableName, in.FileNameCase)+".go"))
|
||||
structDefinition, appendImports = generateStructDefinition(ctx, generateStructDefinitionInput{
|
||||
CGenDaoInternalInput: in,
|
||||
TableName: tableName,
|
||||
@ -63,9 +59,6 @@ func generateEntity(ctx context.Context, in CGenDaoInternalInput) {
|
||||
}
|
||||
}
|
||||
|
||||
// generateEntityContent renders the entity file content using the template engine.
|
||||
// It assembles template variables and parses the entity template to produce
|
||||
// the final Go source file content with proper imports and struct definition.
|
||||
func generateEntityContent(
|
||||
ctx context.Context, in CGenDaoInternalInput, tableName, tableNameCamelCase, structDefine string, appendImports []string,
|
||||
) string {
|
||||
|
||||
@ -7,25 +7,17 @@
|
||||
package gendao
|
||||
|
||||
type (
|
||||
// CGenDaoInternalGenItems tracks generation state across multiple configuration entries.
|
||||
// Each configuration entry (e.g., different database links in the config array)
|
||||
// gets its own CGenDaoInternalGenItem via Scale(). The index field points to the
|
||||
// current active item.
|
||||
CGenDaoInternalGenItems struct {
|
||||
index int // Index of the current active generation item.
|
||||
Items []CGenDaoInternalGenItem // List of all generation items, one per config entry.
|
||||
index int
|
||||
Items []CGenDaoInternalGenItem
|
||||
}
|
||||
|
||||
// CGenDaoInternalGenItem tracks generated files and directories for a single
|
||||
// configuration entry. Used by the Clear feature to identify and remove stale files.
|
||||
CGenDaoInternalGenItem struct {
|
||||
Clear bool // Whether to clear stale files for this item.
|
||||
StorageDirPaths []string // Directories where generated files are stored (dao, do, entity, table).
|
||||
GeneratedFilePaths []string // All file paths generated in this run.
|
||||
Clear bool
|
||||
StorageDirPaths []string
|
||||
GeneratedFilePaths []string
|
||||
}
|
||||
)
|
||||
|
||||
// newCGenDaoInternalGenItems creates a new generation items tracker with an empty item list.
|
||||
func newCGenDaoInternalGenItems() *CGenDaoInternalGenItems {
|
||||
return &CGenDaoInternalGenItems{
|
||||
index: -1,
|
||||
@ -33,8 +25,6 @@ func newCGenDaoInternalGenItems() *CGenDaoInternalGenItems {
|
||||
}
|
||||
}
|
||||
|
||||
// Scale adds a new generation item and advances the index to it.
|
||||
// Must be called once per configuration entry before generating files.
|
||||
func (i *CGenDaoInternalGenItems) Scale() {
|
||||
i.Items = append(i.Items, CGenDaoInternalGenItem{
|
||||
StorageDirPaths: make([]string, 0),
|
||||
@ -44,12 +34,10 @@ func (i *CGenDaoInternalGenItems) Scale() {
|
||||
i.index++
|
||||
}
|
||||
|
||||
// SetClear enables or disables the clear (stale file removal) flag for the current item.
|
||||
func (i *CGenDaoInternalGenItems) SetClear(clear bool) {
|
||||
i.Items[i.index].Clear = clear
|
||||
}
|
||||
|
||||
// AppendDirPath records a directory path used for storing generated files in the current item.
|
||||
func (i *CGenDaoInternalGenItems) AppendDirPath(storageDirPath string) {
|
||||
i.Items[i.index].StorageDirPaths = append(
|
||||
i.Items[i.index].StorageDirPaths,
|
||||
@ -57,7 +45,6 @@ func (i *CGenDaoInternalGenItems) AppendDirPath(storageDirPath string) {
|
||||
)
|
||||
}
|
||||
|
||||
// AppendGeneratedFilePath records a file path that was generated in the current item.
|
||||
func (i *CGenDaoInternalGenItems) AppendGeneratedFilePath(generatedFilePath string) {
|
||||
i.Items[i.index].GeneratedFilePaths = append(
|
||||
i.Items[i.index].GeneratedFilePaths,
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,211 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
)
|
||||
|
||||
// MSSQLParser implements SQLParser for SQL Server (T-SQL) DDL.
|
||||
type MSSQLParser struct{}
|
||||
|
||||
// ParseCreateTable parses a single MSSQL CREATE TABLE statement.
|
||||
func (p *MSSQLParser) ParseCreateTable(stmt string) (string, map[string]*gdb.TableField, error) {
|
||||
body, _, ok := extractBodyAndTrailing(stmt)
|
||||
if !ok {
|
||||
return "", nil, nil
|
||||
}
|
||||
|
||||
parenIdx := strings.Index(stmt, "(")
|
||||
header := stmt[:parenIdx]
|
||||
tableName := extractTableName(header)
|
||||
if tableName == "" {
|
||||
return "", nil, fmt.Errorf("cannot extract table name from: %s", header)
|
||||
}
|
||||
|
||||
columnDefs := splitColumns(body)
|
||||
fields := make(map[string]*gdb.TableField)
|
||||
pkColumns := findPrimaryKeysFromConstraints(columnDefs)
|
||||
|
||||
fieldIndex := 0
|
||||
for _, def := range columnDefs {
|
||||
def = strings.TrimSpace(def)
|
||||
if def == "" {
|
||||
continue
|
||||
}
|
||||
firstWord := strings.ToUpper(strings.Fields(def)[0])
|
||||
if isConstraintKeyword(firstWord) {
|
||||
continue
|
||||
}
|
||||
|
||||
field, err := p.parseColumnDef(def, fieldIndex)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
if field != nil {
|
||||
fields[field.Name] = field
|
||||
fieldIndex++
|
||||
}
|
||||
}
|
||||
|
||||
for _, pkCol := range pkColumns {
|
||||
if f, ok := fields[pkCol]; ok {
|
||||
f.Key = "PRI"
|
||||
}
|
||||
}
|
||||
|
||||
return tableName, fields, nil
|
||||
}
|
||||
|
||||
// ParseAlterTable parses MSSQL ALTER TABLE statements.
|
||||
func (p *MSSQLParser) ParseAlterTable(stmt string, tables map[string]map[string]*gdb.TableField) error {
|
||||
return parseAlterTableCommon(stmt, tables, p.parseColumnDef)
|
||||
}
|
||||
|
||||
// ParseComment parses EXEC sp_addextendedproperty to extract column comments.
|
||||
func (p *MSSQLParser) ParseComment(stmt string, tables map[string]map[string]*gdb.TableField) {
|
||||
upper := strings.ToUpper(strings.TrimSpace(stmt))
|
||||
if !strings.Contains(upper, "SP_ADDEXTENDEDPROPERTY") ||
|
||||
!strings.Contains(upper, "MS_DESCRIPTION") {
|
||||
return
|
||||
}
|
||||
|
||||
// Extract quoted string values
|
||||
var values []string
|
||||
inQuote := false
|
||||
var current strings.Builder
|
||||
for i := 0; i < len(stmt); i++ {
|
||||
ch := stmt[i]
|
||||
if ch == '\'' {
|
||||
if inQuote {
|
||||
if i+1 < len(stmt) && stmt[i+1] == '\'' {
|
||||
current.WriteByte('\'')
|
||||
i++
|
||||
continue
|
||||
}
|
||||
values = append(values, current.String())
|
||||
current.Reset()
|
||||
inQuote = false
|
||||
} else {
|
||||
inQuote = true
|
||||
}
|
||||
} else if inQuote {
|
||||
current.WriteByte(ch)
|
||||
}
|
||||
}
|
||||
|
||||
if len(values) < 8 {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
comment string
|
||||
tableName string
|
||||
columnName string
|
||||
)
|
||||
|
||||
for i := 0; i < len(values)-1; i++ {
|
||||
switch strings.ToUpper(values[i]) {
|
||||
case "MS_DESCRIPTION":
|
||||
comment = values[i+1]
|
||||
case "TABLE":
|
||||
tableName = values[i+1]
|
||||
case "COLUMN":
|
||||
columnName = values[i+1]
|
||||
}
|
||||
}
|
||||
|
||||
if tableName != "" && columnName != "" && comment != "" {
|
||||
if fields, ok := tables[tableName]; ok {
|
||||
if field, ok := fields[columnName]; ok {
|
||||
field.Comment = comment
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// parseColumnDef parses a single MSSQL column definition string into a TableField.
|
||||
// It handles MSSQL-specific syntax including bracket-quoted identifiers and
|
||||
// type parameters like varchar(max).
|
||||
func (p *MSSQLParser) parseColumnDef(def string, index int) (*gdb.TableField, error) {
|
||||
tokens := mysqlTokenize(def)
|
||||
if len(tokens) < 2 {
|
||||
return nil, fmt.Errorf("invalid column definition: %s", def)
|
||||
}
|
||||
|
||||
field := &gdb.TableField{
|
||||
Index: index,
|
||||
Name: unquoteIdentifier(tokens[0]),
|
||||
Null: true,
|
||||
}
|
||||
|
||||
field.Type = tokens[1]
|
||||
|
||||
rest := ""
|
||||
if len(tokens) > 2 {
|
||||
rest = strings.Join(tokens[2:], " ")
|
||||
}
|
||||
if !strings.Contains(field.Type, "(") && strings.HasPrefix(strings.TrimSpace(rest), "(") {
|
||||
end := strings.Index(rest, ")")
|
||||
if end >= 0 {
|
||||
field.Type += rest[:end+1]
|
||||
rest = strings.TrimSpace(rest[end+1:])
|
||||
}
|
||||
}
|
||||
|
||||
p.parseColumnAttributes(field, rest)
|
||||
|
||||
return field, nil
|
||||
}
|
||||
|
||||
// parseColumnAttributes parses MSSQL column constraint keywords including
|
||||
// NOT NULL, NULL, PRIMARY KEY, UNIQUE, IDENTITY (auto-increment), and DEFAULT.
|
||||
func (p *MSSQLParser) parseColumnAttributes(field *gdb.TableField, attrs string) {
|
||||
words := strings.Fields(attrs)
|
||||
upperWords := strings.Fields(strings.ToUpper(attrs))
|
||||
|
||||
for i := 0; i < len(upperWords); i++ {
|
||||
switch upperWords[i] {
|
||||
case "NOT":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "NULL" {
|
||||
field.Null = false
|
||||
i++
|
||||
}
|
||||
case "NULL":
|
||||
field.Null = true
|
||||
case "PRIMARY":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "KEY" {
|
||||
field.Key = "PRI"
|
||||
i++
|
||||
}
|
||||
case "UNIQUE":
|
||||
if field.Key == "" {
|
||||
field.Key = "UNI"
|
||||
}
|
||||
case "IDENTITY":
|
||||
field.Extra = "auto_increment"
|
||||
if i+1 < len(words) && strings.HasPrefix(words[i+1], "(") {
|
||||
i++
|
||||
}
|
||||
default:
|
||||
if strings.HasPrefix(upperWords[i], "IDENTITY(") || strings.HasPrefix(upperWords[i], "IDENTITY (") {
|
||||
field.Extra = "auto_increment"
|
||||
}
|
||||
case "DEFAULT":
|
||||
if i+1 < len(words) {
|
||||
defaultVal, _ := extractDefaultValue("DEFAULT " + strings.Join(words[i+1:], " "))
|
||||
field.Default = defaultVal
|
||||
if defaultVal != nil {
|
||||
i++
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,72 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func Test_MSSQL_CreateTable_Basic(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MSSQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE [dbo].[users] (
|
||||
[id] INT IDENTITY(1,1) NOT NULL,
|
||||
[name] NVARCHAR(100) NOT NULL,
|
||||
[email] NVARCHAR(200) NULL,
|
||||
[balance] DECIMAL(18,2) DEFAULT 0,
|
||||
[created_at] DATETIME2 NOT NULL DEFAULT GETDATE(),
|
||||
CONSTRAINT [PK_users] PRIMARY KEY CLUSTERED ([id])
|
||||
);
|
||||
EXEC sp_addextendedproperty 'MS_Description', 'User ID', 'SCHEMA', 'dbo', 'TABLE', 'users', 'COLUMN', 'id';
|
||||
EXEC sp_addextendedproperty 'MS_Description', 'User name', 'SCHEMA', 'dbo', 'TABLE', 'users', 'COLUMN', 'name';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 5)
|
||||
|
||||
t.Assert(fields["id"].Extra, "auto_increment")
|
||||
t.Assert(fields["id"].Null, false)
|
||||
t.Assert(fields["id"].Key, "PRI")
|
||||
t.Assert(fields["id"].Comment, "User ID")
|
||||
|
||||
t.Assert(fields["name"].Comment, "User name")
|
||||
t.Assert(fields["name"].Null, false)
|
||||
|
||||
t.Assert(fields["email"].Null, true)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MSSQL_AlterTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MSSQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INT IDENTITY(1,1) NOT NULL,
|
||||
name NVARCHAR(100) NOT NULL,
|
||||
CONSTRAINT PK_users PRIMARY KEY (id)
|
||||
);
|
||||
ALTER TABLE users ADD email NVARCHAR(200) NULL;
|
||||
ALTER TABLE users DROP COLUMN name;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 2) // id, email
|
||||
_, ok := fields["name"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["email"].Null, true)
|
||||
})
|
||||
}
|
||||
@ -1,199 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
)
|
||||
|
||||
// MySQLParser implements SQLParser for MySQL/MariaDB/TiDB DDL.
|
||||
type MySQLParser struct{}
|
||||
|
||||
// ParseCreateTable parses a single MySQL CREATE TABLE statement.
|
||||
func (p *MySQLParser) ParseCreateTable(stmt string) (string, map[string]*gdb.TableField, error) {
|
||||
body, trailing, ok := extractBodyAndTrailing(stmt)
|
||||
if !ok {
|
||||
return "", nil, nil
|
||||
}
|
||||
|
||||
parenIdx := strings.Index(stmt, "(")
|
||||
header := stmt[:parenIdx]
|
||||
tableName := extractTableName(header)
|
||||
if tableName == "" {
|
||||
return "", nil, fmt.Errorf("cannot extract table name from: %s", header)
|
||||
}
|
||||
|
||||
columnDefs := splitColumns(body)
|
||||
fields := make(map[string]*gdb.TableField)
|
||||
pkColumns := findPrimaryKeysFromConstraints(columnDefs)
|
||||
|
||||
fieldIndex := 0
|
||||
for _, def := range columnDefs {
|
||||
def = strings.TrimSpace(def)
|
||||
if def == "" {
|
||||
continue
|
||||
}
|
||||
firstWord := strings.ToUpper(strings.Fields(def)[0])
|
||||
if isConstraintKeyword(firstWord) {
|
||||
continue
|
||||
}
|
||||
|
||||
field, err := p.parseColumnDef(def, fieldIndex)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
if field != nil {
|
||||
fields[field.Name] = field
|
||||
fieldIndex++
|
||||
}
|
||||
}
|
||||
|
||||
for _, pkCol := range pkColumns {
|
||||
if f, ok := fields[pkCol]; ok {
|
||||
f.Key = "PRI"
|
||||
}
|
||||
}
|
||||
|
||||
// Extract inline comments from trailing table options (not used for field generation)
|
||||
_ = trailing
|
||||
|
||||
return tableName, fields, nil
|
||||
}
|
||||
|
||||
// ParseAlterTable parses MySQL ALTER TABLE statements.
|
||||
func (p *MySQLParser) ParseAlterTable(stmt string, tables map[string]map[string]*gdb.TableField) error {
|
||||
return parseAlterTableCommon(stmt, tables, p.parseColumnDef)
|
||||
}
|
||||
|
||||
// ParseComment handles MySQL-style comments (inline COMMENT keyword is handled in parseColumnDef).
|
||||
func (p *MySQLParser) ParseComment(stmt string, tables map[string]map[string]*gdb.TableField) {
|
||||
// MySQL uses inline COMMENT 'xxx' in column definitions,
|
||||
// which is already handled by parseColumnDef. No separate COMMENT ON statement.
|
||||
}
|
||||
|
||||
// parseColumnDef parses a single MySQL column definition string into a TableField.
|
||||
// It extracts the column name, data type (including UNSIGNED modifier), and delegates
|
||||
// attribute parsing (NULL, DEFAULT, PRIMARY KEY, COMMENT, etc.) to parseColumnAttributes.
|
||||
func (p *MySQLParser) parseColumnDef(def string, index int) (*gdb.TableField, error) {
|
||||
tokens := mysqlTokenize(def)
|
||||
if len(tokens) < 2 {
|
||||
return nil, fmt.Errorf("invalid column definition: %s", def)
|
||||
}
|
||||
|
||||
field := &gdb.TableField{
|
||||
Index: index,
|
||||
Name: unquoteIdentifier(tokens[0]),
|
||||
Null: true,
|
||||
}
|
||||
|
||||
typeStr := tokens[1]
|
||||
rest := ""
|
||||
if len(tokens) > 2 {
|
||||
rest = strings.Join(tokens[2:], " ")
|
||||
}
|
||||
|
||||
// Check if rest starts with '(' meaning the type params are in rest
|
||||
if !strings.Contains(typeStr, "(") && strings.HasPrefix(strings.TrimSpace(rest), "(") {
|
||||
endParen := strings.Index(rest, ")")
|
||||
if endParen >= 0 {
|
||||
typeStr += rest[:endParen+1]
|
||||
rest = strings.TrimSpace(rest[endParen+1:])
|
||||
}
|
||||
}
|
||||
|
||||
field.Type = typeStr
|
||||
|
||||
// Handle UNSIGNED
|
||||
upperRest := strings.ToUpper(rest)
|
||||
if strings.HasPrefix(upperRest, "UNSIGNED") {
|
||||
field.Type += " unsigned"
|
||||
rest = strings.TrimSpace(rest[8:])
|
||||
}
|
||||
|
||||
p.parseColumnAttributes(field, rest)
|
||||
|
||||
return field, nil
|
||||
}
|
||||
|
||||
// parseColumnAttributes parses MySQL column constraint keywords from the attribute string
|
||||
// following the column type. It handles NOT NULL, NULL, PRIMARY KEY, UNIQUE, AUTO_INCREMENT,
|
||||
// DEFAULT, COMMENT, and ON UPDATE clauses.
|
||||
func (p *MySQLParser) parseColumnAttributes(field *gdb.TableField, attrs string) {
|
||||
words := strings.Fields(attrs)
|
||||
upperWords := strings.Fields(strings.ToUpper(attrs))
|
||||
|
||||
for i := 0; i < len(upperWords); i++ {
|
||||
switch upperWords[i] {
|
||||
case "NOT":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "NULL" {
|
||||
field.Null = false
|
||||
i++
|
||||
}
|
||||
case "NULL":
|
||||
field.Null = true
|
||||
case "PRIMARY":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "KEY" {
|
||||
field.Key = "PRI"
|
||||
i++
|
||||
}
|
||||
case "UNIQUE":
|
||||
if field.Key == "" {
|
||||
field.Key = "UNI"
|
||||
}
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "KEY" {
|
||||
i++
|
||||
}
|
||||
case "KEY":
|
||||
if field.Key == "" {
|
||||
field.Key = "MUL"
|
||||
}
|
||||
case "AUTO_INCREMENT":
|
||||
field.Extra = "auto_increment"
|
||||
case "DEFAULT":
|
||||
if i+1 < len(words) {
|
||||
defaultVal, _ := extractDefaultValue("DEFAULT " + strings.Join(words[i+1:], " "))
|
||||
field.Default = defaultVal
|
||||
if defaultVal != nil {
|
||||
if strings.HasPrefix(words[i+1], "'") {
|
||||
for j := i + 1; j < len(words); j++ {
|
||||
if strings.HasSuffix(words[j], "'") {
|
||||
i = j
|
||||
break
|
||||
}
|
||||
}
|
||||
} else {
|
||||
i++
|
||||
}
|
||||
}
|
||||
}
|
||||
case "COMMENT":
|
||||
if i+1 < len(words) {
|
||||
comment := strings.Join(words[i+1:], " ")
|
||||
comment = strings.TrimSpace(comment)
|
||||
if len(comment) >= 2 && comment[0] == '\'' && comment[len(comment)-1] == '\'' {
|
||||
comment = comment[1 : len(comment)-1]
|
||||
comment = strings.ReplaceAll(comment, "''", "'")
|
||||
}
|
||||
field.Comment = comment
|
||||
return
|
||||
}
|
||||
case "ON":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "UPDATE" {
|
||||
if i+2 < len(upperWords) {
|
||||
if field.Extra != "" {
|
||||
field.Extra += ", "
|
||||
}
|
||||
field.Extra += "on update " + strings.ToLower(words[i+2])
|
||||
i += 2
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,300 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func Test_MySQL_CreateTable_Basic(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT 'User ID',
|
||||
name VARCHAR(100) NOT NULL DEFAULT '' COMMENT 'User name',
|
||||
email VARCHAR(200) NULL COMMENT 'Email address',
|
||||
age INT(11) DEFAULT 0,
|
||||
score DECIMAL(10,2) DEFAULT 0.00,
|
||||
status TINYINT(1) NOT NULL DEFAULT 1,
|
||||
created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||
updated_at DATETIME NULL ON UPDATE CURRENT_TIMESTAMP,
|
||||
PRIMARY KEY (id),
|
||||
UNIQUE KEY uk_email (email)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='User table';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 1)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 8)
|
||||
|
||||
// Check id field
|
||||
t.Assert(fields["id"].Name, "id")
|
||||
t.Assert(fields["id"].Type, "BIGINT(20) unsigned")
|
||||
t.Assert(fields["id"].Null, false)
|
||||
t.Assert(fields["id"].Key, "PRI")
|
||||
t.Assert(fields["id"].Extra, "auto_increment")
|
||||
t.Assert(fields["id"].Comment, "User ID")
|
||||
t.Assert(fields["id"].Index, 0)
|
||||
|
||||
// Check name field
|
||||
t.Assert(fields["name"].Name, "name")
|
||||
t.Assert(fields["name"].Null, false)
|
||||
t.Assert(fields["name"].Comment, "User name")
|
||||
|
||||
// Check email field
|
||||
t.Assert(fields["email"].Null, true)
|
||||
|
||||
// Check created_at
|
||||
t.Assert(fields["created_at"].Null, false)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_AlterTable_AddColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INT NOT NULL AUTO_INCREMENT,
|
||||
name VARCHAR(100) NOT NULL,
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
ALTER TABLE users ADD COLUMN email VARCHAR(200) NULL COMMENT 'Email';
|
||||
ALTER TABLE users ADD COLUMN age INT DEFAULT 0;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 4)
|
||||
t.Assert(fields["email"].Name, "email")
|
||||
t.Assert(fields["email"].Null, true)
|
||||
t.Assert(fields["email"].Comment, "Email")
|
||||
t.Assert(fields["age"].Name, "age")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_AlterTable_DropColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INT NOT NULL AUTO_INCREMENT,
|
||||
name VARCHAR(100),
|
||||
old_field VARCHAR(50),
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
ALTER TABLE users DROP COLUMN old_field;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 2)
|
||||
_, ok := fields["old_field"]
|
||||
t.Assert(ok, false)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_AlterTable_ModifyColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INT NOT NULL AUTO_INCREMENT,
|
||||
name VARCHAR(100),
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
ALTER TABLE users MODIFY COLUMN name VARCHAR(200) NOT NULL COMMENT 'Full name';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(fields["name"].Type, "VARCHAR(200)")
|
||||
t.Assert(fields["name"].Null, false)
|
||||
t.Assert(fields["name"].Comment, "Full name")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_AlterTable_ChangeColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INT NOT NULL AUTO_INCREMENT,
|
||||
old_name VARCHAR(100),
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
ALTER TABLE users CHANGE COLUMN old_name new_name VARCHAR(200) NOT NULL;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
_, ok := fields["old_name"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["new_name"].Name, "new_name")
|
||||
t.Assert(fields["new_name"].Type, "VARCHAR(200)")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_AlterTable_AddPrimaryKey(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INT NOT NULL,
|
||||
name VARCHAR(100)
|
||||
);
|
||||
ALTER TABLE users ADD PRIMARY KEY (id);
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
t.Assert(tables["users"]["id"].Key, "PRI")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_DropTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE temp_log (id INT, msg TEXT);
|
||||
CREATE TABLE users (id INT, name VARCHAR(100));
|
||||
DROP TABLE IF EXISTS temp_log;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
t.Assert(len(tables), 1)
|
||||
_, ok := tables["temp_log"]
|
||||
t.Assert(ok, false)
|
||||
_, ok = tables["users"]
|
||||
t.Assert(ok, true)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_MultipleMigrations(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
|
||||
// Simulate V1: initial schema
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, `
|
||||
CREATE TABLE users (
|
||||
id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
|
||||
name VARCHAR(50) NOT NULL,
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
// Simulate V2: add columns
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE users ADD COLUMN email VARCHAR(200) NULL;
|
||||
ALTER TABLE users ADD COLUMN phone VARCHAR(20) NULL;
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
// Simulate V3: modify + drop
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE users MODIFY COLUMN name VARCHAR(100) NOT NULL COMMENT 'Full name';
|
||||
ALTER TABLE users DROP COLUMN phone;
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 3) // id, name, email
|
||||
t.Assert(fields["name"].Type, "VARCHAR(100)")
|
||||
t.Assert(fields["name"].Comment, "Full name")
|
||||
_, ok := fields["phone"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["email"].Null, true)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_MySQL_FullMigrationScenario(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
|
||||
// V001: Initial tables
|
||||
err := processSQL(parser, `
|
||||
CREATE TABLE IF NOT EXISTS users (
|
||||
id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT 'Primary key',
|
||||
username VARCHAR(50) NOT NULL COMMENT 'Username',
|
||||
password VARCHAR(128) NOT NULL COMMENT 'Hashed password',
|
||||
created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||
PRIMARY KEY (id),
|
||||
UNIQUE KEY uk_username (username)
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS orders (
|
||||
id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
|
||||
user_id BIGINT UNSIGNED NOT NULL,
|
||||
amount DECIMAL(10,2) NOT NULL DEFAULT 0.00,
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 2)
|
||||
|
||||
// V002: Add email, phone
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE users ADD COLUMN email VARCHAR(200) NULL COMMENT 'User email';
|
||||
ALTER TABLE users ADD COLUMN phone VARCHAR(20) NULL COMMENT 'Phone number';
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables["users"]), 6)
|
||||
|
||||
// V003: Modify, rename, drop
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE users MODIFY COLUMN username VARCHAR(100) NOT NULL COMMENT 'Login name';
|
||||
ALTER TABLE users CHANGE COLUMN phone mobile VARCHAR(20) NULL COMMENT 'Mobile number';
|
||||
ALTER TABLE users DROP COLUMN password;
|
||||
ALTER TABLE orders ADD COLUMN status TINYINT(1) NOT NULL DEFAULT 0 COMMENT 'Order status';
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
userFields := tables["users"]
|
||||
t.Assert(len(userFields), 5) // id, username, email, mobile, created_at
|
||||
t.Assert(userFields["username"].Type, "VARCHAR(100)")
|
||||
t.Assert(userFields["username"].Comment, "Login name")
|
||||
_, ok := userFields["password"]
|
||||
t.Assert(ok, false)
|
||||
_, ok = userFields["phone"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(userFields["mobile"].Name, "mobile")
|
||||
t.Assert(userFields["mobile"].Comment, "Mobile number")
|
||||
|
||||
orderFields := tables["orders"]
|
||||
t.Assert(len(orderFields), 4)
|
||||
t.Assert(orderFields["status"].Default, "0")
|
||||
|
||||
// V004: Drop table
|
||||
err = processSQL(parser, `
|
||||
DROP TABLE IF EXISTS orders;
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 1)
|
||||
_, ok = tables["orders"]
|
||||
t.Assert(ok, false)
|
||||
})
|
||||
}
|
||||
@ -1,209 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
)
|
||||
|
||||
// OracleParser implements SQLParser for Oracle/DM DDL.
|
||||
type OracleParser struct{}
|
||||
|
||||
// ParseCreateTable parses a single Oracle CREATE TABLE statement.
|
||||
func (p *OracleParser) ParseCreateTable(stmt string) (string, map[string]*gdb.TableField, error) {
|
||||
body, _, ok := extractBodyAndTrailing(stmt)
|
||||
if !ok {
|
||||
return "", nil, nil
|
||||
}
|
||||
|
||||
parenIdx := strings.Index(stmt, "(")
|
||||
header := stmt[:parenIdx]
|
||||
tableName := extractTableName(header)
|
||||
if tableName == "" {
|
||||
return "", nil, fmt.Errorf("cannot extract table name from: %s", header)
|
||||
}
|
||||
|
||||
columnDefs := splitColumns(body)
|
||||
fields := make(map[string]*gdb.TableField)
|
||||
pkColumns := findPrimaryKeysFromConstraints(columnDefs)
|
||||
|
||||
fieldIndex := 0
|
||||
for _, def := range columnDefs {
|
||||
def = strings.TrimSpace(def)
|
||||
if def == "" {
|
||||
continue
|
||||
}
|
||||
firstWord := strings.ToUpper(strings.Fields(def)[0])
|
||||
if isConstraintKeyword(firstWord) {
|
||||
continue
|
||||
}
|
||||
|
||||
field, err := p.parseColumnDef(def, fieldIndex)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
if field != nil {
|
||||
fields[field.Name] = field
|
||||
fieldIndex++
|
||||
}
|
||||
}
|
||||
|
||||
for _, pkCol := range pkColumns {
|
||||
if f, ok := fields[pkCol]; ok {
|
||||
f.Key = "PRI"
|
||||
}
|
||||
upperPk := strings.ToUpper(pkCol)
|
||||
if f, ok := fields[upperPk]; ok {
|
||||
f.Key = "PRI"
|
||||
}
|
||||
}
|
||||
|
||||
return tableName, fields, nil
|
||||
}
|
||||
|
||||
// ParseAlterTable parses Oracle ALTER TABLE statements.
|
||||
func (p *OracleParser) ParseAlterTable(stmt string, tables map[string]map[string]*gdb.TableField) error {
|
||||
return parseAlterTableCommon(stmt, tables, p.parseColumnDef)
|
||||
}
|
||||
|
||||
// ParseComment parses COMMENT ON COLUMN table.column IS 'comment'.
|
||||
func (p *OracleParser) ParseComment(stmt string, tables map[string]map[string]*gdb.TableField) {
|
||||
upper := strings.ToUpper(strings.TrimSpace(stmt))
|
||||
if !strings.HasPrefix(upper, "COMMENT ON COLUMN") {
|
||||
return
|
||||
}
|
||||
|
||||
rest := strings.TrimSpace(stmt[len("COMMENT ON COLUMN"):])
|
||||
isIdx := strings.Index(strings.ToUpper(rest), " IS ")
|
||||
if isIdx < 0 {
|
||||
return
|
||||
}
|
||||
ref := strings.TrimSpace(rest[:isIdx])
|
||||
comment := strings.TrimSpace(rest[isIdx+4:])
|
||||
|
||||
if len(comment) >= 2 && comment[0] == '\'' && comment[len(comment)-1] == '\'' {
|
||||
comment = comment[1 : len(comment)-1]
|
||||
comment = strings.ReplaceAll(comment, "''", "'")
|
||||
}
|
||||
|
||||
parts := strings.Split(ref, ".")
|
||||
var tableName, columnName string
|
||||
switch len(parts) {
|
||||
case 2:
|
||||
tableName = unquoteIdentifier(parts[0])
|
||||
columnName = unquoteIdentifier(parts[1])
|
||||
case 3:
|
||||
tableName = unquoteIdentifier(parts[1])
|
||||
columnName = unquoteIdentifier(parts[2])
|
||||
default:
|
||||
return
|
||||
}
|
||||
|
||||
if fields, ok := tables[tableName]; ok {
|
||||
if field, ok := fields[columnName]; ok {
|
||||
field.Comment = comment
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// parseColumnDef parses a single Oracle column definition string into a TableField.
|
||||
// It handles Oracle-specific types including TIMESTAMP WITH TIME ZONE and
|
||||
// TIMESTAMP WITH LOCAL TIME ZONE.
|
||||
func (p *OracleParser) parseColumnDef(def string, index int) (*gdb.TableField, error) {
|
||||
tokens := mysqlTokenize(def)
|
||||
if len(tokens) < 2 {
|
||||
return nil, fmt.Errorf("invalid column definition: %s", def)
|
||||
}
|
||||
|
||||
field := &gdb.TableField{
|
||||
Index: index,
|
||||
Name: unquoteIdentifier(tokens[0]),
|
||||
Null: true,
|
||||
}
|
||||
|
||||
field.Type = tokens[1]
|
||||
|
||||
rest := ""
|
||||
if len(tokens) > 2 {
|
||||
rest = strings.Join(tokens[2:], " ")
|
||||
}
|
||||
|
||||
if !strings.Contains(field.Type, "(") && strings.HasPrefix(strings.TrimSpace(rest), "(") {
|
||||
end := strings.Index(rest, ")")
|
||||
if end >= 0 {
|
||||
field.Type += rest[:end+1]
|
||||
rest = strings.TrimSpace(rest[end+1:])
|
||||
}
|
||||
}
|
||||
|
||||
// Handle TIMESTAMP WITH TIME ZONE / WITH LOCAL TIME ZONE
|
||||
upperType := strings.ToUpper(field.Type)
|
||||
upperRest := strings.ToUpper(rest)
|
||||
if upperType == "TIMESTAMP" {
|
||||
if strings.HasPrefix(upperRest, "WITH LOCAL TIME ZONE") {
|
||||
field.Type = "timestamp with local time zone"
|
||||
rest = strings.TrimSpace(rest[len("WITH LOCAL TIME ZONE"):])
|
||||
} else if strings.HasPrefix(upperRest, "WITH TIME ZONE") {
|
||||
field.Type = "timestamp with time zone"
|
||||
rest = strings.TrimSpace(rest[len("WITH TIME ZONE"):])
|
||||
}
|
||||
}
|
||||
|
||||
p.parseColumnAttributes(field, rest)
|
||||
|
||||
return field, nil
|
||||
}
|
||||
|
||||
// parseColumnAttributes parses Oracle column constraint keywords including
|
||||
// NOT NULL, NULL, PRIMARY KEY, UNIQUE, DEFAULT, and GENERATED ... AS IDENTITY.
|
||||
func (p *OracleParser) parseColumnAttributes(field *gdb.TableField, attrs string) {
|
||||
words := strings.Fields(attrs)
|
||||
upperWords := strings.Fields(strings.ToUpper(attrs))
|
||||
|
||||
for i := 0; i < len(upperWords); i++ {
|
||||
switch upperWords[i] {
|
||||
case "NOT":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "NULL" {
|
||||
field.Null = false
|
||||
i++
|
||||
}
|
||||
case "NULL":
|
||||
field.Null = true
|
||||
case "PRIMARY":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "KEY" {
|
||||
field.Key = "PRI"
|
||||
i++
|
||||
}
|
||||
case "UNIQUE":
|
||||
if field.Key == "" {
|
||||
field.Key = "UNI"
|
||||
}
|
||||
case "DEFAULT":
|
||||
if i+1 < len(words) {
|
||||
defaultVal, _ := extractDefaultValue("DEFAULT " + strings.Join(words[i+1:], " "))
|
||||
field.Default = defaultVal
|
||||
if defaultVal != nil {
|
||||
i++
|
||||
}
|
||||
}
|
||||
case "GENERATED":
|
||||
rest := strings.Join(upperWords[i:], " ")
|
||||
if strings.Contains(rest, "AS IDENTITY") {
|
||||
field.Extra = "auto_increment"
|
||||
for j := i + 1; j < len(upperWords); j++ {
|
||||
if upperWords[j] == "IDENTITY" {
|
||||
i = j
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,97 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func Test_Oracle_CreateTable_Basic(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &OracleParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
ID NUMBER(10) NOT NULL,
|
||||
NAME VARCHAR2(100) NOT NULL,
|
||||
EMAIL VARCHAR2(200),
|
||||
CREATED_AT TIMESTAMP WITH TIME ZONE DEFAULT SYSTIMESTAMP,
|
||||
CONSTRAINT PK_USERS PRIMARY KEY (ID)
|
||||
);
|
||||
COMMENT ON COLUMN users.ID IS 'User ID';
|
||||
COMMENT ON COLUMN users.NAME IS 'User name';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 4)
|
||||
|
||||
t.Assert(fields["ID"].Key, "PRI")
|
||||
t.Assert(fields["ID"].Null, false)
|
||||
t.Assert(fields["ID"].Comment, "User ID")
|
||||
|
||||
t.Assert(fields["NAME"].Null, false)
|
||||
t.Assert(fields["NAME"].Comment, "User name")
|
||||
|
||||
t.Assert(fields["CREATED_AT"].Type, "timestamp with time zone")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Oracle_AlterTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &OracleParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
ID NUMBER(10) NOT NULL,
|
||||
NAME VARCHAR2(100),
|
||||
CONSTRAINT PK_USERS PRIMARY KEY (ID)
|
||||
);
|
||||
ALTER TABLE users ADD EMAIL VARCHAR2(200);
|
||||
ALTER TABLE users MODIFY NAME VARCHAR2(200) NOT NULL;
|
||||
COMMENT ON COLUMN users.EMAIL IS 'Email address';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 3)
|
||||
t.Assert(fields["EMAIL"].Comment, "Email address")
|
||||
t.Assert(fields["NAME"].Type, "VARCHAR2(200)")
|
||||
t.Assert(fields["NAME"].Null, false)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Oracle_AlterTable_DropColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &OracleParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
ID NUMBER(10) NOT NULL,
|
||||
NAME VARCHAR2(100) NOT NULL,
|
||||
OLD_COL VARCHAR2(50),
|
||||
EMAIL VARCHAR2(200),
|
||||
CONSTRAINT PK_USERS PRIMARY KEY (ID)
|
||||
);
|
||||
ALTER TABLE users DROP COLUMN OLD_COL;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 3)
|
||||
_, ok := fields["OLD_COL"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["NAME"].Name, "NAME")
|
||||
t.Assert(fields["EMAIL"].Name, "EMAIL")
|
||||
})
|
||||
}
|
||||
@ -1,268 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
)
|
||||
|
||||
// PgSQLParser implements SQLParser for PostgreSQL DDL.
|
||||
type PgSQLParser struct{}
|
||||
|
||||
// ParseCreateTable parses a single PostgreSQL CREATE TABLE statement.
|
||||
func (p *PgSQLParser) ParseCreateTable(stmt string) (string, map[string]*gdb.TableField, error) {
|
||||
body, _, ok := extractBodyAndTrailing(stmt)
|
||||
if !ok {
|
||||
return "", nil, nil
|
||||
}
|
||||
|
||||
parenIdx := strings.Index(stmt, "(")
|
||||
header := stmt[:parenIdx]
|
||||
tableName := extractTableName(header)
|
||||
if tableName == "" {
|
||||
return "", nil, fmt.Errorf("cannot extract table name from: %s", header)
|
||||
}
|
||||
|
||||
columnDefs := splitColumns(body)
|
||||
fields := make(map[string]*gdb.TableField)
|
||||
pkColumns := findPrimaryKeysFromConstraints(columnDefs)
|
||||
|
||||
fieldIndex := 0
|
||||
for _, def := range columnDefs {
|
||||
def = strings.TrimSpace(def)
|
||||
if def == "" {
|
||||
continue
|
||||
}
|
||||
firstWord := strings.ToUpper(strings.Fields(def)[0])
|
||||
if isConstraintKeyword(firstWord) {
|
||||
continue
|
||||
}
|
||||
|
||||
field, err := p.parseColumnDef(def, fieldIndex)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
if field != nil {
|
||||
fields[field.Name] = field
|
||||
fieldIndex++
|
||||
}
|
||||
}
|
||||
|
||||
for _, pkCol := range pkColumns {
|
||||
if f, ok := fields[pkCol]; ok {
|
||||
f.Key = "PRI"
|
||||
}
|
||||
}
|
||||
|
||||
return tableName, fields, nil
|
||||
}
|
||||
|
||||
// ParseAlterTable parses PostgreSQL ALTER TABLE statements.
|
||||
func (p *PgSQLParser) ParseAlterTable(stmt string, tables map[string]map[string]*gdb.TableField) error {
|
||||
return parseAlterTableCommon(stmt, tables, p.parseColumnDef)
|
||||
}
|
||||
|
||||
// ParseComment parses COMMENT ON COLUMN schema.table.column IS 'comment' statements.
|
||||
func (p *PgSQLParser) ParseComment(stmt string, tables map[string]map[string]*gdb.TableField) {
|
||||
upper := strings.ToUpper(strings.TrimSpace(stmt))
|
||||
if !strings.HasPrefix(upper, "COMMENT ON COLUMN") {
|
||||
return
|
||||
}
|
||||
|
||||
rest := strings.TrimSpace(stmt[len("COMMENT ON COLUMN"):])
|
||||
isIdx := strings.Index(strings.ToUpper(rest), " IS ")
|
||||
if isIdx < 0 {
|
||||
return
|
||||
}
|
||||
ref := strings.TrimSpace(rest[:isIdx])
|
||||
comment := strings.TrimSpace(rest[isIdx+4:])
|
||||
|
||||
if len(comment) >= 2 && comment[0] == '\'' && comment[len(comment)-1] == '\'' {
|
||||
comment = comment[1 : len(comment)-1]
|
||||
comment = strings.ReplaceAll(comment, "''", "'")
|
||||
}
|
||||
|
||||
parts := strings.Split(ref, ".")
|
||||
var tableName, columnName string
|
||||
switch len(parts) {
|
||||
case 2:
|
||||
tableName = unquoteIdentifier(parts[0])
|
||||
columnName = unquoteIdentifier(parts[1])
|
||||
case 3:
|
||||
tableName = unquoteIdentifier(parts[1])
|
||||
columnName = unquoteIdentifier(parts[2])
|
||||
default:
|
||||
return
|
||||
}
|
||||
|
||||
if fields, ok := tables[tableName]; ok {
|
||||
if field, ok := fields[columnName]; ok {
|
||||
field.Comment = comment
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// parseColumnDef parses a single PostgreSQL column definition string into a TableField.
|
||||
// It handles PostgreSQL-specific types like SERIAL/BIGSERIAL (auto-increment shorthand),
|
||||
// CHARACTER VARYING, DOUBLE PRECISION, TIMESTAMP WITH TIME ZONE, and array types.
|
||||
func (p *PgSQLParser) parseColumnDef(def string, index int) (*gdb.TableField, error) {
|
||||
tokens := mysqlTokenize(def)
|
||||
if len(tokens) < 2 {
|
||||
return nil, fmt.Errorf("invalid column definition: %s", def)
|
||||
}
|
||||
|
||||
field := &gdb.TableField{
|
||||
Index: index,
|
||||
Name: unquoteIdentifier(tokens[0]),
|
||||
Null: true,
|
||||
}
|
||||
|
||||
// Handle SERIAL types
|
||||
typeToken := strings.ToUpper(tokens[1])
|
||||
switch typeToken {
|
||||
case "SERIAL":
|
||||
field.Type = "int"
|
||||
field.Extra = "auto_increment"
|
||||
field.Null = false
|
||||
case "BIGSERIAL":
|
||||
field.Type = "bigint"
|
||||
field.Extra = "auto_increment"
|
||||
field.Null = false
|
||||
case "SMALLSERIAL":
|
||||
field.Type = "smallint"
|
||||
field.Extra = "auto_increment"
|
||||
field.Null = false
|
||||
default:
|
||||
field.Type = tokens[1]
|
||||
}
|
||||
|
||||
rest := ""
|
||||
if len(tokens) > 2 {
|
||||
rest = strings.Join(tokens[2:], " ")
|
||||
}
|
||||
upperType := strings.ToUpper(field.Type)
|
||||
upperRest := strings.ToUpper(rest)
|
||||
|
||||
switch {
|
||||
case upperType == "CHARACTER" && strings.HasPrefix(upperRest, "VARYING"):
|
||||
rest = strings.TrimSpace(rest[len("VARYING"):])
|
||||
if strings.HasPrefix(rest, "(") {
|
||||
end := strings.Index(rest, ")")
|
||||
if end >= 0 {
|
||||
field.Type = "character varying" + rest[:end+1]
|
||||
rest = strings.TrimSpace(rest[end+1:])
|
||||
}
|
||||
} else {
|
||||
field.Type = "character varying"
|
||||
}
|
||||
case upperType == "DOUBLE" && strings.HasPrefix(upperRest, "PRECISION"):
|
||||
field.Type = "double precision"
|
||||
rest = strings.TrimSpace(rest[len("PRECISION"):])
|
||||
case (upperType == "TIMESTAMP" || upperType == "TIME") &&
|
||||
(strings.HasPrefix(upperRest, "WITH TIME ZONE") || strings.HasPrefix(upperRest, "WITHOUT TIME ZONE")):
|
||||
if strings.HasPrefix(upperRest, "WITH TIME ZONE") {
|
||||
if upperType == "TIMESTAMP" {
|
||||
field.Type = "timestamptz"
|
||||
} else {
|
||||
field.Type = "time with time zone"
|
||||
}
|
||||
rest = strings.TrimSpace(rest[len("WITH TIME ZONE"):])
|
||||
} else {
|
||||
field.Type = strings.ToLower(upperType)
|
||||
rest = strings.TrimSpace(rest[len("WITHOUT TIME ZONE"):])
|
||||
}
|
||||
case !strings.Contains(field.Type, "(") && strings.HasPrefix(strings.TrimSpace(rest), "("):
|
||||
end := strings.Index(rest, ")")
|
||||
if end >= 0 {
|
||||
field.Type += rest[:end+1]
|
||||
rest = strings.TrimSpace(rest[end+1:])
|
||||
}
|
||||
}
|
||||
|
||||
// Handle array types
|
||||
if strings.HasPrefix(rest, "[]") {
|
||||
field.Type += "[]"
|
||||
rest = strings.TrimSpace(rest[2:])
|
||||
} else if strings.HasPrefix(strings.ToUpper(rest), "ARRAY") {
|
||||
field.Type += "[]"
|
||||
rest = strings.TrimSpace(rest[5:])
|
||||
}
|
||||
|
||||
p.parseColumnAttributes(field, rest)
|
||||
|
||||
return field, nil
|
||||
}
|
||||
|
||||
// parseColumnAttributes parses PostgreSQL column constraint keywords including
|
||||
// NOT NULL, NULL, PRIMARY KEY, UNIQUE, DEFAULT, GENERATED ... AS IDENTITY, and REFERENCES.
|
||||
func (p *PgSQLParser) parseColumnAttributes(field *gdb.TableField, attrs string) {
|
||||
words := strings.Fields(attrs)
|
||||
upperWords := strings.Fields(strings.ToUpper(attrs))
|
||||
|
||||
for i := 0; i < len(upperWords); i++ {
|
||||
switch upperWords[i] {
|
||||
case "NOT":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "NULL" {
|
||||
field.Null = false
|
||||
i++
|
||||
}
|
||||
case "NULL":
|
||||
field.Null = true
|
||||
case "PRIMARY":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "KEY" {
|
||||
field.Key = "PRI"
|
||||
i++
|
||||
}
|
||||
case "UNIQUE":
|
||||
if field.Key == "" {
|
||||
field.Key = "UNI"
|
||||
}
|
||||
case "DEFAULT":
|
||||
if i+1 < len(words) {
|
||||
defaultVal, _ := extractDefaultValue("DEFAULT " + strings.Join(words[i+1:], " "))
|
||||
field.Default = defaultVal
|
||||
if defaultVal != nil {
|
||||
i++
|
||||
}
|
||||
}
|
||||
case "GENERATED":
|
||||
if containsSequence(upperWords[i:], "ALWAYS", "AS", "IDENTITY") ||
|
||||
containsSequence(upperWords[i:], "BY", "DEFAULT", "AS", "IDENTITY") {
|
||||
field.Extra = "auto_increment"
|
||||
for j := i + 1; j < len(upperWords); j++ {
|
||||
if upperWords[j] == "IDENTITY" {
|
||||
i = j
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
case "REFERENCES":
|
||||
for j := i + 1; j < len(upperWords); j++ {
|
||||
i = j
|
||||
if strings.Contains(words[j], ")") {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// containsSequence checks if words slice contains the given word sequence starting from index 1.
|
||||
func containsSequence(words []string, seq ...string) bool {
|
||||
if len(words) < len(seq)+1 {
|
||||
return false
|
||||
}
|
||||
for i, s := range seq {
|
||||
if words[i+1] != s {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
@ -1,232 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func Test_PgSQL_CreateTable_Basic(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
name VARCHAR(100) NOT NULL,
|
||||
email CHARACTER VARYING(200),
|
||||
score DOUBLE PRECISION DEFAULT 0.0,
|
||||
metadata JSONB,
|
||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
|
||||
is_active BOOLEAN NOT NULL DEFAULT TRUE
|
||||
);
|
||||
COMMENT ON COLUMN users.name IS 'User full name';
|
||||
COMMENT ON COLUMN users.email IS 'Email address';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 7)
|
||||
|
||||
// BIGSERIAL should be auto_increment bigint
|
||||
t.Assert(fields["id"].Type, "bigint")
|
||||
t.Assert(fields["id"].Extra, "auto_increment")
|
||||
t.Assert(fields["id"].Key, "PRI")
|
||||
|
||||
// CHARACTER VARYING
|
||||
t.AssertNE(fields["email"], nil)
|
||||
|
||||
// DOUBLE PRECISION
|
||||
t.Assert(fields["score"].Type, "double precision")
|
||||
|
||||
// JSONB
|
||||
t.Assert(fields["metadata"].Type, "JSONB")
|
||||
|
||||
// TIMESTAMP WITH TIME ZONE
|
||||
t.Assert(fields["created_at"].Type, "timestamptz")
|
||||
|
||||
// COMMENT ON COLUMN
|
||||
t.Assert(fields["name"].Comment, "User full name")
|
||||
t.Assert(fields["email"].Comment, "Email address")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_PgSQL_AlterTable_AddColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id SERIAL PRIMARY KEY,
|
||||
name VARCHAR(100) NOT NULL
|
||||
);
|
||||
ALTER TABLE users ADD COLUMN email VARCHAR(200);
|
||||
COMMENT ON COLUMN users.email IS 'User email';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 3)
|
||||
t.Assert(fields["email"].Name, "email")
|
||||
t.Assert(fields["email"].Comment, "User email")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_PgSQL_AlterTable_AlterColumnType(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id SERIAL PRIMARY KEY,
|
||||
name VARCHAR(100)
|
||||
);
|
||||
ALTER TABLE users ALTER COLUMN name TYPE VARCHAR(200);
|
||||
ALTER TABLE users ALTER COLUMN name SET NOT NULL;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(fields["name"].Type, "VARCHAR(200)")
|
||||
t.Assert(fields["name"].Null, false)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_PgSQL_AlterTable_DropColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id SERIAL PRIMARY KEY,
|
||||
name VARCHAR(100),
|
||||
old_col TEXT
|
||||
);
|
||||
ALTER TABLE users DROP COLUMN old_col;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 2)
|
||||
_, ok := fields["old_col"]
|
||||
t.Assert(ok, false)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_PgSQL_AlterTable_RenameColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id SERIAL PRIMARY KEY,
|
||||
old_name VARCHAR(100)
|
||||
);
|
||||
ALTER TABLE users RENAME COLUMN old_name TO new_name;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
_, ok := fields["old_name"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["new_name"].Name, "new_name")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_PgSQL_MultipleMigrations(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
|
||||
// V1
|
||||
err := processSQL(parser, `
|
||||
CREATE TABLE products (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
name VARCHAR(100) NOT NULL,
|
||||
price NUMERIC(10,2) DEFAULT 0.00
|
||||
);
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
// V2: add, alter, comment
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE products ADD COLUMN category VARCHAR(50);
|
||||
ALTER TABLE products ALTER COLUMN name TYPE VARCHAR(200);
|
||||
ALTER TABLE products ALTER COLUMN name SET NOT NULL;
|
||||
COMMENT ON COLUMN products.category IS 'Product category';
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
// V3: rename, drop
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE products RENAME COLUMN category TO product_category;
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["products"]
|
||||
t.Assert(len(fields), 4)
|
||||
t.Assert(fields["name"].Type, "VARCHAR(200)")
|
||||
t.Assert(fields["name"].Null, false)
|
||||
_, ok := fields["category"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["product_category"].Name, "product_category")
|
||||
t.Assert(fields["product_category"].Comment, "Product category")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_PgSQL_FullMigrationScenario(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
|
||||
// V001: Initial
|
||||
err := processSQL(parser, `
|
||||
CREATE TABLE users (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
name VARCHAR(100) NOT NULL,
|
||||
email VARCHAR(200) UNIQUE
|
||||
);
|
||||
COMMENT ON COLUMN users.name IS 'User name';
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
// V002: Add, alter type, set not null
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE users ADD COLUMN avatar TEXT;
|
||||
ALTER TABLE users ALTER COLUMN name TYPE VARCHAR(200);
|
||||
ALTER TABLE users ALTER COLUMN email SET NOT NULL;
|
||||
COMMENT ON COLUMN users.avatar IS 'Avatar URL';
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 4)
|
||||
t.Assert(fields["name"].Type, "VARCHAR(200)")
|
||||
t.Assert(fields["email"].Null, false)
|
||||
t.Assert(fields["avatar"].Comment, "Avatar URL")
|
||||
|
||||
// V003: Rename column, drop not null
|
||||
err = processSQL(parser, `
|
||||
ALTER TABLE users RENAME COLUMN avatar TO profile_image;
|
||||
ALTER TABLE users ALTER COLUMN email DROP NOT NULL;
|
||||
`, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
_, ok := fields["avatar"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["profile_image"].Name, "profile_image")
|
||||
t.Assert(fields["email"].Null, true)
|
||||
})
|
||||
}
|
||||
@ -1,159 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
)
|
||||
|
||||
// SQLiteParser implements SQLParser for SQLite DDL.
|
||||
type SQLiteParser struct{}
|
||||
|
||||
// ParseCreateTable parses a single SQLite CREATE TABLE statement.
|
||||
func (p *SQLiteParser) ParseCreateTable(stmt string) (string, map[string]*gdb.TableField, error) {
|
||||
body, _, ok := extractBodyAndTrailing(stmt)
|
||||
if !ok {
|
||||
return "", nil, nil
|
||||
}
|
||||
|
||||
parenIdx := strings.Index(stmt, "(")
|
||||
header := stmt[:parenIdx]
|
||||
tableName := extractTableName(header)
|
||||
if tableName == "" {
|
||||
return "", nil, fmt.Errorf("cannot extract table name from: %s", header)
|
||||
}
|
||||
|
||||
columnDefs := splitColumns(body)
|
||||
fields := make(map[string]*gdb.TableField)
|
||||
pkColumns := findPrimaryKeysFromConstraints(columnDefs)
|
||||
|
||||
fieldIndex := 0
|
||||
for _, def := range columnDefs {
|
||||
def = strings.TrimSpace(def)
|
||||
if def == "" {
|
||||
continue
|
||||
}
|
||||
firstWord := strings.ToUpper(strings.Fields(def)[0])
|
||||
if isConstraintKeyword(firstWord) {
|
||||
continue
|
||||
}
|
||||
|
||||
field, err := p.parseColumnDef(def, fieldIndex)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
if field != nil {
|
||||
fields[field.Name] = field
|
||||
fieldIndex++
|
||||
}
|
||||
}
|
||||
|
||||
for _, pkCol := range pkColumns {
|
||||
if f, ok := fields[pkCol]; ok {
|
||||
f.Key = "PRI"
|
||||
}
|
||||
}
|
||||
|
||||
return tableName, fields, nil
|
||||
}
|
||||
|
||||
// ParseAlterTable parses SQLite ALTER TABLE statements.
|
||||
// Note: SQLite only supports ADD COLUMN and RENAME COLUMN in ALTER TABLE.
|
||||
func (p *SQLiteParser) ParseAlterTable(stmt string, tables map[string]map[string]*gdb.TableField) error {
|
||||
return parseAlterTableCommon(stmt, tables, p.parseColumnDef)
|
||||
}
|
||||
|
||||
// ParseComment is a no-op for SQLite as it doesn't support COMMENT ON statements.
|
||||
func (p *SQLiteParser) ParseComment(stmt string, tables map[string]map[string]*gdb.TableField) {
|
||||
// SQLite does not support comments on columns.
|
||||
}
|
||||
|
||||
// parseColumnDef parses a single SQLite column definition string into a TableField.
|
||||
// SQLite has flexible typing (type affinity), so columns may have no explicit type,
|
||||
// in which case "text" is used as the default type.
|
||||
func (p *SQLiteParser) parseColumnDef(def string, index int) (*gdb.TableField, error) {
|
||||
tokens := mysqlTokenize(def)
|
||||
if len(tokens) < 1 {
|
||||
return nil, fmt.Errorf("invalid column definition: %s", def)
|
||||
}
|
||||
|
||||
field := &gdb.TableField{
|
||||
Index: index,
|
||||
Name: unquoteIdentifier(tokens[0]),
|
||||
Null: true,
|
||||
}
|
||||
|
||||
if len(tokens) < 2 {
|
||||
field.Type = "text"
|
||||
return field, nil
|
||||
}
|
||||
|
||||
field.Type = tokens[1]
|
||||
|
||||
rest := ""
|
||||
if len(tokens) > 2 {
|
||||
rest = strings.Join(tokens[2:], " ")
|
||||
}
|
||||
|
||||
if !strings.Contains(field.Type, "(") && strings.HasPrefix(strings.TrimSpace(rest), "(") {
|
||||
end := strings.Index(rest, ")")
|
||||
if end >= 0 {
|
||||
field.Type += rest[:end+1]
|
||||
rest = strings.TrimSpace(rest[end+1:])
|
||||
}
|
||||
}
|
||||
|
||||
p.parseColumnAttributes(field, rest)
|
||||
|
||||
return field, nil
|
||||
}
|
||||
|
||||
// parseColumnAttributes parses SQLite column constraint keywords including
|
||||
// NOT NULL, NULL, PRIMARY KEY (with optional AUTOINCREMENT), UNIQUE, and DEFAULT.
|
||||
func (p *SQLiteParser) parseColumnAttributes(field *gdb.TableField, attrs string) {
|
||||
words := strings.Fields(attrs)
|
||||
upperWords := strings.Fields(strings.ToUpper(attrs))
|
||||
|
||||
for i := 0; i < len(upperWords); i++ {
|
||||
switch upperWords[i] {
|
||||
case "NOT":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "NULL" {
|
||||
field.Null = false
|
||||
i++
|
||||
}
|
||||
case "NULL":
|
||||
field.Null = true
|
||||
case "PRIMARY":
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "KEY" {
|
||||
field.Key = "PRI"
|
||||
field.Null = false
|
||||
i++
|
||||
if i+1 < len(upperWords) && upperWords[i+1] == "AUTOINCREMENT" {
|
||||
field.Extra = "auto_increment"
|
||||
i++
|
||||
}
|
||||
}
|
||||
case "AUTOINCREMENT":
|
||||
field.Extra = "auto_increment"
|
||||
case "UNIQUE":
|
||||
if field.Key == "" {
|
||||
field.Key = "UNI"
|
||||
}
|
||||
case "DEFAULT":
|
||||
if i+1 < len(words) {
|
||||
defaultVal, _ := extractDefaultValue("DEFAULT " + strings.Join(words[i+1:], " "))
|
||||
field.Default = defaultVal
|
||||
if defaultVal != nil {
|
||||
i++
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,112 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func Test_SQLite_CreateTable_Basic(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &SQLiteParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name TEXT NOT NULL,
|
||||
email TEXT,
|
||||
age INTEGER DEFAULT 0,
|
||||
score REAL DEFAULT 0.0,
|
||||
is_active BOOLEAN NOT NULL DEFAULT 1
|
||||
);
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 6)
|
||||
|
||||
t.Assert(fields["id"].Key, "PRI")
|
||||
t.Assert(fields["id"].Extra, "auto_increment")
|
||||
t.Assert(fields["id"].Null, false)
|
||||
|
||||
t.Assert(fields["name"].Null, false)
|
||||
t.Assert(fields["email"].Null, true)
|
||||
t.Assert(fields["age"].Default, "0")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_SQLite_AlterTable_AddColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &SQLiteParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name TEXT NOT NULL
|
||||
);
|
||||
ALTER TABLE users ADD COLUMN email TEXT;
|
||||
ALTER TABLE users ADD COLUMN phone TEXT DEFAULT '';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 4)
|
||||
t.Assert(fields["email"].Name, "email")
|
||||
t.Assert(fields["phone"].Name, "phone")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_SQLite_AlterTable_DropColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &SQLiteParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name TEXT NOT NULL,
|
||||
old_col TEXT,
|
||||
email TEXT
|
||||
);
|
||||
ALTER TABLE users DROP COLUMN old_col;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 3)
|
||||
_, ok := fields["old_col"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["name"].Name, "name")
|
||||
t.Assert(fields["email"].Name, "email")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_SQLite_RenameColumn(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &SQLiteParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (
|
||||
id INTEGER PRIMARY KEY,
|
||||
old_name TEXT NOT NULL
|
||||
);
|
||||
ALTER TABLE users RENAME COLUMN old_name TO new_name;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
|
||||
fields := tables["users"]
|
||||
_, ok := fields["old_name"]
|
||||
t.Assert(ok, false)
|
||||
t.Assert(fields["new_name"].Name, "new_name")
|
||||
})
|
||||
}
|
||||
@ -1,302 +0,0 @@
|
||||
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package gendao
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
// ===========================
|
||||
// Common parser utilities tests
|
||||
// ===========================
|
||||
|
||||
func Test_splitSQLStatements(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
stmts := splitSQLStatements("CREATE TABLE t1 (id INT); ALTER TABLE t1 ADD COLUMN name VARCHAR(100);")
|
||||
t.Assert(len(stmts), 2)
|
||||
t.AssertIN("CREATE TABLE t1 (id INT)", stmts)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_splitSQLStatements_WithComments(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
sql := `
|
||||
-- This is a comment
|
||||
CREATE TABLE t1 (id INT);
|
||||
/* Block comment */
|
||||
ALTER TABLE t1 ADD COLUMN name VARCHAR(100);
|
||||
`
|
||||
stmts := splitSQLStatements(sql)
|
||||
t.Assert(len(stmts), 2)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_splitSQLStatements_WithQuotedSemicolon(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
sql := `CREATE TABLE t1 (id INT, name VARCHAR(100) DEFAULT 'a;b');`
|
||||
stmts := splitSQLStatements(sql)
|
||||
t.Assert(len(stmts), 1)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_classifyStatement(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
t.Assert(classifyStatement("CREATE TABLE users (id INT)"), SQLStatementCreateTable)
|
||||
t.Assert(classifyStatement("CREATE TEMPORARY TABLE tmp (id INT)"), SQLStatementCreateTable)
|
||||
t.Assert(classifyStatement("ALTER TABLE users ADD COLUMN email VARCHAR(100)"), SQLStatementAlterTable)
|
||||
t.Assert(classifyStatement("ALTER TABLE users RENAME TO customers"), SQLStatementRenameTable)
|
||||
t.Assert(classifyStatement("DROP TABLE IF EXISTS users"), SQLStatementDropTable)
|
||||
t.Assert(classifyStatement("RENAME TABLE old_name TO new_name"), SQLStatementRenameTable)
|
||||
t.Assert(classifyStatement("COMMENT ON COLUMN users.name IS 'User name'"), SQLStatementComment)
|
||||
t.Assert(classifyStatement("SELECT * FROM users"), SQLStatementUnknown)
|
||||
t.Assert(classifyStatement("INSERT INTO users VALUES (1)"), SQLStatementUnknown)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_unquoteIdentifier(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
t.Assert(unquoteIdentifier("`users`"), "users")
|
||||
t.Assert(unquoteIdentifier(`"users"`), "users")
|
||||
t.Assert(unquoteIdentifier("[users]"), "users")
|
||||
t.Assert(unquoteIdentifier("users"), "users")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_extractTableName(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
t.Assert(extractTableName("CREATE TABLE users"), "users")
|
||||
t.Assert(extractTableName("CREATE TABLE IF NOT EXISTS users"), "users")
|
||||
t.Assert(extractTableName("CREATE TABLE `users`"), "users")
|
||||
t.Assert(extractTableName("CREATE TABLE mydb.users"), "users")
|
||||
t.Assert(extractTableName("CREATE TEMPORARY TABLE temp_users"), "temp_users")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_applyDropTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
tables := map[string]map[string]*gdb.TableField{
|
||||
"users": {},
|
||||
"logs": {},
|
||||
}
|
||||
applyDropTable("DROP TABLE IF EXISTS users", tables)
|
||||
t.Assert(len(tables), 1)
|
||||
_, ok := tables["users"]
|
||||
t.Assert(ok, false)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_applyRenameTable_MySQL(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
tables := map[string]map[string]*gdb.TableField{
|
||||
"old_name": {"id": {Index: 0, Name: "id", Type: "int"}},
|
||||
}
|
||||
applyRenameTable("RENAME TABLE old_name TO new_name", tables)
|
||||
t.Assert(len(tables), 1)
|
||||
_, ok := tables["new_name"]
|
||||
t.Assert(ok, true)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_applyRenameTable_PgSQL(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
tables := map[string]map[string]*gdb.TableField{
|
||||
"old_name": {"id": {Index: 0, Name: "id", Type: "int"}},
|
||||
}
|
||||
applyRenameTable("ALTER TABLE old_name RENAME TO new_name", tables)
|
||||
t.Assert(len(tables), 1)
|
||||
_, ok := tables["new_name"]
|
||||
t.Assert(ok, true)
|
||||
})
|
||||
}
|
||||
|
||||
// ===========================
|
||||
// Abnormal/edge-case parsing tests
|
||||
// ===========================
|
||||
|
||||
func Test_processSQL_OnlyDMLStatements(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
INSERT INTO users (id, name) VALUES (1, 'Alice');
|
||||
INSERT INTO users (id, name) VALUES (2, 'Bob');
|
||||
DELETE FROM users WHERE id = 1;
|
||||
UPDATE users SET name = 'Charlie' WHERE id = 2;
|
||||
SELECT * FROM users;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_EmptySQL(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
|
||||
// Empty string
|
||||
err := processSQL(parser, "", tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
|
||||
// Only whitespace and newlines
|
||||
err = processSQL(parser, " \n\n \t ", tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_OnlyComments(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
-- This is a line comment
|
||||
/* This is a block comment */
|
||||
-- Another comment
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_AlterNonExistentTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
ALTER TABLE non_existent ADD COLUMN email VARCHAR(200);
|
||||
ALTER TABLE non_existent DROP COLUMN name;
|
||||
ALTER TABLE non_existent MODIFY COLUMN name VARCHAR(200);
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_DropNonExistentTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `DROP TABLE IF EXISTS non_existent;`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_MixedDDLAndDML(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
INSERT INTO logs (msg) VALUES ('starting migration');
|
||||
CREATE TABLE users (
|
||||
id INT NOT NULL AUTO_INCREMENT,
|
||||
name VARCHAR(100) NOT NULL,
|
||||
PRIMARY KEY (id)
|
||||
);
|
||||
INSERT INTO users (name) VALUES ('Alice');
|
||||
ALTER TABLE users ADD COLUMN email VARCHAR(200);
|
||||
UPDATE users SET email = 'alice@example.com' WHERE id = 1;
|
||||
DELETE FROM logs WHERE msg = 'starting migration';
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
// Only DDL statements should be processed; DML should be skipped.
|
||||
t.Assert(len(tables), 1)
|
||||
fields := tables["users"]
|
||||
t.Assert(len(fields), 3)
|
||||
t.Assert(fields["id"].Key, "PRI")
|
||||
t.Assert(fields["email"].Name, "email")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_CommentOnNonExistentTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &PgSQLParser{}
|
||||
sql := `COMMENT ON COLUMN non_existent.col1 IS 'some comment';`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_RenameNonExistentTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `RENAME TABLE non_existent TO new_name;`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(tables), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_processSQL_DropColumnFromNonExistentTable(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
parser := &MySQLParser{}
|
||||
sql := `
|
||||
CREATE TABLE users (id INT, name VARCHAR(100), PRIMARY KEY (id));
|
||||
ALTER TABLE orders DROP COLUMN status;
|
||||
`
|
||||
tables := make(map[string]map[string]*gdb.TableField)
|
||||
err := processSQL(parser, sql, tables)
|
||||
t.AssertNil(err)
|
||||
// users table should still exist, orders ALTER should be silently ignored.
|
||||
t.Assert(len(tables), 1)
|
||||
t.Assert(len(tables["users"]), 2)
|
||||
})
|
||||
}
|
||||
|
||||
// ===========================
|
||||
// CheckLocalTypeForFieldType Tests
|
||||
// ===========================
|
||||
|
||||
func Test_CheckLocalTypeForFieldType(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
tests := []struct {
|
||||
fieldType string
|
||||
expected string
|
||||
}{
|
||||
{"int(10)", "int"},
|
||||
{"int(10) unsigned", "uint"},
|
||||
{"bigint(20)", "int64"},
|
||||
{"bigint(20) unsigned", "uint64"},
|
||||
{"tinyint(1)", "int"},
|
||||
{"varchar(100)", "string"},
|
||||
{"text", "string"},
|
||||
{"datetime", "datetime"},
|
||||
{"timestamp", "datetime"},
|
||||
{"timestamptz", "datetime"},
|
||||
{"date", "date"},
|
||||
{"time", "time"},
|
||||
{"json", "json"},
|
||||
{"jsonb", "jsonb"},
|
||||
{"float", "float64"},
|
||||
{"double", "float64"},
|
||||
{"decimal(10,2)", "string"},
|
||||
{"bool", "bool"},
|
||||
{"boolean", "bool"},
|
||||
{"blob", "[]byte"},
|
||||
{"binary(16)", "[]byte"},
|
||||
{"bit(1)", "bool"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
localType, err := gdb.CheckLocalTypeForFieldType(tt.fieldType)
|
||||
t.AssertNil(err)
|
||||
t.Assert(string(localType), tt.expected)
|
||||
}
|
||||
})
|
||||
}
|
||||
@ -20,20 +20,14 @@ import (
|
||||
"github.com/gogf/gf/v2/text/gstr"
|
||||
)
|
||||
|
||||
// generateStructDefinitionInput holds parameters for generating a Go struct definition
|
||||
// from database table fields.
|
||||
type generateStructDefinitionInput struct {
|
||||
CGenDaoInternalInput
|
||||
TableName string // Original database table name.
|
||||
StructName string // Go struct name (CamelCase of table name).
|
||||
FieldMap map[string]*gdb.TableField // Map of column name to field metadata.
|
||||
IsDo bool // Whether generating a DO struct (uses g.Meta orm tag).
|
||||
TableName string // Table name.
|
||||
StructName string // Struct name.
|
||||
FieldMap map[string]*gdb.TableField // Table field map.
|
||||
IsDo bool // Is generating DTO struct.
|
||||
}
|
||||
|
||||
// generateStructDefinition generates a complete Go struct definition string from table fields.
|
||||
// It returns the struct source code and a list of additional import paths needed
|
||||
// by custom type mappings. The fields are rendered in a table-aligned format
|
||||
// using tablewriter for consistent code formatting.
|
||||
func generateStructDefinition(ctx context.Context, in generateStructDefinitionInput) (string, []string) {
|
||||
var appendImports []string
|
||||
buffer := bytes.NewBuffer(nil)
|
||||
@ -65,10 +59,6 @@ func generateStructDefinition(ctx context.Context, in generateStructDefinitionIn
|
||||
return buffer.String(), appendImports
|
||||
}
|
||||
|
||||
// getTypeMappingInfo looks up a database field type in the type mapping configuration.
|
||||
// It handles exact matches first, then tries to extract the base type name from
|
||||
// parameterized types like "varchar(255)" or "numeric(10,2) unsigned".
|
||||
// Returns the mapped Go type name and its import path (if any).
|
||||
func getTypeMappingInfo(
|
||||
ctx context.Context, fieldType string, inTypeMapping map[DBFieldTypeName]CustomAttributeType,
|
||||
) (typeNameStr, importStr string) {
|
||||
@ -115,17 +105,9 @@ func generateStructFieldDefinition(
|
||||
}
|
||||
|
||||
if localTypeNameStr == "" {
|
||||
if in.DB != nil {
|
||||
localTypeName, err = in.DB.CheckLocalTypeForField(ctx, field.Type, nil)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
} else {
|
||||
// SQL file mode: use standalone type checking without database connection.
|
||||
localTypeName, err = gdb.CheckLocalTypeForFieldType(field.Type)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
localTypeName, err = in.DB.CheckLocalTypeForField(ctx, field.Type, nil)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
localTypeNameStr = string(localTypeName)
|
||||
switch localTypeName {
|
||||
@ -199,12 +181,11 @@ func generateStructFieldDefinition(
|
||||
return attrLines, appendImport
|
||||
}
|
||||
|
||||
// FieldNameCase defines the naming convention for converting field names to Go identifiers.
|
||||
type FieldNameCase string
|
||||
|
||||
const (
|
||||
FieldNameCaseCamel FieldNameCase = "CaseCamel" // PascalCase: "user_name" -> "UserName"
|
||||
FieldNameCaseCamelLower FieldNameCase = "CaseCamelLower" // camelCase: "user_name" -> "userName"
|
||||
FieldNameCaseCamel FieldNameCase = "CaseCamel"
|
||||
FieldNameCaseCamelLower FieldNameCase = "CaseCamelLower"
|
||||
)
|
||||
|
||||
// formatFieldName formats and returns a new field name that is used for golang codes generating.
|
||||
@ -227,6 +208,28 @@ func formatFieldName(fieldName string, nameCase FieldNameCase) string {
|
||||
}
|
||||
}
|
||||
|
||||
// formatFileName formats and returns a new file name for generated source files.
|
||||
func formatFileName(fileName, nameCase string) string {
|
||||
if nameCase == "" {
|
||||
nameCase = string(gstr.Snake)
|
||||
}
|
||||
fileName = normalizeNameForCaseConvert(fileName)
|
||||
fileName = gstr.Trim(gstr.CaseConvert(fileName, gstr.CaseTypeMatch(nameCase)), "-_.")
|
||||
if len(fileName) > 5 && fileName[len(fileName)-5:] == "_test" {
|
||||
// Add suffix to avoid the table name which contains "_test",
|
||||
// which would make the go file a testing file.
|
||||
fileName += "_table"
|
||||
}
|
||||
return fileName
|
||||
}
|
||||
|
||||
func normalizeNameForCaseConvert(name string) string {
|
||||
if isAllUpper(name) {
|
||||
return strings.ToLower(name)
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
// isAllUpper checks and returns whether given `fieldName` all letters are upper case.
|
||||
func isAllUpper(fieldName string) bool {
|
||||
for _, b := range fieldName {
|
||||
|
||||
@ -17,7 +17,6 @@ import (
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/os/gfile"
|
||||
"github.com/gogf/gf/v2/os/gview"
|
||||
"github.com/gogf/gf/v2/text/gstr"
|
||||
"github.com/gogf/gf/v2/util/gconv"
|
||||
|
||||
"github.com/gogf/gf/cmd/gf/v2/internal/consts"
|
||||
@ -62,18 +61,12 @@ type generateTableSingleInput struct {
|
||||
// generateTableSingle generates dao files for a single table.
|
||||
func generateTableSingle(ctx context.Context, in generateTableSingleInput) {
|
||||
// Generating table data preparing.
|
||||
fieldMap, err := getTableFields(ctx, in.CGenDaoInternalInput, in.TableName)
|
||||
fieldMap, err := in.DB.TableFields(ctx, in.TableName)
|
||||
if err != nil {
|
||||
mlog.Fatalf(`fetching tables fields failed for table "%s": %+v`, in.TableName, err)
|
||||
}
|
||||
|
||||
tableNameSnakeCase := gstr.CaseSnake(in.NewTableName)
|
||||
fileName := gstr.Trim(tableNameSnakeCase, "-_.")
|
||||
if len(fileName) > 5 && fileName[len(fileName)-5:] == "_test" {
|
||||
// Add suffix to avoid the table name which contains "_test",
|
||||
// which would make the go file a testing file.
|
||||
fileName += "_table"
|
||||
}
|
||||
fileName := formatFileName(in.NewTableName, in.FileNameCase)
|
||||
path := filepath.FromSlash(gfile.Join(in.DirPathTable, fileName+".go"))
|
||||
in.genItems.AppendGeneratedFilePath(path)
|
||||
if in.OverwriteDao || !gfile.Exists(path) {
|
||||
|
||||
@ -58,25 +58,30 @@ CONFIGURATION SUPPORT
|
||||
CGenDaoBriefStdTime = `use time.Time from stdlib instead of gtime.Time for generated time/date fields of tables`
|
||||
CGenDaoBriefWithTime = `add created time for auto produced go files`
|
||||
CGenDaoBriefGJsonSupport = `use gJsonSupport to use *gjson.Json instead of string for generated json fields of tables`
|
||||
CGenDaoBriefImportPrefix = `custom import prefix for generated go files`
|
||||
CGenDaoBriefDaoPath = `directory path for storing generated dao files under path`
|
||||
CGenDaoBriefTablePath = `directory path for storing generated table files under path`
|
||||
CGenDaoBriefDoPath = `directory path for storing generated do files under path`
|
||||
CGenDaoBriefEntityPath = `directory path for storing generated entity files under path`
|
||||
CGenDaoBriefOverwriteDao = `overwrite all dao files both inside/outside internal folder`
|
||||
CGenDaoBriefModelFile = `custom file name for storing generated model content`
|
||||
CGenDaoBriefModelFileForDao = `custom file name generating model for DAO operations like Where/Data. It's empty in default`
|
||||
CGenDaoBriefDescriptionTag = `add comment to description tag for each field`
|
||||
CGenDaoBriefNoJsonTag = `no json tag will be added for each field`
|
||||
CGenDaoBriefNoModelComment = `no model comment will be added for each field`
|
||||
CGenDaoBriefClear = `delete all generated go files that do not exist in database`
|
||||
CGenDaoBriefGenTable = `generate table files`
|
||||
CGenDaoBriefTypeMapping = `custom local type mapping for generated struct attributes relevant to fields of table`
|
||||
CGenDaoBriefFieldMapping = `custom local type mapping for generated struct attributes relevant to specific fields of table`
|
||||
CGenDaoBriefShardingPattern = `sharding pattern for table name, e.g. "users_?" will be replace tables "users_001,users_002,..." to "users" dao`
|
||||
CGenDaoBriefSqlDir = `directory path of SQL DDL files for generating dao/do/entity without database connection`
|
||||
CGenDaoBriefSqlType = `SQL dialect type when using sqlDir, options: mysql|pgsql|mssql|oracle|sqlite, default is "mysql"`
|
||||
CGenDaoBriefGroup = `
|
||||
CGenDaoBriefFileNameCase = `
|
||||
generated go file name case for dao/table/do/entity files, cases are as follows:
|
||||
| Case | Example |
|
||||
|---------------- |--------------------|
|
||||
| Snake | any_kind_of_string | default
|
||||
| SnakeFirstUpper | rgb_code_md5 |
|
||||
`
|
||||
CGenDaoBriefImportPrefix = `custom import prefix for generated go files`
|
||||
CGenDaoBriefDaoPath = `directory path for storing generated dao files under path`
|
||||
CGenDaoBriefTablePath = `directory path for storing generated table files under path`
|
||||
CGenDaoBriefDoPath = `directory path for storing generated do files under path`
|
||||
CGenDaoBriefEntityPath = `directory path for storing generated entity files under path`
|
||||
CGenDaoBriefOverwriteDao = `overwrite all dao files both inside/outside internal folder`
|
||||
CGenDaoBriefModelFile = `custom file name for storing generated model content`
|
||||
CGenDaoBriefModelFileForDao = `custom file name generating model for DAO operations like Where/Data. It's empty in default`
|
||||
CGenDaoBriefDescriptionTag = `add comment to description tag for each field`
|
||||
CGenDaoBriefNoJsonTag = `no json tag will be added for each field`
|
||||
CGenDaoBriefNoModelComment = `no model comment will be added for each field`
|
||||
CGenDaoBriefClear = `delete all generated go files that do not exist in database`
|
||||
CGenDaoBriefGenTable = `generate table files`
|
||||
CGenDaoBriefTypeMapping = `custom local type mapping for generated struct attributes relevant to fields of table`
|
||||
CGenDaoBriefFieldMapping = `custom local type mapping for generated struct attributes relevant to specific fields of table`
|
||||
CGenDaoBriefShardingPattern = `sharding pattern for table name, e.g. "users_?" will be replace tables "users_001,users_002,..." to "users" dao`
|
||||
CGenDaoBriefGroup = `
|
||||
specifying the configuration group name of database for generated ORM instance,
|
||||
it's not necessary and the default value is "default"
|
||||
`
|
||||
@ -97,23 +102,21 @@ generated json tag case for model struct, cases are as follows:
|
||||
CGenDaoBriefTplDaoDoPathPath = `template file path for dao do file`
|
||||
CGenDaoBriefTplDaoEntityPath = `template file path for dao entity file`
|
||||
|
||||
// Template variable names used by gview for rendering Go file templates.
|
||||
// These are passed to tplView.Assigns() and referenced in template files.
|
||||
tplVarTableName = `TplTableName` // Original database table name.
|
||||
tplVarTableNameCamelCase = `TplTableNameCamelCase` // PascalCase table name (e.g., "UserDetail").
|
||||
tplVarTableNameCamelLowerCase = `TplTableNameCamelLowerCase` // camelCase table name (e.g., "userDetail").
|
||||
tplVarTableSharding = `TplTableSharding` // Boolean: whether this is a sharding table.
|
||||
tplVarTableShardingPrefix = `TplTableShardingPrefix` // Sharding table name prefix (e.g., "user_").
|
||||
tplVarTableFields = `TplTableFields` // Generated table field definitions.
|
||||
tplVarPackageImports = `TplPackageImports` // Generated import block string.
|
||||
tplVarImportPrefix = `TplImportPrefix` // Go import path prefix for internal dao package.
|
||||
tplVarStructDefine = `TplStructDefine` // Generated struct definition string.
|
||||
tplVarColumnDefine = `TplColumnDefine` // Column struct field definitions for dao internal.
|
||||
tplVarColumnNames = `TplColumnNames` // Column name-to-string assignments for dao internal.
|
||||
tplVarGroupName = `TplGroupName` // Database configuration group name.
|
||||
tplVarDatetimeStr = `TplDatetimeStr` // Current datetime string for file headers.
|
||||
tplVarCreatedAtDatetimeStr = `TplCreatedAtDatetimeStr` // "Created at <datetime>" string (empty if WithTime is false).
|
||||
tplVarPackageName = `TplPackageName` // Go package name for the generated file.
|
||||
tplVarTableName = `TplTableName`
|
||||
tplVarTableNameCamelCase = `TplTableNameCamelCase`
|
||||
tplVarTableNameCamelLowerCase = `TplTableNameCamelLowerCase`
|
||||
tplVarTableSharding = `TplTableSharding`
|
||||
tplVarTableShardingPrefix = `TplTableShardingPrefix`
|
||||
tplVarTableFields = `TplTableFields`
|
||||
tplVarPackageImports = `TplPackageImports`
|
||||
tplVarImportPrefix = `TplImportPrefix`
|
||||
tplVarStructDefine = `TplStructDefine`
|
||||
tplVarColumnDefine = `TplColumnDefine`
|
||||
tplVarColumnNames = `TplColumnNames`
|
||||
tplVarGroupName = `TplGroupName`
|
||||
tplVarDatetimeStr = `TplDatetimeStr`
|
||||
tplVarCreatedAtDatetimeStr = `TplCreatedAtDatetimeStr`
|
||||
tplVarPackageName = `TplPackageName`
|
||||
)
|
||||
|
||||
func init() {
|
||||
@ -132,6 +135,7 @@ func init() {
|
||||
`CGenDaoBriefRemoveFieldPrefix`: CGenDaoBriefRemoveFieldPrefix,
|
||||
`CGenDaoBriefStdTime`: CGenDaoBriefStdTime,
|
||||
`CGenDaoBriefWithTime`: CGenDaoBriefWithTime,
|
||||
`CGenDaoBriefFileNameCase`: CGenDaoBriefFileNameCase,
|
||||
`CGenDaoBriefDaoPath`: CGenDaoBriefDaoPath,
|
||||
`CGenDaoBriefTablePath`: CGenDaoBriefTablePath,
|
||||
`CGenDaoBriefDoPath`: CGenDaoBriefDoPath,
|
||||
@ -149,8 +153,6 @@ func init() {
|
||||
`CGenDaoBriefTypeMapping`: CGenDaoBriefTypeMapping,
|
||||
`CGenDaoBriefFieldMapping`: CGenDaoBriefFieldMapping,
|
||||
`CGenDaoBriefShardingPattern`: CGenDaoBriefShardingPattern,
|
||||
`CGenDaoBriefSqlDir`: CGenDaoBriefSqlDir,
|
||||
`CGenDaoBriefSqlType`: CGenDaoBriefSqlType,
|
||||
`CGenDaoBriefGroup`: CGenDaoBriefGroup,
|
||||
`CGenDaoBriefJsonCase`: CGenDaoBriefJsonCase,
|
||||
`CGenDaoBriefTplDaoIndexPath`: CGenDaoBriefTplDaoIndexPath,
|
||||
|
||||
@ -10,6 +10,7 @@ import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
"github.com/gogf/gf/v2/text/gstr"
|
||||
)
|
||||
|
||||
// Test containsWildcard function.
|
||||
@ -180,3 +181,12 @@ func Test_filterTablesByPatterns_NonExistent(t *testing.T) {
|
||||
t.AssertNI("nonexistent", result)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_formatFileName(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
t.Assert(formatFileName("sys_i18n_message", ""), "sys_i_18_n_message")
|
||||
t.Assert(formatFileName("sys_i18n_message", string(gstr.SnakeFirstUpper)), "sys_i18n_message")
|
||||
t.Assert(formatFileName("SYS_I18N_MESSAGE", string(gstr.SnakeFirstUpper)), "sys_i18n_message")
|
||||
t.Assert(formatFileName("user_test", string(gstr.SnakeFirstUpper)), "user_test_table")
|
||||
})
|
||||
}
|
||||
|
||||
@ -85,7 +85,7 @@ func generateProject(ctx context.Context, srcPath, name, oldModule, newModule st
|
||||
// 6. Format the generated Go files using go/format (not imports.Process)
|
||||
// Note: We use formatGoFiles instead of utils.GoFmt because imports.Process
|
||||
// may incorrectly "fix" local import paths by replacing them with cached module paths.
|
||||
formatGoFiles(dstPath)
|
||||
FormatGoFiles(dstPath)
|
||||
|
||||
mlog.Print("Project generated successfully!")
|
||||
return nil
|
||||
@ -115,10 +115,10 @@ func upgradeDependencies(ctx context.Context, projectDir string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// formatGoFiles formats all Go files in the directory using go/format.
|
||||
// FormatGoFiles formats all Go files in the directory using go/format.
|
||||
// Unlike imports.Process, this only formats code without modifying imports,
|
||||
// which prevents incorrect "fixing" of local import paths.
|
||||
func formatGoFiles(dir string) {
|
||||
func FormatGoFiles(dir string) {
|
||||
files, err := findGoFiles(dir)
|
||||
if err != nil {
|
||||
mlog.Printf("Failed to find Go files for formatting: %v", err)
|
||||
|
||||
@ -4,7 +4,7 @@ go 1.23.0
|
||||
|
||||
toolchain go1.24.6
|
||||
|
||||
require github.com/gogf/gf/v2 v2.10.0
|
||||
require github.com/gogf/gf/v2 v2.10.2
|
||||
|
||||
require (
|
||||
go.opentelemetry.io/otel v1.38.0 // indirect
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -4,7 +4,7 @@ go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/apolloconfig/agollo/v4 v4.3.1
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
)
|
||||
|
||||
require (
|
||||
|
||||
@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/consul/v2
|
||||
go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
github.com/hashicorp/consul/api v1.24.0
|
||||
github.com/hashicorp/go-cleanhttp v0.5.2
|
||||
)
|
||||
|
||||
@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/kubecm/v2
|
||||
go 1.24.0
|
||||
|
||||
require (
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
k8s.io/api v0.33.4
|
||||
k8s.io/apimachinery v0.33.4
|
||||
k8s.io/client-go v0.33.4
|
||||
|
||||
@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/nacos/v2
|
||||
go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
github.com/nacos-group/nacos-sdk-go/v2 v2.3.3
|
||||
)
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/polaris/v2
|
||||
go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
github.com/polarismesh/polaris-go v1.6.1
|
||||
)
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/ClickHouse/clickhouse-go/v2 v2.0.15
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
github.com/google/uuid v1.6.0
|
||||
github.com/shopspring/decimal v1.3.1
|
||||
)
|
||||
|
||||
@ -6,7 +6,7 @@ replace github.com/gogf/gf/v2 => ../../../
|
||||
|
||||
require (
|
||||
gitee.com/chunanyong/dm v1.8.12
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
)
|
||||
|
||||
require (
|
||||
|
||||
@ -4,7 +4,7 @@ go 1.23.0
|
||||
|
||||
require (
|
||||
gitee.com/opengauss/openGauss-connector-go-pq v1.0.7
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
github.com/google/uuid v1.6.0
|
||||
)
|
||||
|
||||
|
||||
@ -3,8 +3,8 @@ module github.com/gogf/gf/contrib/drivers/mariadb/v2
|
||||
go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.2
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
)
|
||||
|
||||
require (
|
||||
|
||||
@ -9,6 +9,7 @@ package mariadb_test
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
_ "github.com/gogf/gf/contrib/drivers/mariadb/v2"
|
||||
@ -21,17 +22,22 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
TableSize = 10
|
||||
TableName = "user"
|
||||
TestSchema1 = "test1"
|
||||
TestSchema2 = "test2"
|
||||
TestDbPass = "12345678"
|
||||
CreateTime = "2018-10-24 10:00:00"
|
||||
TableSize = 10
|
||||
TableName = "user"
|
||||
TestSchema1 = "test1"
|
||||
TestSchema2 = "test2"
|
||||
TestPartitionDB = "test3"
|
||||
TableNamePrefix1 = "gf_"
|
||||
TestDbUser = "root"
|
||||
TestDbPass = "12345678"
|
||||
CreateTime = "2018-10-24 10:00:00"
|
||||
)
|
||||
|
||||
var (
|
||||
db gdb.DB
|
||||
db2 gdb.DB
|
||||
db3 gdb.DB
|
||||
dbPrefix gdb.DB
|
||||
dbInvalid gdb.DB
|
||||
ctx = context.TODO()
|
||||
)
|
||||
@ -42,10 +48,26 @@ func init() {
|
||||
Link: fmt.Sprintf("mariadb:root:%s@tcp(127.0.0.1:3307)/?loc=Local&parseTime=true", TestDbPass),
|
||||
TranTimeout: time.Second * 3,
|
||||
}
|
||||
err := gdb.AddConfigNode(gdb.DefaultGroupName, nodeDefault)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
partitionDefault := gdb.ConfigNode{
|
||||
Link: fmt.Sprintf("mariadb:root:%s@tcp(127.0.0.1:3307)/?loc=Local&parseTime=true", TestDbPass),
|
||||
Debug: true,
|
||||
TranTimeout: time.Second * 3,
|
||||
}
|
||||
nodePrefix := gdb.ConfigNode{
|
||||
Link: fmt.Sprintf("mariadb:root:%s@tcp(127.0.0.1:3307)/?loc=Local&parseTime=true", TestDbPass),
|
||||
TranTimeout: time.Second * 3,
|
||||
}
|
||||
nodePrefix.Prefix = TableNamePrefix1
|
||||
|
||||
nodeInvalid := gdb.ConfigNode{
|
||||
Link: fmt.Sprintf("mariadb:root:%s@tcp(127.0.0.1:3317)/?loc=Local&parseTime=true", TestDbPass),
|
||||
TranTimeout: time.Second * 3,
|
||||
}
|
||||
gdb.AddConfigNode("test", nodeDefault)
|
||||
gdb.AddConfigNode("prefix", nodePrefix)
|
||||
gdb.AddConfigNode("nodeinvalid", nodeInvalid)
|
||||
gdb.AddConfigNode("partition", partitionDefault)
|
||||
gdb.AddConfigNode(gdb.DefaultGroupName, nodeDefault)
|
||||
|
||||
// Default db.
|
||||
if r, err := gdb.NewByGroup(); err != nil {
|
||||
@ -60,15 +82,27 @@ func init() {
|
||||
if _, err := db.Exec(ctx, fmt.Sprintf(schemaTemplate, TestSchema2)); err != nil {
|
||||
gtest.Error(err)
|
||||
}
|
||||
if _, err := db.Exec(ctx, fmt.Sprintf(schemaTemplate, TestPartitionDB)); err != nil {
|
||||
gtest.Error(err)
|
||||
}
|
||||
db = db.Schema(TestSchema1)
|
||||
db2 = db.Schema(TestSchema2)
|
||||
|
||||
// Invalid db (wrong port for testing error handling).
|
||||
nodeInvalid := gdb.ConfigNode{
|
||||
Link: fmt.Sprintf("mariadb:root:%s@tcp(127.0.0.1:3317)/?loc=Local&parseTime=true", TestDbPass),
|
||||
TranTimeout: time.Second * 3,
|
||||
db3 = db.Schema(TestPartitionDB)
|
||||
// Prefix db.
|
||||
if r, err := gdb.NewByGroup("prefix"); err != nil {
|
||||
gtest.Error(err)
|
||||
} else {
|
||||
dbPrefix = r
|
||||
}
|
||||
gdb.AddConfigNode("nodeinvalid", nodeInvalid)
|
||||
if _, err := dbPrefix.Exec(ctx, fmt.Sprintf(schemaTemplate, TestSchema1)); err != nil {
|
||||
gtest.Error(err)
|
||||
}
|
||||
if _, err := dbPrefix.Exec(ctx, fmt.Sprintf(schemaTemplate, TestSchema2)); err != nil {
|
||||
gtest.Error(err)
|
||||
}
|
||||
dbPrefix = dbPrefix.Schema(TestSchema1)
|
||||
|
||||
// Invalid db.
|
||||
if r, err := gdb.NewByGroup("nodeinvalid"); err != nil {
|
||||
gtest.Error(err)
|
||||
} else {
|
||||
@ -140,3 +174,61 @@ func dropTableWithDb(db gdb.DB, table string) {
|
||||
gtest.Error(err)
|
||||
}
|
||||
}
|
||||
|
||||
func Test_PartitionTable(t *testing.T) {
|
||||
dropShopDBTable()
|
||||
createShopDBTable()
|
||||
insertShopDBData()
|
||||
|
||||
// defer dropShopDBTable()
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
data, err := db3.Ctx(ctx).Model("dbx_order").Partition("p3", "p4").All()
|
||||
t.AssertNil(err)
|
||||
dataLen := len(data)
|
||||
t.Assert(dataLen, 5)
|
||||
data, err = db3.Ctx(ctx).Model("dbx_order").Partition("p3").All()
|
||||
t.AssertNil(err)
|
||||
dataLen = len(data)
|
||||
t.Assert(dataLen, 5)
|
||||
})
|
||||
}
|
||||
|
||||
func createShopDBTable() {
|
||||
sql := `CREATE TABLE dbx_order (
|
||||
id int(11) NOT NULL,
|
||||
sales_date date DEFAULT NULL,
|
||||
amount decimal(10,2) DEFAULT NULL
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4
|
||||
PARTITION BY RANGE (YEAR(sales_date))
|
||||
(PARTITION p1 VALUES LESS THAN (2020) ENGINE = InnoDB,
|
||||
PARTITION p2 VALUES LESS THAN (2021) ENGINE = InnoDB,
|
||||
PARTITION p3 VALUES LESS THAN (2022) ENGINE = InnoDB,
|
||||
PARTITION p4 VALUES LESS THAN MAXVALUE ENGINE = InnoDB);`
|
||||
_, err := db3.Exec(ctx, sql)
|
||||
if err != nil {
|
||||
gtest.Fatal(err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func insertShopDBData() {
|
||||
data := g.Slice{}
|
||||
year := 2020
|
||||
for i := 1; i <= 5; i++ {
|
||||
year++
|
||||
data = append(data, g.Map{
|
||||
"id": i,
|
||||
"sales_date": fmt.Sprintf("%d-09-21", year),
|
||||
"amount": fmt.Sprintf("1%d.21", i),
|
||||
})
|
||||
}
|
||||
_, err := db3.Model("dbx_order").Ctx(ctx).Data(data).Insert()
|
||||
if err != nil {
|
||||
gtest.Error(err)
|
||||
}
|
||||
}
|
||||
|
||||
func dropShopDBTable() {
|
||||
if _, err := db3.Exec(ctx, "DROP TABLE IF EXISTS `dbx_order`"); err != nil {
|
||||
gtest.Error(err)
|
||||
}
|
||||
}
|
||||
|
||||
83
contrib/drivers/mariadb/mariadb_z_unit_basic_test.go
Normal file
83
contrib/drivers/mariadb/mariadb_z_unit_basic_test.go
Normal file
@ -0,0 +1,83 @@
|
||||
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package mariadb_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func Test_Instance(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
_, err := gdb.Instance("none")
|
||||
t.AssertNE(err, nil)
|
||||
|
||||
db, err := gdb.Instance()
|
||||
t.AssertNil(err)
|
||||
|
||||
err1 := db.PingMaster()
|
||||
err2 := db.PingSlave()
|
||||
t.Assert(err1, nil)
|
||||
t.Assert(err2, nil)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Func_FormatSqlWithArgs(t *testing.T) {
|
||||
// mysql
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
var s string
|
||||
s = gdb.FormatSqlWithArgs("select * from table where id>=? and sex=?", []any{100, 1})
|
||||
t.Assert(s, "select * from table where id>=100 and sex=1")
|
||||
})
|
||||
// mssql
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
var s string
|
||||
s = gdb.FormatSqlWithArgs("select * from table where id>=@p1 and sex=@p2", []any{100, 1})
|
||||
t.Assert(s, "select * from table where id>=100 and sex=1")
|
||||
})
|
||||
// pgsql
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
var s string
|
||||
s = gdb.FormatSqlWithArgs("select * from table where id>=$1 and sex=$2", []any{100, 1})
|
||||
t.Assert(s, "select * from table where id>=100 and sex=1")
|
||||
})
|
||||
// oracle
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
var s string
|
||||
s = gdb.FormatSqlWithArgs("select * from table where id>=:v1 and sex=:v2", []any{100, 1})
|
||||
t.Assert(s, "select * from table where id>=100 and sex=1")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Func_ToSQL(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
sql, err := gdb.ToSQL(ctx, func(ctx context.Context) error {
|
||||
value, err := db.Ctx(ctx).Model(TableName).Fields("nickname").Where("id", 1).Value()
|
||||
t.Assert(value, nil)
|
||||
return err
|
||||
})
|
||||
t.AssertNil(err)
|
||||
t.Assert(sql, "SELECT `nickname` FROM `user` WHERE `id`=1 LIMIT 1")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Func_CatchSQL(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
array, err := gdb.CatchSQL(ctx, func(ctx context.Context) error {
|
||||
value, err := db.Ctx(ctx).Model(table).Fields("nickname").Where("id", 1).Value()
|
||||
t.Assert(value, "name_1")
|
||||
return err
|
||||
})
|
||||
t.AssertNil(err)
|
||||
t.AssertGE(len(array), 1)
|
||||
})
|
||||
}
|
||||
1713
contrib/drivers/mariadb/mariadb_z_unit_core_test.go
Normal file
1713
contrib/drivers/mariadb/mariadb_z_unit_core_test.go
Normal file
File diff suppressed because it is too large
Load Diff
321
contrib/drivers/mariadb/mariadb_z_unit_feature_duplicate_test.go
Normal file
321
contrib/drivers/mariadb/mariadb_z_unit_feature_duplicate_test.go
Normal file
@ -0,0 +1,321 @@
|
||||
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package mariadb_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/os/gtime"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func createDuplicateTable(table ...string) string {
|
||||
var name string
|
||||
if len(table) > 0 {
|
||||
name = table[0]
|
||||
} else {
|
||||
name = fmt.Sprintf(`duplicate_table_%d`, gtime.TimestampNano())
|
||||
}
|
||||
dropTable(name)
|
||||
if _, err := db.Exec(ctx, fmt.Sprintf(`
|
||||
CREATE TABLE %s (
|
||||
id int(10) unsigned NOT NULL AUTO_INCREMENT,
|
||||
email varchar(100) NOT NULL,
|
||||
username varchar(45) NULL,
|
||||
score int(10) unsigned DEFAULT 0,
|
||||
login_count int(10) unsigned DEFAULT 0,
|
||||
PRIMARY KEY (id),
|
||||
UNIQUE KEY uk_email (email)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
|
||||
`, name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
func Test_OnDuplicateKeyUpdate_Basic(t *testing.T) {
|
||||
table := createDuplicateTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// First insert
|
||||
_, err := db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1", 100)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err := db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user1")
|
||||
t.Assert(one["score"], 100)
|
||||
|
||||
// Duplicate insert - should update
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1_updated", 200)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err = db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user1_updated")
|
||||
t.Assert(one["score"], 200)
|
||||
|
||||
// Verify only one record exists
|
||||
count, err := db.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 1)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_OnDuplicateKeyUpdate_Increment(t *testing.T) {
|
||||
table := createDuplicateTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// First insert
|
||||
_, err := db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, login_count) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE login_count = login_count + 1",
|
||||
table,
|
||||
), "user1@example.com", "user1", 1)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err := db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["login_count"], 1)
|
||||
|
||||
// Duplicate - increment login_count
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, login_count) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE login_count = login_count + 1",
|
||||
table,
|
||||
), "user1@example.com", "user1", 1)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err = db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["login_count"], 2)
|
||||
|
||||
// Third time
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, login_count) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE login_count = login_count + 1",
|
||||
table,
|
||||
), "user1@example.com", "user1", 1)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err = db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["login_count"], 3)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_OnDuplicateKeyUpdate_MultipleColumns(t *testing.T) {
|
||||
table := createDuplicateTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// First insert
|
||||
_, err := db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score, login_count) VALUES (?, ?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score), login_count = login_count + 1",
|
||||
table,
|
||||
), "user1@example.com", "user1", 100, 1)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err := db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user1")
|
||||
t.Assert(one["score"], 100)
|
||||
t.Assert(one["login_count"], 1)
|
||||
|
||||
// Duplicate - update multiple columns
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score, login_count) VALUES (?, ?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score), login_count = login_count + 1",
|
||||
table,
|
||||
), "user1@example.com", "user1_v2", 200, 1)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err = db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user1_v2")
|
||||
t.Assert(one["score"], 200)
|
||||
t.Assert(one["login_count"], 2)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_OnDuplicateKeyUpdate_Batch(t *testing.T) {
|
||||
table := createDuplicateTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert multiple records
|
||||
_, err := db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?), (?, ?, ?), (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1", 100,
|
||||
"user2@example.com", "user2", 200,
|
||||
"user3@example.com", "user3", 300)
|
||||
t.AssertNil(err)
|
||||
|
||||
count, err := db.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 3)
|
||||
|
||||
// Update with duplicate - should update specific records
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?), (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1_updated", 150,
|
||||
"user2@example.com", "user2_updated", 250)
|
||||
t.AssertNil(err)
|
||||
|
||||
// Still 3 records
|
||||
count, err = db.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 3)
|
||||
|
||||
// Verify updates
|
||||
one, err := db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user1_updated")
|
||||
t.Assert(one["score"], 150)
|
||||
|
||||
one, err = db.Model(table).Where("email", "user2@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user2_updated")
|
||||
t.Assert(one["score"], 250)
|
||||
|
||||
// user3 unchanged
|
||||
one, err = db.Model(table).Where("email", "user3@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user3")
|
||||
t.Assert(one["score"], 300)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_OnDuplicateKeyUpdate_ConditionalUpdate(t *testing.T) {
|
||||
table := createDuplicateTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// First insert
|
||||
_, err := db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE score = IF(VALUES(score) > score, VALUES(score), score)",
|
||||
table,
|
||||
), "user1@example.com", "user1", 100)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err := db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["score"], 100)
|
||||
|
||||
// Try to update with lower score - should not update
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE score = IF(VALUES(score) > score, VALUES(score), score)",
|
||||
table,
|
||||
), "user1@example.com", "user1", 50)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err = db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["score"], 100) // Still 100
|
||||
|
||||
// Update with higher score - should update
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE score = IF(VALUES(score) > score, VALUES(score), score)",
|
||||
table,
|
||||
), "user1@example.com", "user1", 150)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err = db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["score"], 150) // Updated to 150
|
||||
})
|
||||
}
|
||||
|
||||
func Test_OnDuplicateKeyUpdate_WithTransaction(t *testing.T) {
|
||||
table := createDuplicateTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Transaction with ON DUPLICATE KEY UPDATE
|
||||
err := db.Transaction(ctx, func(ctx context.Context, tx gdb.TX) error {
|
||||
// First insert
|
||||
_, err := tx.Exec(fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1", 100)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Duplicate in same transaction
|
||||
_, err = tx.Exec(fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1_updated", 200)
|
||||
return err
|
||||
})
|
||||
t.AssertNil(err)
|
||||
|
||||
// Verify final state
|
||||
one, err := db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user1_updated")
|
||||
t.Assert(one["score"], 200)
|
||||
|
||||
count, err := db.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 1)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_OnDuplicateKeyUpdate_MixedInsertUpdate(t *testing.T) {
|
||||
table := createDuplicateTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// First batch insert
|
||||
_, err := db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?), (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1", 100,
|
||||
"user2@example.com", "user2", 200)
|
||||
t.AssertNil(err)
|
||||
|
||||
count, err := db.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 2)
|
||||
|
||||
// Mixed batch: one duplicate, one new
|
||||
_, err = db.Exec(ctx, fmt.Sprintf(
|
||||
"INSERT INTO %s (email, username, score) VALUES (?, ?, ?), (?, ?, ?) ON DUPLICATE KEY UPDATE username = VALUES(username), score = VALUES(score)",
|
||||
table,
|
||||
), "user1@example.com", "user1_updated", 150,
|
||||
"user3@example.com", "user3", 300)
|
||||
t.AssertNil(err)
|
||||
|
||||
// Should have 3 records now
|
||||
count, err = db.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 3)
|
||||
|
||||
// Verify user1 was updated
|
||||
one, err := db.Model(table).Where("email", "user1@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user1_updated")
|
||||
t.Assert(one["score"], 150)
|
||||
|
||||
// Verify user3 was inserted
|
||||
one, err = db.Model(table).Where("email", "user3@example.com").One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["username"], "user3")
|
||||
t.Assert(one["score"], 300)
|
||||
})
|
||||
}
|
||||
394
contrib/drivers/mariadb/mariadb_z_unit_feature_json_test.go
Normal file
394
contrib/drivers/mariadb/mariadb_z_unit_feature_json_test.go
Normal file
@ -0,0 +1,394 @@
|
||||
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package mariadb_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/frame/g"
|
||||
"github.com/gogf/gf/v2/os/gtime"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func createJSONTable(table ...string) string {
|
||||
var name string
|
||||
if len(table) > 0 {
|
||||
name = table[0]
|
||||
} else {
|
||||
name = fmt.Sprintf(`json_table_%d`, gtime.TimestampNano())
|
||||
}
|
||||
dropTable(name)
|
||||
if _, err := db.Exec(ctx, fmt.Sprintf(`
|
||||
CREATE TABLE %s (
|
||||
id int(10) unsigned NOT NULL AUTO_INCREMENT,
|
||||
name varchar(45) NULL,
|
||||
config json NULL,
|
||||
metadata json NULL,
|
||||
PRIMARY KEY (id)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
|
||||
`, name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
func Test_JSON_Insert_Map(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
data := g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
"lang": "zh-CN",
|
||||
},
|
||||
"metadata": g.Map{
|
||||
"tags": g.Slice{"admin", "developer"},
|
||||
"level": 5,
|
||||
},
|
||||
}
|
||||
result, err := db.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.LastInsertId()
|
||||
t.Assert(n, 1)
|
||||
|
||||
one, err := db.Model(table).WherePri(1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["name"], "user1")
|
||||
t.AssertNE(one["config"], nil)
|
||||
t.AssertNE(one["metadata"], nil)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Insert_String(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
data := g.Map{
|
||||
"name": "user2",
|
||||
"config": `{"theme":"light","lang":"en-US"}`,
|
||||
"metadata": `{"tags":["user"],"level":1}`,
|
||||
}
|
||||
result, err := db.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.LastInsertId()
|
||||
t.Assert(n, 1)
|
||||
|
||||
one, err := db.Model(table).WherePri(1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["name"], "user2")
|
||||
t.AssertNE(one["config"], nil)
|
||||
t.AssertNE(one["metadata"], nil)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Insert_Null(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
data := g.Map{
|
||||
"name": "user3",
|
||||
"config": nil,
|
||||
"metadata": nil,
|
||||
}
|
||||
result, err := db.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.LastInsertId()
|
||||
t.Assert(n, 1)
|
||||
|
||||
one, err := db.Model(table).WherePri(1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["name"], "user3")
|
||||
t.Assert(one["config"], nil)
|
||||
t.Assert(one["metadata"], nil)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Update(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert initial data
|
||||
_, err := db.Model(table).Data(g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
},
|
||||
}).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Update JSON column
|
||||
result, err := db.Model(table).Data(g.Map{
|
||||
"config": g.Map{
|
||||
"theme": "light",
|
||||
"lang": "en-US",
|
||||
},
|
||||
}).WherePri(1).Update()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.RowsAffected()
|
||||
t.Assert(n, 1)
|
||||
|
||||
one, err := db.Model(table).WherePri(1).One()
|
||||
t.AssertNil(err)
|
||||
t.AssertNE(one["config"], nil)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Extract_Where(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert test data
|
||||
data := g.Slice{
|
||||
g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
"lang": "zh-CN",
|
||||
},
|
||||
},
|
||||
g.Map{
|
||||
"name": "user2",
|
||||
"config": g.Map{
|
||||
"theme": "light",
|
||||
"lang": "en-US",
|
||||
},
|
||||
},
|
||||
g.Map{
|
||||
"name": "user3",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
"lang": "en-US",
|
||||
},
|
||||
},
|
||||
}
|
||||
_, err := db.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Query by JSON field using JSON_EXTRACT
|
||||
all, err := db.Model(table).Where("JSON_EXTRACT(config, '$.theme') = ?", "dark").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 2)
|
||||
|
||||
all, err = db.Model(table).Where("JSON_EXTRACT(config, '$.lang') = ?", "en-US").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 2)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Extract_Select(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert test data
|
||||
_, err := db.Model(table).Data(g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
"lang": "zh-CN",
|
||||
},
|
||||
"metadata": g.Map{
|
||||
"level": 5,
|
||||
},
|
||||
}).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Select with JSON_EXTRACT
|
||||
one, err := db.Model(table).Fields("name, JSON_EXTRACT(config, '$.theme') as theme, JSON_EXTRACT(metadata, '$.level') as level").WherePri(1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["name"], "user1")
|
||||
t.AssertNE(one["theme"], nil)
|
||||
t.AssertNE(one["level"], nil)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Array_Query(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data with JSON array
|
||||
data := g.Slice{
|
||||
g.Map{
|
||||
"name": "user1",
|
||||
"metadata": g.Map{
|
||||
"tags": g.Slice{"admin", "developer"},
|
||||
},
|
||||
},
|
||||
g.Map{
|
||||
"name": "user2",
|
||||
"metadata": g.Map{
|
||||
"tags": g.Slice{"user"},
|
||||
},
|
||||
},
|
||||
g.Map{
|
||||
"name": "user3",
|
||||
"metadata": g.Map{
|
||||
"tags": g.Slice{"admin", "user"},
|
||||
},
|
||||
},
|
||||
}
|
||||
_, err := db.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Query by JSON array contains
|
||||
all, err := db.Model(table).Where("JSON_CONTAINS(metadata, ?, '$.tags')", `"admin"`).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 2)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Batch_Insert(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
data := g.Slice{
|
||||
g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
},
|
||||
},
|
||||
g.Map{
|
||||
"name": "user2",
|
||||
"config": g.Map{
|
||||
"theme": "light",
|
||||
},
|
||||
},
|
||||
g.Map{
|
||||
"name": "user3",
|
||||
"config": nil,
|
||||
},
|
||||
}
|
||||
result, err := db.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.RowsAffected()
|
||||
t.Assert(n, 3)
|
||||
|
||||
all, err := db.Model(table).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 3)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Scan_To_Struct(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
type Config struct {
|
||||
Theme string `json:"theme"`
|
||||
Lang string `json:"lang"`
|
||||
}
|
||||
type User struct {
|
||||
Id int
|
||||
Name string
|
||||
Config *Config
|
||||
}
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data
|
||||
_, err := db.Model(table).Data(g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
"lang": "zh-CN",
|
||||
},
|
||||
}).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Scan to struct
|
||||
var user User
|
||||
err = db.Model(table).WherePri(1).Scan(&user)
|
||||
t.AssertNil(err)
|
||||
t.Assert(user.Name, "user1")
|
||||
t.AssertNE(user.Config, nil)
|
||||
if user.Config != nil {
|
||||
t.Assert(user.Config.Theme, "dark")
|
||||
t.Assert(user.Config.Lang, "zh-CN")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Complex_Structure(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert complex nested JSON
|
||||
data := g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"ui": g.Map{
|
||||
"theme": "dark",
|
||||
"fontSize": g.Map{
|
||||
"base": 14,
|
||||
"code": 12,
|
||||
},
|
||||
},
|
||||
"editor": g.Map{
|
||||
"tabSize": 4,
|
||||
"wordWrap": true,
|
||||
},
|
||||
},
|
||||
}
|
||||
result, err := db.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.LastInsertId()
|
||||
t.Assert(n, 1)
|
||||
|
||||
// Query nested JSON path
|
||||
one, err := db.Model(table).Fields("JSON_EXTRACT(config, '$.ui.theme') as theme, JSON_EXTRACT(config, '$.ui.fontSize.base') as base_font").WherePri(1).One()
|
||||
t.AssertNil(err)
|
||||
t.AssertNE(one["theme"], nil)
|
||||
t.AssertNE(one["base_font"], nil)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_JSON_Transaction(t *testing.T) {
|
||||
table := createJSONTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
err := db.Transaction(ctx, func(ctx context.Context, tx gdb.TX) error {
|
||||
// Insert in transaction
|
||||
_, err := tx.Model(table).Ctx(ctx).Data(g.Map{
|
||||
"name": "user1",
|
||||
"config": g.Map{
|
||||
"theme": "dark",
|
||||
},
|
||||
}).Insert()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Update in transaction
|
||||
_, err = tx.Model(table).Ctx(ctx).Data(g.Map{
|
||||
"config": g.Map{
|
||||
"theme": "light",
|
||||
},
|
||||
}).WherePri(1).Update()
|
||||
return err
|
||||
})
|
||||
t.AssertNil(err)
|
||||
|
||||
// Verify data
|
||||
one, err := db.Model(table).WherePri(1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["name"], "user1")
|
||||
t.AssertNE(one["config"], nil)
|
||||
})
|
||||
}
|
||||
228
contrib/drivers/mariadb/mariadb_z_unit_feature_lock_test.go
Normal file
228
contrib/drivers/mariadb/mariadb_z_unit_feature_lock_test.go
Normal file
@ -0,0 +1,228 @@
|
||||
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package mariadb_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/frame/g"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
// Test_Model_Lock tests the Lock method with custom lock clause
|
||||
func Test_Model_Lock(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Test basic Lock with FOR UPDATE
|
||||
one, err := db.Model(table).Lock("FOR UPDATE").Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 1)
|
||||
|
||||
// Test Lock with legacy LOCK IN SHARE MODE (MariaDB/MySQL compatible)
|
||||
one, err = db.Model(table).Lock("LOCK IN SHARE MODE").Where("id", 3).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 3)
|
||||
|
||||
// Test Lock with predefined constants
|
||||
one, err = db.Model(table).Lock(gdb.LockForUpdate).Where("id", 4).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 4)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Model_LockUpdate tests the LockUpdate convenience method
|
||||
func Test_Model_LockUpdate(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Test LockUpdate is equivalent to Lock("FOR UPDATE")
|
||||
one, err := db.Model(table).LockUpdate().Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 1)
|
||||
t.Assert(one["passport"], "user_1")
|
||||
|
||||
// Test LockUpdate with All()
|
||||
all, err := db.Model(table).LockUpdate().Where("id<?", 4).Order("id").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 3)
|
||||
t.Assert(all[0]["id"], 1)
|
||||
t.Assert(all[2]["id"], 3)
|
||||
|
||||
// Test LockUpdate with Count()
|
||||
count, err := db.Model(table).LockUpdate().Where("id>?", 5).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 5)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Model_LockUpdateSkipLocked tests the LockUpdateSkipLocked convenience method
|
||||
// Note: SKIP LOCKED requires MariaDB 10.6+, skipped for compatibility
|
||||
// func Test_Model_LockUpdateSkipLocked(t *testing.T) {
|
||||
// table := createInitTable()
|
||||
// defer dropTable(table)
|
||||
//
|
||||
// gtest.C(t, func(t *gtest.T) {
|
||||
// // Test LockUpdateSkipLocked basic usage
|
||||
// one, err := db.Model(table).LockUpdateSkipLocked().Where("id", 1).One()
|
||||
// t.AssertNil(err)
|
||||
// t.Assert(one["id"], 1)
|
||||
//
|
||||
// // Test LockUpdateSkipLocked with All()
|
||||
// all, err := db.Model(table).LockUpdateSkipLocked().Where("id>?", 7).Order("id").All()
|
||||
// t.AssertNil(err)
|
||||
// t.Assert(len(all), 3)
|
||||
// })
|
||||
// }
|
||||
|
||||
// Test_Model_LockShared tests the LockShared convenience method
|
||||
func Test_Model_LockShared(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Test LockShared is equivalent to Lock("LOCK IN SHARE MODE")
|
||||
one, err := db.Model(table).LockShared().Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 1)
|
||||
|
||||
// Test LockShared with All()
|
||||
all, err := db.Model(table).LockShared().Where("id<=?", 5).Order("id").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 5)
|
||||
t.Assert(all[0]["id"], 1)
|
||||
t.Assert(all[4]["id"], 5)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Model_Lock_WithTransaction tests Lock methods within transaction
|
||||
func Test_Model_Lock_WithTransaction(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
err := db.Transaction(ctx, func(ctx context.Context, tx gdb.TX) error {
|
||||
// Lock row for update in transaction
|
||||
one, err := tx.Model(table).LockUpdate().Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 1)
|
||||
|
||||
// Update the locked row
|
||||
_, err = tx.Model(table).Data(g.Map{"nickname": "updated_name"}).Where("id", 1).Update()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Verify update
|
||||
updated, err := tx.Model(table).Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(updated["nickname"], "updated_name")
|
||||
|
||||
return nil
|
||||
})
|
||||
t.AssertNil(err)
|
||||
|
||||
// Verify transaction committed successfully
|
||||
one, err := db.Model(table).Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["nickname"], "updated_name")
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Model_Lock_ReleaseAfterCommit tests lock is released after transaction commit
|
||||
func Test_Model_Lock_ReleaseAfterCommit(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Start transaction and lock a row
|
||||
tx, err := db.Begin(ctx)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err := tx.Model(table).LockUpdate().Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 1)
|
||||
|
||||
// Update within transaction
|
||||
_, err = tx.Model(table).Data(g.Map{"nickname": "tx_update"}).Where("id", 1).Update()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Commit transaction - this should release the lock
|
||||
err = tx.Commit()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Another query should succeed without blocking
|
||||
one, err = db.Model(table).Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["nickname"], "tx_update")
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Model_Lock_ReleaseAfterRollback tests lock is released after transaction rollback
|
||||
func Test_Model_Lock_ReleaseAfterRollback(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Start transaction and lock a row
|
||||
tx, err := db.Begin(ctx)
|
||||
t.AssertNil(err)
|
||||
|
||||
one, err := tx.Model(table).LockUpdate().Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["id"], 1)
|
||||
|
||||
// Update within transaction
|
||||
_, err = tx.Model(table).Data(g.Map{"nickname": "rollback_update"}).Where("id", 1).Update()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Rollback transaction - this should release the lock and discard changes
|
||||
err = tx.Rollback()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Verify original value is preserved
|
||||
one, err = db.Model(table).Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["nickname"], "name_1")
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Model_Lock_ChainedMethods tests Lock with other chained methods
|
||||
func Test_Model_Lock_ChainedMethods(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Lock with Fields
|
||||
one, err := db.Model(table).Fields("id,passport").LockUpdate().Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(one), 2)
|
||||
t.Assert(one["id"], 1)
|
||||
t.Assert(one["passport"], "user_1")
|
||||
|
||||
// Lock with Order and Limit
|
||||
all, err := db.Model(table).LockShared().Where("id>?", 5).Order("id desc").Limit(3).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 3)
|
||||
t.Assert(all[0]["id"], 10)
|
||||
t.Assert(all[2]["id"], 8)
|
||||
|
||||
// Lock with Group and Having
|
||||
all, err = db.Model(table).Fields("LEFT(passport,4) as prefix, COUNT(*) as cnt").
|
||||
LockUpdate().
|
||||
Group("prefix").
|
||||
Having("cnt>?", 0).
|
||||
Order("prefix").
|
||||
All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 1)
|
||||
t.Assert(all[0]["prefix"], "user")
|
||||
t.Assert(all[0]["cnt"], 10)
|
||||
})
|
||||
}
|
||||
@ -0,0 +1,324 @@
|
||||
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package mariadb_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/container/garray"
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/frame/g"
|
||||
"github.com/gogf/gf/v2/os/gtime"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
"github.com/gogf/gf/v2/util/guid"
|
||||
)
|
||||
|
||||
func Test_Master_Slave(t *testing.T) {
|
||||
var err error
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `master` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `slave` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
})
|
||||
defer func() {
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `master`")
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `slave`")
|
||||
}()
|
||||
var (
|
||||
configKey = guid.S()
|
||||
configGroup = gdb.ConfigGroup{
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "master",
|
||||
Type: "mariadb",
|
||||
Role: "master",
|
||||
Debug: true,
|
||||
Weight: 100,
|
||||
},
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "slave",
|
||||
Type: "mariadb",
|
||||
Role: "slave",
|
||||
Debug: true,
|
||||
Weight: 100,
|
||||
},
|
||||
}
|
||||
)
|
||||
gdb.SetConfigGroup(configKey, configGroup)
|
||||
masterSlaveDB := g.DB(configKey)
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
table := "table_" + guid.S()
|
||||
createTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
createTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
|
||||
// Data insert to master.
|
||||
array := garray.New(true)
|
||||
for i := 1; i <= TableSize; i++ {
|
||||
array.Append(g.Map{
|
||||
"id": i,
|
||||
"passport": fmt.Sprintf(`user_%d`, i),
|
||||
"password": fmt.Sprintf(`pass_%d`, i),
|
||||
"nickname": fmt.Sprintf(`name_%d`, i),
|
||||
"create_time": gtime.NewFromStr(CreateTime).String(),
|
||||
})
|
||||
}
|
||||
_, err = masterSlaveDB.Model(table).Data(array).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
var count int
|
||||
// Auto slave.
|
||||
count, err = masterSlaveDB.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, int64(0))
|
||||
|
||||
// slave.
|
||||
count, err = masterSlaveDB.Model(table).Slave().Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, int64(0))
|
||||
|
||||
// master.
|
||||
count, err = masterSlaveDB.Model(table).Master().Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, int64(TableSize))
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Master_Slave_Concurrent_ReadWrite tests concurrent read/write routing
|
||||
func Test_Master_Slave_Concurrent_ReadWrite(t *testing.T) {
|
||||
var err error
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `master` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `slave` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
})
|
||||
defer func() {
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `master`")
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `slave`")
|
||||
}()
|
||||
|
||||
var (
|
||||
configKey = guid.S()
|
||||
configGroup = gdb.ConfigGroup{
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "master",
|
||||
Type: "mariadb",
|
||||
Role: "master",
|
||||
Weight: 100,
|
||||
},
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "slave",
|
||||
Type: "mariadb",
|
||||
Role: "slave",
|
||||
Weight: 100,
|
||||
},
|
||||
}
|
||||
)
|
||||
gdb.SetConfigGroup(configKey, configGroup)
|
||||
masterSlaveDB := g.DB(configKey)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
table := "table_" + guid.S()
|
||||
createTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
createTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
|
||||
var wg sync.WaitGroup
|
||||
concurrency := 10
|
||||
|
||||
// Concurrent writes to master
|
||||
wg.Add(concurrency)
|
||||
for i := 0; i < concurrency; i++ {
|
||||
go func(id int) {
|
||||
defer wg.Done()
|
||||
_, err := masterSlaveDB.Model(table).Insert(g.Map{
|
||||
"passport": fmt.Sprintf("concurrent_%d", id),
|
||||
"password": fmt.Sprintf("pass_%d", id),
|
||||
"nickname": fmt.Sprintf("name_%d", id),
|
||||
})
|
||||
t.AssertNil(err)
|
||||
}(i)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
// Verify writes went to master
|
||||
count, err := masterSlaveDB.Model(table).Master().Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, concurrency)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Master_Slave_Transaction_Routing tests transaction routing to master
|
||||
func Test_Master_Slave_Transaction_Routing(t *testing.T) {
|
||||
var err error
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `master` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `slave` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
})
|
||||
defer func() {
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `master`")
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `slave`")
|
||||
}()
|
||||
|
||||
var (
|
||||
configKey = guid.S()
|
||||
configGroup = gdb.ConfigGroup{
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "master",
|
||||
Type: "mariadb",
|
||||
Role: "master",
|
||||
Weight: 100,
|
||||
},
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "slave",
|
||||
Type: "mariadb",
|
||||
Role: "slave",
|
||||
Weight: 100,
|
||||
},
|
||||
}
|
||||
)
|
||||
gdb.SetConfigGroup(configKey, configGroup)
|
||||
masterSlaveDB := g.DB(configKey)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
table := "table_" + guid.S()
|
||||
createTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
createTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
|
||||
// Transaction should route to master
|
||||
err := masterSlaveDB.Transaction(ctx, func(ctx context.Context, tx gdb.TX) error {
|
||||
_, err := tx.Model(table).Insert(g.Map{
|
||||
"passport": "tx_user",
|
||||
"password": "tx_pass",
|
||||
"nickname": "tx_name",
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Read within transaction should also use master
|
||||
count, err := tx.Model(table).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 1)
|
||||
|
||||
return nil
|
||||
})
|
||||
t.AssertNil(err)
|
||||
|
||||
// Verify data is in master
|
||||
count, err := masterSlaveDB.Model(table).Master().Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 1)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_Master_Slave_Explicit_Selection tests explicit master/slave selection
|
||||
func Test_Master_Slave_Explicit_Selection(t *testing.T) {
|
||||
var err error
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `master` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
_, err = db.Exec(ctx, "CREATE DATABASE IF NOT EXISTS `slave` CHARACTER SET UTF8")
|
||||
t.AssertNil(err)
|
||||
})
|
||||
defer func() {
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `master`")
|
||||
_, _ = db.Exec(ctx, "DROP DATABASE `slave`")
|
||||
}()
|
||||
|
||||
var (
|
||||
configKey = guid.S()
|
||||
configGroup = gdb.ConfigGroup{
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "master",
|
||||
Type: "mariadb",
|
||||
Role: "master",
|
||||
Weight: 100,
|
||||
},
|
||||
gdb.ConfigNode{
|
||||
Host: "127.0.0.1",
|
||||
Port: "3307",
|
||||
User: "root",
|
||||
Pass: "12345678",
|
||||
Name: "slave",
|
||||
Type: "mariadb",
|
||||
Role: "slave",
|
||||
Weight: 100,
|
||||
},
|
||||
}
|
||||
)
|
||||
gdb.SetConfigGroup(configKey, configGroup)
|
||||
masterSlaveDB := g.DB(configKey)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
table := "table_" + guid.S()
|
||||
createTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
createTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("master"), table)
|
||||
defer dropTableWithDb(masterSlaveDB.Schema("slave"), table)
|
||||
|
||||
// Insert to master
|
||||
_, err := masterSlaveDB.Model(table).Master().Insert(g.Map{
|
||||
"passport": "explicit_test",
|
||||
"password": "pass",
|
||||
"nickname": "name",
|
||||
})
|
||||
t.AssertNil(err)
|
||||
|
||||
// Explicitly read from slave (should be empty)
|
||||
count, err := masterSlaveDB.Model(table).Slave().Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 0)
|
||||
|
||||
// Explicitly read from master (should have data)
|
||||
count, err = masterSlaveDB.Model(table).Master().Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 1)
|
||||
})
|
||||
}
|
||||
115
contrib/drivers/mariadb/mariadb_z_unit_feature_metadata_test.go
Normal file
115
contrib/drivers/mariadb/mariadb_z_unit_feature_metadata_test.go
Normal file
@ -0,0 +1,115 @@
|
||||
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package mariadb_test
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
// Test_TableFields_Basic tests basic TableFields functionality
|
||||
func Test_TableFields_Basic(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
fields, err := db.TableFields(ctx, table)
|
||||
t.AssertNil(err)
|
||||
t.AssertGT(len(fields), 0)
|
||||
|
||||
// Verify common fields exist
|
||||
_, ok := fields["id"]
|
||||
t.Assert(ok, true)
|
||||
_, ok = fields["passport"]
|
||||
t.Assert(ok, true)
|
||||
_, ok = fields["password"]
|
||||
t.Assert(ok, true)
|
||||
_, ok = fields["nickname"]
|
||||
t.Assert(ok, true)
|
||||
_, ok = fields["create_time"]
|
||||
t.Assert(ok, true)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_TableFields_Schema tests TableFields with explicit schema
|
||||
func Test_TableFields_Schema(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
fields, err := db.TableFields(ctx, table, TestSchema1)
|
||||
t.AssertNil(err)
|
||||
t.AssertGT(len(fields), 0)
|
||||
|
||||
// Verify field properties
|
||||
idField, ok := fields["id"]
|
||||
t.Assert(ok, true)
|
||||
t.Assert(idField.Name, "id")
|
||||
t.AssertGT(idField.Index, -1)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_HasField_Positive tests HasField for existing field
|
||||
func Test_HasField_Positive(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
has, err := db.GetCore().HasField(ctx, table, "id")
|
||||
t.AssertNil(err)
|
||||
t.Assert(has, true)
|
||||
|
||||
has, err = db.GetCore().HasField(ctx, table, "passport")
|
||||
t.AssertNil(err)
|
||||
t.Assert(has, true)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_HasField_Negative tests HasField for non-existent field
|
||||
func Test_HasField_Negative(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
has, err := db.GetCore().HasField(ctx, table, "non_exist_field")
|
||||
t.AssertNil(err)
|
||||
t.Assert(has, false)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_HasField_Schema tests HasField with explicit schema
|
||||
func Test_HasField_Schema(t *testing.T) {
|
||||
table := createInitTable()
|
||||
defer dropTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
has, err := db.GetCore().HasField(ctx, table, "id", TestSchema1)
|
||||
t.AssertNil(err)
|
||||
t.Assert(has, true)
|
||||
})
|
||||
}
|
||||
|
||||
// Test_QuoteWord_Basic tests basic QuoteWord functionality
|
||||
func Test_QuoteWord_Basic(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
quoted := db.GetCore().QuoteWord("user")
|
||||
t.Assert(quoted, "`user`")
|
||||
|
||||
quoted = db.GetCore().QuoteWord("user_table")
|
||||
t.Assert(quoted, "`user_table`")
|
||||
})
|
||||
}
|
||||
|
||||
// Test_QuoteWord_AlreadyQuoted tests QuoteWord with already quoted words
|
||||
func Test_QuoteWord_AlreadyQuoted(t *testing.T) {
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// If already quoted, should not double quote
|
||||
quoted := db.GetCore().QuoteWord("`user`")
|
||||
t.Assert(quoted, "`user`")
|
||||
})
|
||||
}
|
||||
364
contrib/drivers/mariadb/mariadb_z_unit_feature_partition_test.go
Normal file
364
contrib/drivers/mariadb/mariadb_z_unit_feature_partition_test.go
Normal file
@ -0,0 +1,364 @@
|
||||
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the MIT License.
|
||||
// If a copy of the MIT was not distributed with this file,
|
||||
// You can obtain one at https://github.com/gogf/gf.
|
||||
|
||||
package mariadb_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/gogf/gf/v2/database/gdb"
|
||||
"github.com/gogf/gf/v2/frame/g"
|
||||
"github.com/gogf/gf/v2/os/gtime"
|
||||
"github.com/gogf/gf/v2/test/gtest"
|
||||
)
|
||||
|
||||
func createRangePartitionTable(table ...string) string {
|
||||
var name string
|
||||
if len(table) > 0 {
|
||||
name = table[0]
|
||||
} else {
|
||||
name = fmt.Sprintf(`partition_range_%d`, gtime.TimestampNano())
|
||||
}
|
||||
if _, err := db3.Exec(ctx, fmt.Sprintf("DROP TABLE IF EXISTS `%s`", name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
if _, err := db3.Exec(ctx, fmt.Sprintf(`
|
||||
CREATE TABLE %s (
|
||||
id int(11) NOT NULL,
|
||||
sales_date date DEFAULT NULL,
|
||||
amount decimal(10,2) DEFAULT NULL,
|
||||
region varchar(50) DEFAULT NULL
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4
|
||||
PARTITION BY RANGE (YEAR(sales_date))
|
||||
(PARTITION p2020 VALUES LESS THAN (2021) ENGINE = InnoDB,
|
||||
PARTITION p2021 VALUES LESS THAN (2022) ENGINE = InnoDB,
|
||||
PARTITION p2022 VALUES LESS THAN (2023) ENGINE = InnoDB,
|
||||
PARTITION p2023 VALUES LESS THAN (2024) ENGINE = InnoDB,
|
||||
PARTITION p_future VALUES LESS THAN MAXVALUE ENGINE = InnoDB);
|
||||
`, name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
func createHashPartitionTable(table ...string) string {
|
||||
var name string
|
||||
if len(table) > 0 {
|
||||
name = table[0]
|
||||
} else {
|
||||
name = fmt.Sprintf(`partition_hash_%d`, gtime.TimestampNano())
|
||||
}
|
||||
if _, err := db3.Exec(ctx, fmt.Sprintf("DROP TABLE IF EXISTS `%s`", name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
if _, err := db3.Exec(ctx, fmt.Sprintf(`
|
||||
CREATE TABLE %s (
|
||||
id int(11) NOT NULL,
|
||||
user_id int(11) NOT NULL,
|
||||
username varchar(50) DEFAULT NULL,
|
||||
email varchar(100) DEFAULT NULL
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4
|
||||
PARTITION BY HASH (user_id)
|
||||
PARTITIONS 4;
|
||||
`, name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
func createListPartitionTable(table ...string) string {
|
||||
var name string
|
||||
if len(table) > 0 {
|
||||
name = table[0]
|
||||
} else {
|
||||
name = fmt.Sprintf(`partition_list_%d`, gtime.TimestampNano())
|
||||
}
|
||||
if _, err := db3.Exec(ctx, fmt.Sprintf("DROP TABLE IF EXISTS `%s`", name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
if _, err := db3.Exec(ctx, fmt.Sprintf(`
|
||||
CREATE TABLE %s (
|
||||
id int(11) NOT NULL,
|
||||
region_code int(11) NOT NULL,
|
||||
city varchar(50) DEFAULT NULL,
|
||||
population int(11) DEFAULT NULL
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4
|
||||
PARTITION BY LIST (region_code)
|
||||
(PARTITION p_north VALUES IN (1,2,3) ENGINE = InnoDB,
|
||||
PARTITION p_south VALUES IN (4,5,6) ENGINE = InnoDB,
|
||||
PARTITION p_east VALUES IN (7,8,9) ENGINE = InnoDB,
|
||||
PARTITION p_west VALUES IN (10,11,12) ENGINE = InnoDB);
|
||||
`, name)); err != nil {
|
||||
gtest.Fatal(err)
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
func dropPartitionTable(table string) {
|
||||
if _, err := db3.Exec(ctx, fmt.Sprintf("DROP TABLE IF EXISTS `%s`", table)); err != nil {
|
||||
gtest.Error(err)
|
||||
}
|
||||
}
|
||||
|
||||
func Test_Partition_Range_Insert_And_Query(t *testing.T) {
|
||||
table := createRangePartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data across different partitions
|
||||
data := g.Slice{
|
||||
g.Map{"id": 1, "sales_date": "2020-06-15", "amount": 1000.50, "region": "North"},
|
||||
g.Map{"id": 2, "sales_date": "2021-03-20", "amount": 2000.75, "region": "South"},
|
||||
g.Map{"id": 3, "sales_date": "2022-09-10", "amount": 3000.00, "region": "East"},
|
||||
g.Map{"id": 4, "sales_date": "2023-12-01", "amount": 4000.25, "region": "West"},
|
||||
g.Map{"id": 5, "sales_date": "2024-01-15", "amount": 5000.00, "region": "North"},
|
||||
}
|
||||
_, err := db3.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Query all data
|
||||
all, err := db3.Model(table).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 5)
|
||||
|
||||
// Query specific year (should hit specific partition)
|
||||
result, err := db3.Model(table).Where("YEAR(sales_date) = ?", 2022).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(result), 1)
|
||||
t.Assert(result[0]["id"], 3)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Partition_Range_PartitionQuery(t *testing.T) {
|
||||
// Known limitation: Model.Partition() sets m.partition field but it's not used in SQL generation
|
||||
// See: database/gdb/gdb_model_select.go lines 735,755 - m.tables is used without PARTITION clause
|
||||
// TODO: Add PARTITION clause support to GoFrame query builder
|
||||
t.Skip("Partition clause in SELECT queries not yet supported in GoFrame query builder")
|
||||
|
||||
table := createRangePartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data
|
||||
data := g.Slice{
|
||||
g.Map{"id": 1, "sales_date": "2020-06-15", "amount": 1000.50},
|
||||
g.Map{"id": 2, "sales_date": "2021-03-20", "amount": 2000.75},
|
||||
g.Map{"id": 3, "sales_date": "2022-09-10", "amount": 3000.00},
|
||||
g.Map{"id": 4, "sales_date": "2023-12-01", "amount": 4000.25},
|
||||
}
|
||||
_, err := db3.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Query specific partition
|
||||
result, err := db3.Model(table).Partition("p2022").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(result), 1)
|
||||
t.Assert(result[0]["id"], 3)
|
||||
|
||||
// Query multiple partitions
|
||||
result, err = db3.Model(table).Partition("p2021", "p2022").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(result), 2)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Partition_Hash_Insert_And_Distribution(t *testing.T) {
|
||||
table := createHashPartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data that will be distributed across hash partitions
|
||||
data := g.Slice{}
|
||||
for i := 1; i <= 20; i++ {
|
||||
data = append(data, g.Map{
|
||||
"id": i,
|
||||
"user_id": i * 10,
|
||||
"username": fmt.Sprintf("user_%d", i),
|
||||
"email": fmt.Sprintf("user%d@example.com", i),
|
||||
})
|
||||
}
|
||||
_, err := db3.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Query all data
|
||||
all, err := db3.Model(table).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 20)
|
||||
|
||||
// Query specific user_id (will hit specific partition based on hash)
|
||||
result, err := db3.Model(table).Where("user_id", 100).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(result["username"], "user_10")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Partition_List_Insert_And_Query(t *testing.T) {
|
||||
// Known limitation: Model.Partition() sets m.partition field but it's not used in SQL generation
|
||||
// See: database/gdb/gdb_model_select.go lines 735,755 - m.tables is used without PARTITION clause
|
||||
// TODO: Add PARTITION clause support to GoFrame query builder
|
||||
t.Skip("Partition clause in SELECT queries not yet supported in GoFrame query builder")
|
||||
|
||||
table := createListPartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data for different regions
|
||||
data := g.Slice{
|
||||
g.Map{"id": 1, "region_code": 1, "city": "Beijing", "population": 2154},
|
||||
g.Map{"id": 2, "region_code": 2, "city": "Harbin", "population": 1063},
|
||||
g.Map{"id": 3, "region_code": 5, "city": "Guangzhou", "population": 1868},
|
||||
g.Map{"id": 4, "region_code": 7, "city": "Shanghai", "population": 2428},
|
||||
g.Map{"id": 5, "region_code": 10, "city": "Chengdu", "population": 2093},
|
||||
}
|
||||
_, err := db3.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Query all
|
||||
all, err := db3.Model(table).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 5)
|
||||
|
||||
// Query specific partition (north region)
|
||||
result, err := db3.Model(table).Partition("p_north").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(result), 2)
|
||||
|
||||
// Query specific partition (south region)
|
||||
result, err = db3.Model(table).Partition("p_south").All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(result), 1)
|
||||
t.Assert(result[0]["city"], "Guangzhou")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Partition_Range_Update(t *testing.T) {
|
||||
table := createRangePartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data
|
||||
_, err := db3.Model(table).Data(g.Map{
|
||||
"id": 1,
|
||||
"sales_date": "2022-06-15",
|
||||
"amount": 1000.00,
|
||||
"region": "North",
|
||||
}).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Update data within same partition
|
||||
result, err := db3.Model(table).Data(g.Map{
|
||||
"amount": 1500.00,
|
||||
"region": "South",
|
||||
}).Where("id", 1).Update()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.RowsAffected()
|
||||
t.Assert(n, 1)
|
||||
|
||||
// Verify update
|
||||
one, err := db3.Model(table).Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["amount"], "1500.00")
|
||||
t.Assert(one["region"], "South")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Partition_Range_Delete(t *testing.T) {
|
||||
table := createRangePartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data
|
||||
data := g.Slice{
|
||||
g.Map{"id": 1, "sales_date": "2020-06-15", "amount": 1000.50},
|
||||
g.Map{"id": 2, "sales_date": "2021-03-20", "amount": 2000.75},
|
||||
g.Map{"id": 3, "sales_date": "2022-09-10", "amount": 3000.00},
|
||||
}
|
||||
_, err := db3.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Delete from specific partition
|
||||
result, err := db3.Model(table).Where("YEAR(sales_date) = ?", 2021).Delete()
|
||||
t.AssertNil(err)
|
||||
n, _ := result.RowsAffected()
|
||||
t.Assert(n, 1)
|
||||
|
||||
// Verify deletion
|
||||
all, err := db3.Model(table).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 2)
|
||||
|
||||
// Verify remaining data
|
||||
result2, err := db3.Model(table).Where("YEAR(sales_date) = ?", 2021).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(result2), 0)
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Partition_Transaction(t *testing.T) {
|
||||
table := createRangePartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Transaction with partitioned table
|
||||
err := db3.Transaction(ctx, func(ctx context.Context, tx gdb.TX) error {
|
||||
// Insert across multiple partitions
|
||||
data := g.Slice{
|
||||
g.Map{"id": 1, "sales_date": "2020-06-15", "amount": 1000.50},
|
||||
g.Map{"id": 2, "sales_date": "2021-03-20", "amount": 2000.75},
|
||||
g.Map{"id": 3, "sales_date": "2022-09-10", "amount": 3000.00},
|
||||
}
|
||||
_, err := tx.Model(table).Ctx(ctx).Data(data).Insert()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Update in transaction
|
||||
_, err = tx.Model(table).Ctx(ctx).Data(g.Map{
|
||||
"amount": 1500.00,
|
||||
}).Where("id", 1).Update()
|
||||
return err
|
||||
})
|
||||
t.AssertNil(err)
|
||||
|
||||
// Verify transaction committed
|
||||
all, err := db3.Model(table).All()
|
||||
t.AssertNil(err)
|
||||
t.Assert(len(all), 3)
|
||||
|
||||
one, err := db3.Model(table).Where("id", 1).One()
|
||||
t.AssertNil(err)
|
||||
t.Assert(one["amount"], "1500.00")
|
||||
})
|
||||
}
|
||||
|
||||
func Test_Partition_Range_Count_And_Sum(t *testing.T) {
|
||||
table := createRangePartitionTable()
|
||||
defer dropPartitionTable(table)
|
||||
|
||||
gtest.C(t, func(t *gtest.T) {
|
||||
// Insert data
|
||||
data := g.Slice{
|
||||
g.Map{"id": 1, "sales_date": "2020-06-15", "amount": 1000.00},
|
||||
g.Map{"id": 2, "sales_date": "2020-09-20", "amount": 1500.00},
|
||||
g.Map{"id": 3, "sales_date": "2021-03-20", "amount": 2000.00},
|
||||
g.Map{"id": 4, "sales_date": "2022-09-10", "amount": 3000.00},
|
||||
}
|
||||
_, err := db3.Model(table).Data(data).Insert()
|
||||
t.AssertNil(err)
|
||||
|
||||
// Count by year (specific partition)
|
||||
count, err := db3.Model(table).Where("YEAR(sales_date) = ?", 2020).Count()
|
||||
t.AssertNil(err)
|
||||
t.Assert(count, 2)
|
||||
|
||||
// Sum across partitions
|
||||
value, err := db3.Model(table).Fields("SUM(amount) as total").Value()
|
||||
t.AssertNil(err)
|
||||
t.AssertGT(value.Float64(), 7000.0) // 1000+1500+2000+3000 = 7500
|
||||
})
|
||||
}
|
||||
2075
contrib/drivers/mariadb/mariadb_z_unit_issue_test.go
Normal file
2075
contrib/drivers/mariadb/mariadb_z_unit_issue_test.go
Normal file
File diff suppressed because it is too large
Load Diff
2471
contrib/drivers/mariadb/mariadb_z_unit_model_test.go
Normal file
2471
contrib/drivers/mariadb/mariadb_z_unit_model_test.go
Normal file
File diff suppressed because it is too large
Load Diff
9
contrib/drivers/mariadb/testdata/date_time_example.sql
vendored
Normal file
9
contrib/drivers/mariadb/testdata/date_time_example.sql
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
CREATE TABLE `date_time_example` (
|
||||
`id` int unsigned NOT NULL AUTO_INCREMENT,
|
||||
`year` year DEFAULT NULL COMMENT 'year',
|
||||
`date` date DEFAULT NULL COMMENT 'Date',
|
||||
`time` time DEFAULT NULL COMMENT 'time',
|
||||
`datetime` datetime DEFAULT NULL COMMENT 'datetime',
|
||||
`timestamp` timestamp NULL DEFAULT NULL COMMENT 'Timestamp',
|
||||
PRIMARY KEY (`id`)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
|
||||
9
contrib/drivers/mariadb/testdata/fix_gdb_order_by.sql
vendored
Normal file
9
contrib/drivers/mariadb/testdata/fix_gdb_order_by.sql
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
CREATE TABLE IF NOT EXISTS `employee`
|
||||
(
|
||||
id BIGINT AUTO_INCREMENT PRIMARY KEY,
|
||||
name VARCHAR(255) NOT NULL,
|
||||
age INT NOT NULL
|
||||
);
|
||||
|
||||
INSERT INTO employee(name, age) VALUES ('John', 30);
|
||||
INSERT INTO employee(name, age) VALUES ('Mary', 28);
|
||||
35
contrib/drivers/mariadb/testdata/issues/1380.sql
vendored
Normal file
35
contrib/drivers/mariadb/testdata/issues/1380.sql
vendored
Normal file
@ -0,0 +1,35 @@
|
||||
CREATE TABLE `jfy_gift` (
|
||||
`id` int(0) UNSIGNED NOT NULL AUTO_INCREMENT,
|
||||
`gift_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '礼品名称',
|
||||
`at_least_recharge_count` int(0) UNSIGNED NOT NULL DEFAULT 1 COMMENT '最少兑换数量',
|
||||
`comments` json NOT NULL COMMENT '礼品留言',
|
||||
`content` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '礼品详情',
|
||||
`cost_price` decimal(10, 2) NULL DEFAULT NULL COMMENT '成本价',
|
||||
`cover` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '封面',
|
||||
`covers` json NOT NULL COMMENT '礼品图片库',
|
||||
`description` varchar(62) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '礼品备注',
|
||||
`express_type` json NOT NULL COMMENT '配送方式',
|
||||
`gift_type` int(0) NOT NULL COMMENT '礼品类型:1:实物;2:虚拟;3:优惠券;4:积分券',
|
||||
`has_props` tinyint(1) NOT NULL DEFAULT 0 COMMENT '是否有多个属性',
|
||||
`is_limit_sell` tinyint(0) UNSIGNED NOT NULL DEFAULT 0 COMMENT '是否限购',
|
||||
`limit_customer_tags` json NOT NULL COMMENT '语序购买的会员标签',
|
||||
`limit_sell_custom` tinyint(0) UNSIGNED NOT NULL DEFAULT 0 COMMENT '是否开启允许购买的会员标签',
|
||||
`limit_sell_cycle` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '限购周期',
|
||||
`limit_sell_cycle_count` int(0) NOT NULL COMMENT '限购期内允许购买的数量',
|
||||
`limit_sell_type` tinyint(0) NOT NULL COMMENT '限购类型',
|
||||
`market_price` decimal(10, 2) NOT NULL COMMENT '市场价',
|
||||
`out_sn` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '内部编码',
|
||||
`props` json NOT NULL COMMENT '规格',
|
||||
`skus` json NOT NULL COMMENT 'SKU',
|
||||
`score_price` decimal(10, 2) NOT NULL COMMENT '兑换所需积分',
|
||||
`stock` int(0) NOT NULL COMMENT '库存',
|
||||
`create_at` datetime(0) NOT NULL COMMENT '创建日期',
|
||||
`store_id` int(0) NOT NULL COMMENT '所属商城',
|
||||
`status` int(0) UNSIGNED NULL DEFAULT 1 COMMENT '1:下架;20:审核中;30:复审中;99:上架',
|
||||
`view_count` int(0) NOT NULL DEFAULT 0 COMMENT '访问量',
|
||||
`sell_count` int(0) NULL DEFAULT 0 COMMENT '销量',
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
|
||||
|
||||
|
||||
INSERT INTO `jfy_gift` VALUES (17, 'GIFT', 1, '[{\"name\": \"身份证\", \"field\": \"idcard\", \"required\": false}, {\"name\": \"留言2\", \"field\": \"text\", \"required\": false}]', '<p>礼品详情</p>', 0.00, '', '{\"list\": [{\"uid\": \"vc-upload-1629292486099-3\", \"url\": \"https://cdn.taobao.com/sULsYiwaOPjsKGoBXwKtuewPzACpBDfQ.jpg\", \"name\": \"O1CN01OH6PIP1Oc5ot06U17_!!922361725.jpg\", \"status\": \"done\"}, {\"uid\": \"vc-upload-1629292486099-4\", \"url\": \"https://cdn.taobao.com/lqLHDcrFTgNvlWyXfLYZwmsrODzIBtFH.jpg\", \"name\": \"O1CN018hBckI1Oc5ouc8ppl_!!922361725.jpg\", \"status\": \"done\"}, {\"uid\": \"vc-upload-1629292486099-5\", \"url\": \"https://cdn.taobao.com/pvqyutXckICmHhbPBQtrVLHuMlXuGxUg.jpg\", \"name\": \"O1CN0185Ubp91Oc5osQTTcc_!!922361725.jpg\", \"status\": \"done\"}]}', '支持个性定制的父亲节老师长辈的专属礼物', '[\"快递包邮\", \"同城配送\"]', 1, 0, 0, '[]', 0, 'day', 0, 1, 0.00, '259402', '[{\"name\": \"颜色\", \"values\": [\"红色\", \"蓝色\"]}]', '[{\"name\": \"red\", \"stock\": 10, \"gift_id\": 1, \"cost_price\": 80, \"score_price\": 188, \"market_price\": 388}, {\"name\": \"blue\", \"stock\": 100, \"gift_id\": 2, \"cost_price\": 81, \"score_price\": 200, \"market_price\": 288}]', 10.00, 0, '2021-08-18 21:26:13', 100004, 99, 0, 0);
|
||||
32
contrib/drivers/mariadb/testdata/issues/1401.sql
vendored
Normal file
32
contrib/drivers/mariadb/testdata/issues/1401.sql
vendored
Normal file
@ -0,0 +1,32 @@
|
||||
-- ----------------------------
|
||||
-- Table structure for parcel_items
|
||||
-- ----------------------------
|
||||
DROP TABLE IF EXISTS `parcel_items`;
|
||||
CREATE TABLE `parcel_items` (
|
||||
`id` int(11) NOT NULL,
|
||||
`parcel_id` int(11) NULL DEFAULT NULL,
|
||||
`name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
|
||||
|
||||
-- ----------------------------
|
||||
-- Records of parcel_items
|
||||
-- ----------------------------
|
||||
INSERT INTO `parcel_items` VALUES (1, 1, '新品');
|
||||
INSERT INTO `parcel_items` VALUES (2, 3, '新品2');
|
||||
|
||||
-- ----------------------------
|
||||
-- Table structure for parcels
|
||||
-- ----------------------------
|
||||
DROP TABLE IF EXISTS `parcels`;
|
||||
CREATE TABLE `parcels` (
|
||||
`id` int(11) NOT NULL AUTO_INCREMENT,
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
|
||||
|
||||
-- ----------------------------
|
||||
-- Records of parcels
|
||||
-- ----------------------------
|
||||
INSERT INTO `parcels` VALUES (1);
|
||||
INSERT INTO `parcels` VALUES (2);
|
||||
INSERT INTO `parcels` VALUES (3);
|
||||
30
contrib/drivers/mariadb/testdata/issues/1412.sql
vendored
Normal file
30
contrib/drivers/mariadb/testdata/issues/1412.sql
vendored
Normal file
@ -0,0 +1,30 @@
|
||||
-- ----------------------------
|
||||
-- Table structure for items
|
||||
-- ----------------------------
|
||||
CREATE TABLE `items` (
|
||||
`id` int(11) NOT NULL,
|
||||
`name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
|
||||
|
||||
-- ----------------------------
|
||||
-- Records of items
|
||||
-- ----------------------------
|
||||
INSERT INTO `items` VALUES (1, '金秋产品1');
|
||||
INSERT INTO `items` VALUES (2, '金秋产品2');
|
||||
|
||||
-- ----------------------------
|
||||
-- Table structure for parcels
|
||||
-- ----------------------------
|
||||
CREATE TABLE `parcels` (
|
||||
`id` int(11) NOT NULL AUTO_INCREMENT,
|
||||
`item_id` int(11) NULL DEFAULT NULL,
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
|
||||
|
||||
-- ----------------------------
|
||||
-- Records of parcels
|
||||
-- ----------------------------
|
||||
INSERT INTO `parcels` VALUES (1, 1);
|
||||
INSERT INTO `parcels` VALUES (2, 2);
|
||||
INSERT INTO `parcels` VALUES (3, 0);
|
||||
9
contrib/drivers/mariadb/testdata/issues/2105.sql
vendored
Normal file
9
contrib/drivers/mariadb/testdata/issues/2105.sql
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
CREATE TABLE `issue2105` (
|
||||
`id` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL,
|
||||
`json` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin,
|
||||
PRIMARY KEY (`id`)
|
||||
) ENGINE=InnoDB;
|
||||
|
||||
|
||||
INSERT INTO `issue2105` VALUES ('1', NULL);
|
||||
INSERT INTO `issue2105` VALUES ('2', '[{\"Name\": \"任务类型\", \"Value\": \"高价值\"}, {\"Name\": \"优先级\", \"Value\": \"高\"}, {\"Name\": \"是否亮点功能\", \"Value\": \"是\"}]');
|
||||
47
contrib/drivers/mariadb/testdata/issues/2119.sql
vendored
Normal file
47
contrib/drivers/mariadb/testdata/issues/2119.sql
vendored
Normal file
@ -0,0 +1,47 @@
|
||||
SET NAMES utf8mb4;
|
||||
SET FOREIGN_KEY_CHECKS = 0;
|
||||
|
||||
-- ----------------------------
|
||||
-- Table structure for sys_role
|
||||
-- ----------------------------
|
||||
DROP TABLE IF EXISTS `sys_role`;
|
||||
CREATE TABLE `sys_role` (
|
||||
`id` int(0) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '||s',
|
||||
`name` varchar(30) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '角色名称||s,r',
|
||||
`code` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '角色 code||s,r',
|
||||
`description` varchar(500) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '描述信息|text',
|
||||
`weight` int(0) UNSIGNED NOT NULL DEFAULT 0 COMMENT '排序||r|min:0#发布状态不能小于 0',
|
||||
`status_id` int(0) UNSIGNED NOT NULL DEFAULT 1 COMMENT '发布状态|hasOne|f:status,fk:id',
|
||||
`created_at` datetime(0) NULL DEFAULT NULL,
|
||||
`updated_at` datetime(0) NULL DEFAULT NULL,
|
||||
PRIMARY KEY (`id`) USING BTREE,
|
||||
INDEX `code`(`code`) USING BTREE
|
||||
) ENGINE = InnoDB AUTO_INCREMENT = 1091 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '系统角色表' ROW_FORMAT = Compact;
|
||||
|
||||
-- ----------------------------
|
||||
-- Records of sys_role
|
||||
-- ----------------------------
|
||||
INSERT INTO `sys_role` VALUES (1, '开发人员', 'developer', '123123', 900, 2, '2022-09-03 21:25:03', '2022-09-09 23:35:23');
|
||||
INSERT INTO `sys_role` VALUES (2, '管理员', 'admin', '', 800, 1, '2022-09-03 21:25:03', '2022-09-09 23:00:17');
|
||||
INSERT INTO `sys_role` VALUES (3, '运营', 'operator', '', 700, 1, '2022-09-03 21:25:03', '2022-09-03 21:25:03');
|
||||
INSERT INTO `sys_role` VALUES (4, '客服', 'service', '', 600, 1, '2022-09-03 21:25:03', '2022-09-03 21:25:03');
|
||||
INSERT INTO `sys_role` VALUES (5, '收银', 'account', '', 500, 1, '2022-09-03 21:25:03', '2022-09-03 21:25:03');
|
||||
|
||||
-- ----------------------------
|
||||
-- Table structure for sys_status
|
||||
-- ----------------------------
|
||||
DROP TABLE IF EXISTS `sys_status`;
|
||||
CREATE TABLE `sys_status` (
|
||||
`id` int(0) UNSIGNED NOT NULL AUTO_INCREMENT,
|
||||
`en` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '英文名称',
|
||||
`cn` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '中文名称',
|
||||
`weight` int(0) UNSIGNED NOT NULL DEFAULT 0 COMMENT '排序权重',
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB AUTO_INCREMENT = 7 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '发布状态' ROW_FORMAT = Dynamic;
|
||||
|
||||
-- ----------------------------
|
||||
-- Records of sys_status
|
||||
-- ----------------------------
|
||||
INSERT INTO `sys_status` VALUES (1, 'on line', '上线', 900);
|
||||
INSERT INTO `sys_status` VALUES (2, 'undecided', '未决定', 800);
|
||||
INSERT INTO `sys_status` VALUES (3, 'off line', '下线', 700);
|
||||
19
contrib/drivers/mariadb/testdata/issues/2439.sql
vendored
Normal file
19
contrib/drivers/mariadb/testdata/issues/2439.sql
vendored
Normal file
@ -0,0 +1,19 @@
|
||||
CREATE TABLE `a` (
|
||||
`id` int(11) NOT NULL AUTO_INCREMENT,
|
||||
PRIMARY KEY (id) USING BTREE
|
||||
) ENGINE = InnoDB;
|
||||
INSERT INTO `a` (`id`) VALUES ('2');
|
||||
|
||||
CREATE TABLE `b` (
|
||||
`id` int(11) NOT NULL AUTO_INCREMENT,
|
||||
`name` varchar(255) NOT NULL ,
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB;
|
||||
INSERT INTO `b` (`id`, `name`) VALUES ('2', 'a');
|
||||
INSERT INTO `b` (`id`, `name`) VALUES ('3', 'b');
|
||||
|
||||
CREATE TABLE `c` (
|
||||
`id` int(11) NOT NULL AUTO_INCREMENT,
|
||||
PRIMARY KEY (`id`) USING BTREE
|
||||
) ENGINE = InnoDB;
|
||||
INSERT INTO `c` (`id`) VALUES ('2');
|
||||
7
contrib/drivers/mariadb/testdata/issues/2643.sql
vendored
Normal file
7
contrib/drivers/mariadb/testdata/issues/2643.sql
vendored
Normal file
@ -0,0 +1,7 @@
|
||||
CREATE TABLE `issue2643` (
|
||||
`id` INT(10) NULL DEFAULT NULL,
|
||||
`name` VARCHAR(50) NULL DEFAULT NULL,
|
||||
`value` INT(10) NULL DEFAULT NULL,
|
||||
`dept` VARCHAR(50) NULL DEFAULT NULL
|
||||
)
|
||||
ENGINE=InnoDB
|
||||
10
contrib/drivers/mariadb/testdata/issues/3086.sql
vendored
Normal file
10
contrib/drivers/mariadb/testdata/issues/3086.sql
vendored
Normal file
@ -0,0 +1,10 @@
|
||||
CREATE TABLE `issue3086_user`
|
||||
(
|
||||
`id` int(10) unsigned NOT NULL COMMENT 'User ID',
|
||||
`passport` varchar(45) NOT NULL COMMENT 'User Passport',
|
||||
`password` varchar(45) DEFAULT NULL COMMENT 'User Password',
|
||||
`nickname` varchar(45) DEFAULT NULL COMMENT 'User Nickname',
|
||||
`create_at` datetime DEFAULT NULL COMMENT 'Created Time',
|
||||
`update_at` datetime DEFAULT NULL COMMENT 'Updated Time',
|
||||
PRIMARY KEY (`id`)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
|
||||
14
contrib/drivers/mariadb/testdata/issues/3218.sql
vendored
Normal file
14
contrib/drivers/mariadb/testdata/issues/3218.sql
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
CREATE TABLE `issue3218_sys_config` (
|
||||
`id` int(11) NOT NULL AUTO_INCREMENT,
|
||||
`name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '配置名称',
|
||||
`value` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '配置值',
|
||||
`created_at` timestamp NULL DEFAULT NULL COMMENT '创建时间',
|
||||
`updated_at` timestamp NULL DEFAULT NULL COMMENT '更新时间',
|
||||
PRIMARY KEY (`id`) USING BTREE,
|
||||
UNIQUE INDEX `name`(`name`(191)) USING BTREE
|
||||
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci;
|
||||
|
||||
-- ----------------------------
|
||||
-- Records of sys_config
|
||||
-- ----------------------------
|
||||
INSERT INTO `issue3218_sys_config` VALUES (49, 'site', '{\"banned_ip\":\"22\",\"filings\":\"2222\",\"fixed_page\":\"\",\"site_name\":\"22\",\"version\":\"22\"}', '2023-12-19 14:08:25', '2023-12-19 14:08:25');
|
||||
5
contrib/drivers/mariadb/testdata/issues/3626.sql
vendored
Normal file
5
contrib/drivers/mariadb/testdata/issues/3626.sql
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
CREATE TABLE `issue3626` (
|
||||
id int(11) NOT NULL,
|
||||
name varchar(45) DEFAULT NULL,
|
||||
PRIMARY KEY (id)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
|
||||
8
contrib/drivers/mariadb/testdata/issues/3754.sql
vendored
Normal file
8
contrib/drivers/mariadb/testdata/issues/3754.sql
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
CREATE TABLE `issue3754` (
|
||||
id int(11) NOT NULL,
|
||||
name varchar(45) DEFAULT NULL,
|
||||
create_at datetime(0) DEFAULT NULL,
|
||||
update_at datetime(0) DEFAULT NULL,
|
||||
delete_at datetime(0) DEFAULT NULL,
|
||||
PRIMARY KEY (id)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
|
||||
9
contrib/drivers/mariadb/testdata/issues/3915.sql
vendored
Normal file
9
contrib/drivers/mariadb/testdata/issues/3915.sql
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
CREATE TABLE `issue3915` (
|
||||
`id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'user id',
|
||||
`a` float DEFAULT NULL COMMENT 'user name',
|
||||
`b` float DEFAULT NULL COMMENT 'user status',
|
||||
PRIMARY KEY (`id`)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
|
||||
|
||||
INSERT INTO `issue3915` (`id`,`a`,`b`) VALUES (1,1,2);
|
||||
INSERT INTO `issue3915` (`id`,`a`,`b`) VALUES (2,5,4);
|
||||
8
contrib/drivers/mariadb/testdata/issues/4034.sql
vendored
Normal file
8
contrib/drivers/mariadb/testdata/issues/4034.sql
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
CREATE TABLE issue4034 (
|
||||
id INT PRIMARY KEY AUTO_INCREMENT,
|
||||
passport VARCHAR(255),
|
||||
password VARCHAR(255),
|
||||
nickname VARCHAR(255),
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
|
||||
);
|
||||
10
contrib/drivers/mariadb/testdata/issues/4086.sql
vendored
Normal file
10
contrib/drivers/mariadb/testdata/issues/4086.sql
vendored
Normal file
@ -0,0 +1,10 @@
|
||||
DROP TABLE IF EXISTS `issue4086`;
|
||||
CREATE TABLE `issue4086` (
|
||||
`proxy_id` bigint NOT NULL,
|
||||
`recommend_ids` json DEFAULT NULL,
|
||||
`photos` json DEFAULT NULL,
|
||||
PRIMARY KEY (`proxy_id`)
|
||||
) ENGINE=InnoDB;
|
||||
|
||||
INSERT INTO `issue4086` (`proxy_id`, `recommend_ids`, `photos`) VALUES (1, '[584, 585]', 'null');
|
||||
INSERT INTO `issue4086` (`proxy_id`, `recommend_ids`, `photos`) VALUES (2, '[]', NULL);
|
||||
20
contrib/drivers/mariadb/testdata/reservedwords_table_tpl.sql
vendored
Normal file
20
contrib/drivers/mariadb/testdata/reservedwords_table_tpl.sql
vendored
Normal file
@ -0,0 +1,20 @@
|
||||
CREATE TABLE %s (
|
||||
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
|
||||
`key` varchar(45) DEFAULT NULL,
|
||||
`category_id` int(10) unsigned NOT NULL,
|
||||
`user_id` int(10) unsigned NOT NULL,
|
||||
`title` varchar(255) NOT NULL,
|
||||
`content` mediumtext NOT NULL,
|
||||
`sort` int(10) unsigned DEFAULT '0',
|
||||
`brief` varchar(255) DEFAULT NULL,
|
||||
`thumb` varchar(255) DEFAULT NULL,
|
||||
`tags` varchar(900) DEFAULT NULL,
|
||||
`referer` varchar(255) DEFAULT NULL,
|
||||
`status` smallint(5) unsigned DEFAULT '0',
|
||||
`view_count` int(10) unsigned DEFAULT '0',
|
||||
`zan_count` int(10) unsigned DEFAULT NULL,
|
||||
`cai_count` int(10) unsigned DEFAULT NULL,
|
||||
`created_at` datetime DEFAULT NULL,
|
||||
`updated_at` datetime DEFAULT NULL,
|
||||
PRIMARY KEY (`id`)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
|
||||
@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/drivers/mssql/v2
|
||||
go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
github.com/microsoft/go-mssqldb v1.7.1
|
||||
)
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ go 1.23.0
|
||||
|
||||
require (
|
||||
github.com/go-sql-driver/mysql v1.7.1
|
||||
github.com/gogf/gf/v2 v2.10.0
|
||||
github.com/gogf/gf/v2 v2.10.2
|
||||
)
|
||||
|
||||
require (
|
||||
|
||||
@ -1570,6 +1570,7 @@ func Test_DB_Ctx(t *testing.T) {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
|
||||
defer cancel()
|
||||
_, err := db.Query(ctx, "SELECT SLEEP(10)")
|
||||
t.AssertNE(err, nil)
|
||||
t.Assert(gstr.Contains(err.Error(), "deadline"), true)
|
||||
})
|
||||
}
|
||||
|
||||
@ -58,7 +58,7 @@ func init() {
|
||||
nodePrefix.Prefix = TableNamePrefix1
|
||||
|
||||
nodeInvalid := gdb.ConfigNode{
|
||||
Link: fmt.Sprintf("mysql:root:%s@tcp(127.0.0.1:3307)/?loc=Local&parseTime=true", TestDbPass),
|
||||
Link: fmt.Sprintf("mysql:root:%s@tcp(127.0.0.1:3316)/?loc=Local&parseTime=true", TestDbPass),
|
||||
TranTimeout: time.Second * 3,
|
||||
}
|
||||
gdb.AddConfigNode("test", nodeDefault)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user