dsccommunity / dsccommunity/SqlServerDsc

Sql<Setup Action>: New resource proposal

Open
#1,781 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted resource proposal
Dominant language
PowerShell
Stars
385
Forks
224
PR merge metrics
No merged PRs in 30d

Description

Resource proposal

To simplify the SqlSetup resource and address some existing issues (#1637 in particular), I propose that the SqlSetup resource be broken out into separate resources based on the setup Action being performed.

A SqlSetupBase class would hold the shared logic for setup tasks. But subclasses would be created to correlate with setup actions as listed below. The subclasses would also only allow users to set options relevant to that particular activity as set out in the Microsoft install docs here.

  • Actions
    • Install
    • Uninstall
    • PrepareImage
    • CompleteImage
    • Upgrade
    • EditionUpgrade
    • Repair
    • RebuildDatabase
    • InstallFailoverCluster
    • PrepareFailoverCluster
    • CompleteFailoverCluster
    • AddNode
    • RemoveNode
Proposed properties

All properties would be refactored from the existing SqlSetup MOF-based resource with common properties consolidated up to the parent SqlSetupBase class.

Special considerations or limitations

The current functionality of SqlSetup uses active connections to get many settings. However, at least one action: PrepareFailoverCluster does not result in a functioning SQL service. This should be taken into account when writing the shared functionality of SqlSetupBase.

Contributor guide

Open the contributing guide

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 locating the existing SqlSetup MOF-based resource and review issue #1637 alongside the Microsoft SQL Server command-prompt installation documentation. Define the shared SqlSetupBase behavior and separate resources for the listed setup actions, including how PrepareFailoverCluster works without a functioning SQL service; done means each action accepts only its relevant properties.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.