Skip to content

[RDBMS-CONNECT]: Update help files to clarify installation requirements #9878

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.

Sign up for GitHub

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

Open
nachoalonsoportillo wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −7
Open

[RDBMS-CONNECT]: Update help files to clarify installation requirements #9878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc27074
Update README and help files to clarify installation requirements for…
nachoalonsoportillo May 15, 2026
5a30b94
Update version to 1.0.8 and add installation instructions in HISTORY.rst
nachoalonsoportillo May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/rdbms-connect/HISTORY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Release History
===============

1.0.8
++++++
+ Add instructions to install the extension.

1.0.7
++++++
+ Remove msrestazure dependency
Expand Down
2 changes: 1 addition & 1 deletion src/rdbms-connect/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Microsoft Azure CLI 'rdbms-connect' Extension
==========================================

This extension enables the command to connect to Azure Database for MySQL and Azure Database for PostgreSQL flexible server instances. .
This extension enables the command to connect to Azure Database for MySQL and Azure Database for PostgreSQL flexible server instances.

-----
Usage
Expand Down
10 changes: 5 additions & 5 deletions src/rdbms-connect/azext_rdbms_connect/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

helps['mysql flexible-server connect'] = """
type: command
short-summary: Connect to a flexible server.
short-summary: Connect to a flexible server. To use this command, you must install the rdbms-connect extension. Run 'az extension add -n rdbms-connect' to install the extension if you haven't done so.
example:
- name: Connect to a flexible server using administrator username and password. Default database is used if not specified.
text: az mysql flexible-server connect -n testServer -u username -p password -d flexibleserverdb
Expand All @@ -18,7 +18,7 @@

helps['postgres flexible-server connect'] = """
type: command
short-summary: Connect to a flexible server.
short-summary: Connect to a flexible server. To use this command, you must install the rdbms-connect extension. Run 'az extension add -n rdbms-connect' to install the extension if you haven't done so.
example:
- name: Connect to a flexible server using administrator username and password. Default database is used if not specified.
text: az postgres flexible-server connect -n testServer -u username -p password -d postgres
Expand All @@ -28,7 +28,7 @@

helps['mysql flexible-server execute'] = """
type: command
short-summary: Connect to a flexible server.
short-summary: Connect to a flexible server and execute a query or a sql file. To use this command, you must install the rdbms-connect extension. Run 'az extension add -n rdbms-connect' to install the extension if you haven't done so.
example:
- name: Connect to a flexible server and execute a query with results outputted in a table.
text: az mysql flexible-server execute -n testServer -u username -p password --querytext "select host, user from mysql.user;" --output table
Expand All @@ -38,10 +38,10 @@

helps['postgres flexible-server execute'] = """
type: command
short-summary: Connect to a flexible server.
short-summary: Connect to a flexible server and execute a query or a sql file. To use this command, you must install the rdbms-connect extension. Run 'az extension add -n rdbms-connect' to install the extension if you haven't done so.
example:
- name: Connect to a flexible server and execute a query with results outputted in a table.
text: az postgres flexible-server execute -n testServer -u username -p password --querytext "select * from pg_user;" --output table
- name: Connect to a flexible server and execute a sql file.
text: az mysql flexible-server execute -n testServer -u username -p password --file-path path_to_sql_file
text: az postgres flexible-server execute -n testServer -u username -p password --file-path path_to_sql_file
"""
2 changes: 1 addition & 1 deletion src/rdbms-connect/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

# TODO: Confirm this is the right version number you want and it matches your
# HISTORY.rst entry.
VERSION = '1.0.7'
VERSION = '1.0.8'

# The full list of classifiers is available at
# https://pypi.python.org/pypi?%3Aaction=list_classifiers
Expand Down
Loading