setConnectionOptions

(To be removed) Set JDBC connection options

The setConnectionOptions function will be removed in a future release. Use the setoptions function instead. For details, see Version History.

Syntax

opts = setConnectionOptions(opts,Option1,OptionValue1,...,OptionN,OptionValueN)

Description

opts = setConnectionOptions(opts,Option1,OptionValue1,...,OptionN,OptionValueN) sets JDBC connection options using the JDBCConnectionOptions object opts.

Examples

Create JDBC Data Source

Create, configure, test, and save a JDBC data source for a Microsoft^® SQL Server^® database.

Create an SQL Server data source.

opts = configureJDBCDataSource('Vendor','Microsoft SQL Server')

opts = 

  JDBCConnectionOptions with properties:

                      Vendor: 'Microsoft SQL Server'
              DataSourceName: ''

                DatabaseName: ''
                      Server: 'localhost'
                  PortNumber: 1433
                    AuthType: 'Server'

          JDBCDriverLocation: ''

opts is a JDBCConnectionOptions object with these properties:

• Vendor — Database vendor name

• DataSourceName — Name of the data source

• DatabaseName — Name of the database

• Server — Name of the database server

• PortNumber — Port number

• AuthType — Authentication type

• JDBCDriverLocation — Full path of the JDBC driver file

Configure the data source by setting the JDBC connection options for the data source SQLServerDataSource, database server dbtb04, port number 54317, full path to the JDBC driver file, and Windows® authentication.

opts = setConnectionOptions(opts, ...
    'DataSourceName','SQLServerDataSource', ...
    'Server','dbtb04','PortNumber',54317, ...
    'JDBCDriverLocation','C:\Drivers\sqljdbc4.jar', ...
    'AuthType','Windows')

opts = 

  JDBCConnectionOptions with properties:

                      Vendor: 'Microsoft SQL Server'
              DataSourceName: 'SQLServerDataSource'

                DatabaseName: ''
                      Server: 'dbtb04'
                  PortNumber: 54317
                    AuthType: 'Windows'

          JDBCDriverLocation: 'C:\Drivers\sqljdbc4.jar'

The setConnectionOptions function sets the DataSourceName, Server, PortNumber, AuthType, and JDBCDriverLocation properties in the JDBCConnectionOptions object.

Test the database connection with a blank user name and password. The testConnection function returns the logical 1, which indicates the database connection is successful.

username = "";
password = "";
status = testConnection(opts,username,password)

status = logical

   1

Save the configured data source.

saveAsJDBCDataSource(opts)

You can connect to the new data source using the database function or the Database Explorer app.

Input Arguments

opts — JDBC connection options

JDBCConnectionOptions object

JDBC connection options, specified as a JDBCConnectionOptions object.

Option1,OptionValue1,...,OptionN,OptionValueN — JDBC connection options to set

name-value pair arguments

JDBC connection options to set, specified as one or more name-value pair arguments. Option is a character vector or string scalar that specifies the name of a JDBC connection option. OptionValue specifies the value of the JDBC connection option. OptionValue can be a character vector, string scalar, logical scalar, or numeric scalar. You can specify any JDBC connection option that is a property of the JDBCConnectionOptions object.

Example: 'DataSourceName','myDataSource','Vendor','MySQL','Server','localhost','PortNumber',3306 configures a JDBC data source named myDataSource for a MySQL^® database located on the local server with the port number 3306.

Output Arguments

opts — JDBC connection options

JDBCConnectionOptions object

JDBC connection options, returned as a JDBCConnectionOptions object.

Alternative Functionality

App

You can set JDBC connection options by using the JDBC Data Source Configuration dialog box in the Database Explorer app. In the Data Source section of the Database Explorer tab, select Configure Data Source > Configure JDBC data source.

Version History

Introduced in R2019b

R2020b: setConnectionOptions function will be removed

The setConnectionOptions function will be removed in a future release. Use the setoptions function instead. Some differences between the workflows might require updates to your code.

Update Code

Use the setoptions function with the SQLConnectionOptions object to set the JDBC connection options.

In prior releases, you configured a JDBC data source using the setConnectionOptions function and the JDBCConnectionOptions object. For example:

opts = configureJDBCDataSource('Vendor','Microsoft SQL Server');
opts = setConnectionOptions(opts, ...
    'DataSourceName','SQLServerDataSource', ...
    'Server','dbtb04','PortNumber',54317, ...
    'JDBCDriverLocation','C:\Drivers\sqljdbc4.jar', ...
    'AuthType','Windows');
username = "";
password = "";
status = testConnection(opts,username,password);
saveAsJDBCDataSource(opts)

Now you can set JDBC connection options using the setoptions function, and save the data source using the SQLConnectionOptions object instead.

vendor = "Microsoft SQL Server";
opts = databaseConnectionOptions("jdbc",vendor);
opts = setoptions(opts, ...
    'DataSourceName',"SQLServerDataSource", ...
    'JDBCDriverLocation',"C:\Drivers\sqljdbc4.jar", ...
    'DatabaseName',"toystore_doc",'Server',"dbtb04", ...
    'PortNumber',54317,'AuthType',"Windows");
username = "";
password = "";
status = testConnection(opts,username,password);
saveAsDataSource(opts)