rmoptions

Remove JDBC connection options

Since R2020b

Syntax

opts = rmoptions(opts,option)

Description

opts = rmoptions(opts,option) removes one or more specified JDBC connection options from the SQLConnectionOptions object opts.

Examples

Remove Driver-Specific Connection Option

Edit an existing JDBC data source for a Microsoft® SQL Server® database. Set an additional JDBC driver-specific option, and test the database connection. Then, remove the additional JDBC driver-specific option, and test and save the data source.

Retrieve the existing SQL Server data source SQLServerDataSource.

datasource = "SQLServerDataSource";
opts = databaseConnectionOptions(datasource)

opts = 
  SQLConnectionOptions with properties:

              DataSourceName: "SQLServerDataSource"
                      Vendor: "Microsoft SQL Server"

          JDBCDriverLocation: "C:\Drivers\mssql-jdbc-7.0.0.jre8.jar"
                DatabaseName: "toystore_doc"
                      Server: "dbtb04"
                  PortNumber: 54317
          AuthenticationType: "Windows"

opts is an SQLConnectionOptions object with these properties:

• DataSourceName — Name of the data source

• Vendor — Database vendor name

• JDBCDriverLocation — Full path of the JDBC driver file

• DatabaseName — Name of the database

• Server — Name of the database server

• PortNumber — Port number

• AuthenticationType — Authentication type

Add a JDBC 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 property for the additional JDBC connection option.

opts = setoptions(opts,'loginTimeout',"20")

opts = 
  SQLConnectionOptions with properties:

              DataSourceName: "SQLServerDataSource"
                      Vendor: "Microsoft SQL Server"

          JDBCDriverLocation: "C:\Drivers\mssql-jdbc-7.0.0.jre8.jar"
                DatabaseName: "toystore_doc"
                      Server: "dbtb04"
                  PortNumber: 54317
          AuthenticationType: "Windows"

	Additional Connection Options:

                loginTimeout: "20"

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

Remove the JDBC driver-specific option for specifying a timeout value. The opts object no longer contains the loginTimeout property.

opts = rmoptions(opts,'loginTimeout')

opts = 
  SQLConnectionOptions with properties:

              DataSourceName: "SQLServerDataSource"
                      Vendor: "Microsoft SQL Server"

          JDBCDriverLocation: "C:\Drivers\mssql-jdbc-7.0.0.jre8.jar"
                DatabaseName: "toystore_doc"
                      Server: "dbtb04"
                  PortNumber: 54317
          AuthenticationType: "Windows"

Test the database connection again.

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

status = logical
   1

Save the data source.

saveAsDataSource(opts)

Input Arguments

opts — Database connection options

SQLConnectionOptions object

Database connection options, specified as an SQLConnectionOptions object.

option — JDBC connection option

character vector | string scalar | cell array of character vectors | string array

JDBC connection option, specified as a character vector, string scalar, cell array of character vectors, or string array. Specify the name of one or more JDBC connection options or driver-specific connection options.

Example: ["DatabaseName" "Server" "PortNumber"]

Example: "loginTimeout"

Data Types: char | string | cell

Output Arguments

opts — Database connection options

SQLConnectionOptions object

Database connection options, returned as an SQLConnectionOptions object.

Version History

Introduced in R2020b