testConnection
Syntax
Description
tests the MySQL® native interface database connection specified by the status
= testConnection(opts
,username
,password
)SQLConnectionOptions
object opts
, a user name, and a
password.
Examples
Create MySQL Native Interface Data Source
Create, configure, test, and save a MySQL® native interface data source for a MySQL database.
Create a MySQL native interface data source for a MySQL native interface database connection.
vendor = "MySQL"; opts = databaseConnectionOptions("native",vendor)
opts = SQLConnectionOptions with properties: DataSourceName: "" Vendor: "MySQL" DatabaseName: "" Server: "localhost" PortNumber: 3306
opts
is an SQLConnectionOptions
object with these properties:
DataSourceName
— Name of the data sourceVendor
— Database vendor nameDatabaseName
— Name of the databaseServer
— Name of the database serverPortNumber
— Port number
Configure the data source by setting the database connection options for the data source MySQLDataSource
, database name toystore_doc
, database server dbtb01
, and port number 3306
.
opts = setoptions(opts, ... 'DataSourceName',"MySQLDataSource", ... 'DatabaseName',"toystore_doc",'Server',"dbtb01", ... 'PortNumber',3306)
opts = SQLConnectionOptions with properties: DataSourceName: "MySQLDataSource" Vendor: "MySQL" DatabaseName: "toystore_doc" Server: "dbtb01" PortNumber: 3306
The setoptions
function sets the DataSourceName
, DatabaseName
, Server
, and PortNumber
properties in the SQLConnectionOptions
object.
Test the database connection with a user name and password. The testConnection
function returns the logical 1
, which indicates the database connection is successful.
username = "root"; password = "matlab"; status = testConnection(opts,username,password)
status = logical
1
Save the configured data source.
saveAsDataSource(opts)
You can connect to the new data source using the mysql
function or the Database Explorer app.
Retrieve Message for MySQL Native Interface Database Connection Test
Create and configure a MySQL native interface data source to a MySQL database. Test the database connection to the MySQL native interface data source and retrieve the error message.
Create a MySQL native interface data source for a MySQL database connection.
vendor = "MySQL"; opts = databaseConnectionOptions("native",vendor)
opts = SQLConnectionOptions with properties: DataSourceName: "" Vendor: "MySQL" DatabaseName: "" Server: "localhost" PortNumber: 3306
opts
is an SQLConnectionOptions
object with
these properties:
DataSourceName
— Name of the data sourceVendor
— Database vendor nameDatabaseName
— Name of the databaseServer
— Name of the database serverPortNumber
— Port number
Configure the data source by setting the database connection options for the data
source MySQLDataSource
, database name
toystore_doc
, database server dbtb01
, and port
number 3306
.
opts = setoptions(opts, ... 'DataSourceName',"MySQLDataSource", ... 'DatabaseName',"toystore_doc",'Server',"dbtb01", ... 'PortNumber',3306)
opts = SQLConnectionOptions with properties: DataSourceName: "MySQLDataSource" Vendor: "MySQL" DatabaseName: "toystore_doc" Server: "dbtb01" PortNumber: 3306
The setoptions
function sets the
DataSourceName
, DatabaseName
,
Server
, and PortNumber
properties in the
SQLConnectionOptions
object.
Test the database connection using an incorrect user name and password. The
testConnection
function returns the logical 0
,
which indicates the database connection fails. Retrieve and display the error message
for the failed connection.
username = "wronguser"; password = "wrongpassword"; [status,message] = testConnection(opts,username,password)
status = logical
0
message =
'1045 : Access denied for user 'wronguser'@'SERVERNAME' (using password: YES).'
Input Arguments
opts
— Database connection options
SQLConnectionOptions
object
Database connection options, specified as an SQLConnectionOptions
object.
username
— User name
character vector | string scalar
User name required to access the database, specified as a character vector or string scalar.
If no user name is required, specify an empty value ""
.
Data Types: char
| string
password
— Password
character vector | string scalar
Password required to access the database, specified as a character vector or string scalar. If
no password is required, specify an empty value ""
.
Data Types: char
| string
Output Arguments
status
— Connection status
logical
Connection status, returned as a logical true
if the connection
test passes or false
if the connection test fails.
message
— Error message
character vector
Error message, returned as a character vector. If the connection test passes, then the error message is an empty character vector. Otherwise, the error message contains text describing the failed database connection.
Version History
Introduced in R2020b
See Also
Objects
Functions
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)