-
Notifications
You must be signed in to change notification settings - Fork 26
Proposal: Use a dedicated id property instead of forcing a unique name #317
Description
Background
To support overwrite-delete-stale we've added a constraint for plugins names to be unique.
Also as a result we're planning to make the path required, as to allow users to change the name.
Problem
I believe it's quite hard to communicate the reason name has to be unique, and easy for users to miss that requirement (also if users split their config across multiple machines we can't really validate it either).
Additionally since we're planning to make path required due to the uniqueness of name, it adds friction for people onboarding CloudQuery.
Proposal
Instead of making name unique we can add a dedicated id configuration (it can default to name) and use that instead.
As a result we can achieve the following:
- Keep the meaning of
nameandpaththe same - Keep
pathoptional, as we can resolve it fromname - Users that don't need to run CloudQuery in parallel don't need to know anything about uniqueness
- Easier to understand why an
idproperty needs to be unique
TLDR: Only users that split their configuration (e.g. run in parallel) should care about having a unique identifier.