setoptions
Description
sets connection options using the opts
= setoptions(opts
,Option1,OptionValue1,...,OptionN,OptionValueN
)SQLConnectionOptions
object opts
.
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.
Edit Existing MySQL Native Interface Data Source
Edit an existing MySQL® native interface data source for a MySQL database. Set an additional driver-specific option and save the data source.
Retrieve the existing MySQL data source MySQLDataSource
.
datasource = "MySQLDataSource";
opts = databaseConnectionOptions(datasource)
opts = SQLConnectionOptions with properties: DataSourceName: "MySQLDataSource" Vendor: "MySQL" DatabaseName: "toystore_doc" Server: "dbtb01" 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
Add a driver-specific connection option by using a name-value pair argument. The option specifies a timeout value for establishing the database connection. opts
contains a new section of properties for the additional connection option.
opts = setoptions(opts,"OPT_CONNECT_TIMEOUT",20)
opts = SQLConnectionOptions with properties: DataSourceName: "MySQLDataSource" Vendor: "MySQL" DatabaseName: "toystore_doc" Server: "dbtb01" PortNumber: 3306 Additional Connection Options: OPT_CONNECT_TIMEOUT: 20
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 updated data source.
saveAsDataSource(opts)
Input Arguments
opts
— Database connection options
SQLConnectionOptions
object
Database connection options, specified as an SQLConnectionOptions
object.
Option1,OptionValue1,...,OptionN,OptionValueN
— MySQL® native interface connection options
name-value pair arguments
MySQL native interface connection options, specified as one or more name-value
pair arguments. Option
is a character vector or string scalar that
specifies the name of a MySQL native interface connection option. OptionValue
specifies the value of the option. OptionValue
can be a character
vector, string scalar, logical scalar, or numeric scalar. You can specify any
MySQL native interface connection option that is a property of the SQLConnectionOptions
object. You can also set driver-specific connection
options.
Example: 'DataSourceName',"myDataSource",'Server',"localhost",'PortNumber',3306
configures a MySQL native interface data source named myDataSource
that is
located on the local server with the port number 3306
.
Output Arguments
opts
— Database connection options
SQLConnectionOptions
object
Database connection options, returned as an SQLConnectionOptions
object.
Version History
Introduced in R2020b
See Also
Objects
Functions
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
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)