SQL Connection Properties

The following properties are available for SQL Connection objects, grouped by the categories shown in the connection editors.

Information

Property Type Default Description

ID

string

The string value that uniquely identifies the metadata.

Name

string

The name of the metadata object.

JDBC

Property Type Default Description

ConnectionURL

string

Specifies the JDBC connection URL, such as jdbc:sqlserver://localhost;DatabaseName=MyDatabase

The URL can be tokenized.

DatabaseType
displayed as Database

SQLDatabaseType

SQLDatabaseType.Unspecified

The JDBC-compliant relational database type.

This property is optional, but it allows database-specific functionality to be leveraged. For example, the "Microsoft" SQL Server database type allows for the possibility of using Windows authentication via the AuthenticationMode property.

See also: AuthenticationMode

DriverClass

string

The name of the JDBC driver class, such as com.microsoft.sqlserver.jdbc.SQLServerDriver.

JNDI

Property Type Default Description

DataSource

string

Specifies the fully qualified JNDI data source, such as java:comp/env/jdbc/MyDataSource

The DataSource can be tokenized. A Username and Password may also be specified for a JNDI data source.

Note: Some application servers use aliases that eliminate the need for the 'java:comp/env/' prefix to the JNDI Data Source.

Misc

Property Type Default Description

CredentialsPolicy

SQLCredentialsPolicy

SQLCredentialsPolicy.SpecifyUsernameAndPassword

Indicates whether both the username and password, only the username, or neither the username or password are required for the connection to be a valid JDBC connection.

Depending on the authentication protocol used for the SQL connection, the setting is used to inform the Dodeca service as to whether or not to treat the lack of credentials as an exception.

Miscellaneous

Property Type Default Description

ConnectionMethod

SQLConnectionMethod

SQLConnectionMethod.ServerBased

SQL Login

Property Type Default Description

LoginDialogCaption

string

The caption used by the SQL Login Dialog when prompting the user to provide credentials for this connection.

Security

Property Type Default Description

AuthenticationMode

SQLAuthenticationMode

SQLAuthenticationMode.SQLAuthentication

The authentication mode to utilize when executing queries against the relational database.

SQLAuthentication - Connects to the relational database with the username and password assigned to the connection object and executes SQL queries as the provided user.

WindowsAuthentication - Connects to the relational database with the username and password assigned to the connection object and executes SQL queries as the current Windows user via impersonation.

When WindowsAuthentication is utilized, the user assigned to the connection object must have impersonate permission for end-user accounts.

See also: Database

Password

string

The JDBC password.

The password can be tokenized.

UseAuthenticatedUsernameAndPassword

bool

false

When an authentication service is associated with the Dodeca application, the UseAuthenticatedUsernameAndPassword property controls whether the authenticated username and password are used as the SQL connection username and password.

Username

string

The JDBC user name.

The user name can be tokenized.

Test

Property Type Default Description

TestTokens

TokenTable