xataio / xataio/cli

feature proposition: Add a sort of `--dry-run` to `xata clone start` (and other commands)

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
6
Forks
1
Avg merge
2d 22h
Merged PRs (30d)
1

Description

When using xata clone start ... ... you sometime want to get all the connection settings, parameters, anonymisation settings etc right before actually running the data mutating operations. This means that once you have everything right ... it just starts executing and thus doesn't allow you to plan / debug things in advance without running it.


Hence I propose to add a dry-run mode (or whatever named):

xata clone start ... --dry-run

Use case:

Validate syntax, schemas, anonymization settings, connection parameters, and permissions without actually transferring data (write / mutating operations)

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 by tracing the xata clone start command entry point and how it performs validation, connection setup, anonymization, and data mutations. Define the scope of dry-run behavior for this command and any other commands before implementing it. Done means xata clone start ... --dry-run validates the requested settings and permissions without transferring or mutating data.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.