Skip to content

[RDBMS] Breaking Change: Parameter name updates. Improvements to Management Plane for MySQL and PostgreSQL - #15363

Merged
Zunli Hu (Juliehzl) merged 36 commits into
Azure:devfrom
DaeunYim:dev
Oct 22, 2020
Merged

[RDBMS] Breaking Change: Parameter name updates. Improvements to Management Plane for MySQL and PostgreSQL#15363
Zunli Hu (Juliehzl) merged 36 commits into
Azure:devfrom
DaeunYim:dev

Conversation

@mjain2

@mjain2 Mollee Jain (mjain2) commented Sep 30, 2020

Copy link
Copy Markdown
Contributor

Description

  • Note: Recreating this PR to update the history/rebase with hotfix changes for rdbms.

This PR improves existing commands for the 'Flexible Servers' APIs within the RDBMS component.

Breaking changes:
Parameter name changes

  1. -- time to --restore-in-time for restore command
    Why: PM requested change to make it clearer for customer. Documentation on our side will also be updated.
  2. --force to --yes
    Why: Consistency across different delete prompt commands for customer experience.
  3. --server-name to --name for CRUD operations
    Why: PM requested change for consistency
  4. --name to --rule-name in firewall rule
    Why: PM requested for clearer & self-explanatory params for customer experience.

Changes include:

  • Update MySQL Connection string in create command
  • Replace server name check with CheckNameAvailability API for MySQL & PostgreSQL
  • Update help text and parameters for commands to be more descriptive and helpful to user (commands/arguments: vnet related, replica, firewall, restore). These were to improve customer experience.
  • Update validators to use result from list-skus commands/API.
  • Enabled more tests for code coverage and command testing (validator & replica tests)
  • Added new recording files with default locations for MySQL & PostgreSQL

Testing Guide

To run tests (these cover existing commands and include new tests):
azdev test rdbms


This checklist is used to make sure that common guidelines for a pull request are followed.

@mjain2

Copy link
Copy Markdown
Contributor Author

Please merge this with a squash commit :)

@yonzhan

Copy link
Copy Markdown
Collaborator

RDBMS

@Juliehzl

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Pull request contains merge conflicts.

Comment thread src/azure-cli/azure/cli/command_modules/rdbms/_helptext_mysql.py
c.argument('server_name', id_part='name', options_list=['--name', '-n'], arg_type=server_name_getter_arg_type)
c.argument('force', options_list=['--force'], action='store_true',
help='Delete the server without prompt')
c.argument('yes', options_list=['--yes', '-y'], action='store_true',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

renaming parameters name is breaking change. could you explain why we need such renaming?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we wanted to deleting align confirmation parameters same as deleting commands of other resources

@mjain2 Mollee Jain (mjain2) Oct 20, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zunli Hu (@Juliehzl) have updated the PR description to reflect these changes. Our new service was just rolled out last week so usage is still low, so there is relatively low risk.

Comment thread src/azure-cli/azure/cli/command_modules/rdbms/_params.py
Comment thread src/azure-cli/azure/cli/command_modules/rdbms/_params.py
@Juliehzl

Copy link
Copy Markdown
Contributor

could you refine description part according to https://github.com/Azure/azure-cli/tree/dev/doc/authoring_command_modules#submitting-pull-requests?

@mjain2 Mollee Jain (mjain2) changed the title [RDBMS] Improvements to Management Plane for MySQL and PostgreSQL [RDBMS] Breaking Change: Parameter name updates. Improvements to Management Plane for MySQL and PostgreSQL Oct 20, 2020
@mjain2

Copy link
Copy Markdown
Contributor Author

could you refine description part according to https://github.com/Azure/azure-cli/tree/dev/doc/authoring_command_modules#submitting-pull-requests?

Made the update thanks!

@Juliehzl Zunli Hu (Juliehzl) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve for the breaking change because there is little usages in past 30 days and service team request

@Juliehzl
Zunli Hu (Juliehzl) merged commit 0c54416 into Azure:dev Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants