Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SqlServerDsc: Inconsistent Naming *Name / DatabaseName / Database / Name #1484

Closed
Rob-S opened this issue Mar 27, 2020 · 2 comments · Fixed by #1507
Closed

SqlServerDsc: Inconsistent Naming *Name / DatabaseName / Database / Name #1484

Rob-S opened this issue Mar 27, 2020 · 2 comments · Fixed by #1507
Labels
breaking change When used on an issue, the issue has been determined to be a breaking change. enhancement The issue is an enhancement request.

Comments

@Rob-S
Copy link
Contributor

Rob-S commented Mar 27, 2020

Details of the scenario you tried and the problem that is occurring

After creating SqlServerLogin then SqlDatabaseUser, I copied the User to a SqlDatabaseRole expecting the resource properties for various Database-specific objects to be similar. However, the DatabaseName property was "Database" instead, where most other properties end with "Name".

Verbose logs showing the problem

N/A

Suggested solution to the issue

Properties should be named consistently. Since most properties include "Name" at the end, so should the DatabaseName property. In fact, that is the way it already is in SqlDatabaseUser, for example.

The DSC configuration that is used to reproduce the issue (as detailed as possible)

# insert configuration here

N/A

SQL Server edition and version the target node is running

N/A

SQL Server PowerShell modules present on the target node

N/A

The operating system the target node is running

N/A

Version and build of PowerShell the target node is running

5.1.14409.1005

Version of the DSC module that was used

13.4.0

@johlju
Copy link
Member

johlju commented Mar 27, 2020

Yes, there are some properties that should be renamed, but it is a breaking change so we should do it when doing other breaking changes if possible.

@johlju johlju added breaking change When used on an issue, the issue has been determined to be a breaking change. enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. labels Mar 27, 2020
@Rob-S Rob-S changed the title Inconsistent Naming *Name / DatabaseName / Database / Name SqlServerDsc: Inconsistent Naming *Name / DatabaseName / Database / Name Mar 28, 2020
@johlju
Copy link
Member

johlju commented Apr 15, 2020

If anyone is interested and sending in a PR for this I would appreciate it. There is a pending breaking change release coming up.

Rob-S added a commit to Rob-S/SqlServerDsc that referenced this issue Apr 20, 2020
@johlju johlju added in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Apr 21, 2020
johlju pushed a commit that referenced this issue Apr 25, 2020
…atabase to DatabaseName (#1507)

- BREAKING CHANGE: Database changed to DatabaseName for consistency with other modules.
  ([issue #1484](#1484)).
  - SqlDatabaseOwner
  - SqlDatabasePermission
  - SqlDatabaseRole
- README.md
  - Changed to point to CONTRIBUTING.md on master branch to avoid "404 Page not found" (issue #1508).
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Apr 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change When used on an issue, the issue has been determined to be a breaking change. enhancement The issue is an enhancement request.
Projects
None yet
2 participants