planetscale / planetscale/database-skills

Be careful recommending INPLACE DDL

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
675
Forks
61
Avg merge
1d 19h
Merged PRs (30d)
1

Description

From the MySQL skill:

Use online DDL (ALGORITHM=INPLACE) when possible; test on replicas first.

INPLACE blocks InnoDB purge (bug) and requires enough temporary space to run. When it runs out of space, it's not resumable.

There are only a subset of INPLACE operations which are safe. You can use a parser to find these (example), or if not, I would recommend against it.

No issues with INSTANT.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with skills/mysql/SKILL.md and review the quoted INPLACE DDL guidance. Compare the safety concerns in this issue with the linked parser example in spirit/pkg/statement/statement.go. Done means the skill no longer broadly recommends unsafe INPLACE operations while preserving the existing INSTANT guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.