rmoptions
Description
removes one or more specified connection options from the opts
= rmoptions(opts
,option
)SQLConnectionOptions
object opts
.
Examples
Remove Driver-Specific Connection Option
Edit an existing PostgreSQL native interface data source for a PostgreSQL database. Set an additional driver-specific option, and test the database connection. Then, remove the additional driver-specific option, and test and save the data source.
Retrieve the existing PostgreSQL native interface data source.
datasource = "PostgreSQLDataSource";
opts = databaseConnectionOptions(datasource)
opts = SQLConnectionOptions with properties: DataSourceName: "PostgreSQLDataSource" Vendor: "PostgreSQL" DatabaseName: "toystore_doc" Server: "dbtb00" PortNumber: 5432
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 property for the additional connection option.
opts = setoptions(opts,"connect_timeout",20)
opts = SQLConnectionOptions with properties: DataSourceName: "PostgreSQLDataSource" Vendor: "PostgreSQL" DatabaseName: "toystore_doc" Server: "dbtb00" PortNumber: 5432 Additional Connection Options: 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 = "dbdev"; password = "matlab"; status = testConnection(opts,username,password)
status = logical
1
Remove the driver-specific option for specifying a timeout value. The opts
object no longer contains the connect_timeout
property.
opts = rmoptions(opts,"connect_timeout")
opts = SQLConnectionOptions with properties: DataSourceName: "PostgreSQLDataSource" Vendor: "PostgreSQL" DatabaseName: "toystore_doc" Server: "dbtb00" PortNumber: 5432
Test the database connection again.
username = "dbdev"; password = "matlab"; 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
— PostgreSQL native interface connection option
character vector | string scalar | cell array of character vectors | string array
PostgreSQL native interface connection option, specified as a character vector, string scalar, cell array of character vectors, or string array. Specify the name of one or more PostgreSQL native interface connection options or driver-specific connection options.
Example: ["DatabaseName" "Server" "PortNumber"]
Example: "connect_timeout"
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
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)