databaseConnectionOptions

Create database connection options

collapse all in page

Syntax

opts = databaseConnectionOptions(drivertype,vendor)
opts = databaseConnectionOptions(datasource)

Description

example

opts = databaseConnectionOptions(drivertype,vendor) creates an SQLConnectionOptions object opts using the specified driver type and database vendor. The SQLConnectionOptions object contains the database connection options.

example

opts = databaseConnectionOptions(datasource) enables you to edit an existing data source using its name.

Examples

collapse all

Open Live Script

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

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

Save the configured data source.

saveAsDataSource(opts)

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

Open Live Script

Edit an existing JDBC data source for a Microsoft® SQL Server® database. Set an additional JDBC driver-specific option, 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 section of properties 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

Save the updated data source.

saveAsDataSource(opts)

Input Arguments

collapse all

Driver type, specified as one of these values:

  • "jdbc" — JDBC driver

  • "native" — Native interface

You can specify the value as either a character vector or string scalar.

Database vendor, specified as one of these values:

  • For JDBC drivers:

    • "Microsoft SQL Server" — Microsoft® SQL Server® database

    • "MySQL" — MySQL® database

    • "Oracle" — Oracle® database

    • "PostgreSQL" — PostgreSQL database

    • "Other" — Other database

  • For native interfaces:

    • "MySQL" — MySQL native interface

    • "PostgreSQL" — PostgreSQL native interface

If the drivertype input argument is "jdbc", then the vendor argument must be one of the values for JDBC drivers. If the drivertype input argument is "native", then the vendor argument must be one of the values for native interfaces.

You can specify the value as either a character vector or string scalar.

Data source name, specified as a character vector or string scalar. Specify the name of an existing data source.

Example: "myDataSource"

Data Types: char | string

Output Arguments

collapse all

Database connection options, returned as one of the following objects:

Alternative Functionality

App

You can open the JDBC Data Source Configuration, MySQL Data Source Configuration, or PostgreSQL Data Source Configuration dialog boxes using the Database Explorer app. In the Data Source section of the Database Explorer tab, select one of these accordingly:

  • Configure Data Source > Configure JDBC data source

  • Configure Data Source > Configure native data source > MySQL

  • Configure Data Source > Configure native data source > PostgreSQL

See Also

Apps

Objects

Functions

Topics

Introduced in R2020b

Database Toolbox Documentation

Support