Main Content

reset

Reset JDBC or ODBC connection options to defaults

Since R2020b

collapse all in page

Syntax

opts = reset(opts)

Description

opts = reset(opts) resets all JDBC or ODBC connection options to their default values for all properties, where opts is one of the following:

The reset function also removes any additional driver-specific properties from these objects.

example

Examples

collapse all

Open Live Script

Create, configure, and test a JDBC data source for a Microsoft® SQL Server® database. Reset the JDBC connection options to their default values. Then configure, test, and save the data source with different JDBC connection options.

Create an SQL Server data source for a JDBC database connection.

vendor = "Microsoft SQL Server";
opts = databaseConnectionOptions("jdbc",vendor)
opts = 
  SQLConnectionOptions with properties:

              DataSourceName: ""
                      Vendor: "Microsoft SQL Server"

          JDBCDriverLocation: ""
                DatabaseName: ""
                      Server: "localhost"
                  PortNumber: 1433
          AuthenticationType: "Server"

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

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

opts = setoptions(opts, ...
    'DataSourceName',"SQLServerDataSource", ...
    'JDBCDriverLocation',"C:\Drivers\mssql-jdbc-7.0.0.jre8.jar", ...
    'DatabaseName',"toystore_doc",'Server',"dbtb04", ...
    'PortNumber',54317,'AuthenticationType',"Windows")
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"

The setoptions function sets the DataSourceName, JDBCDriverLocation, DatabaseName, Server, PortNumber, and AuthenticationType properties in the SQLConnectionOptions 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

Reset the JDBC connection options to their default values. The properties of the SQLConnectionOptions object contain the default values.

opts = reset(opts)
opts = 
  SQLConnectionOptions with properties:

              DataSourceName: ""
                      Vendor: "Microsoft SQL Server"

          JDBCDriverLocation: ""
                DatabaseName: ""
                      Server: "localhost"
                  PortNumber: 1433
          AuthenticationType: "Server"

Configure the data source by setting the JDBC connection options for the data source SQLServerDataSource, full path to the JDBC driver file, database name toystore_doc, database server dbtb04, port number 54317, and Windows® authentication. Also, set driver-specific connection options to specify a timeout value for establishing the database connection, and to disable SSL encryption.

opts = setoptions(opts, ...
    "DataSourceName","SQLServerDataSource", ...
    "JDBCDriverLocation", ...
    "C:\Drivers\mssql-jdbc-7.0.0.jre8.jar", ...
    "DatabaseName","toystore_doc", ...
    "Server","dbtb04","PortNumber",54317, ...
    "AuthenticationType","Windows","loginTimeout","20", ...
    "encrypt","false")
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:

                     encrypt: "false"
                loginTimeout: "20"

The setoptions function sets the DataSourceName, JDBCDriverLocation, DatabaseName, Server, PortNumber, and AuthenticationType properties in the SQLConnectionOptions object. The driver-specific connection options appear below the other connection options.

Test the database connection again.

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

Save the configured data source.

saveAsDataSource(opts)

Input Arguments

collapse all

Database connection options, specified as one of the following:

Output Arguments

collapse all

Database connection options, returned as one of the following:

Version History

Introduced in R2020b

expand all

See Also

Objects

Functions

Topics