Skip to main content

Database connection

Open with Workspace → Connections → Database… on the main menu bar. A modal dialog for connecting to an Oracle or SQL Server database.

Top of the dialog

FieldShown whenWhat it does
Execution ModeDropdown: shown when enabled for this workspaceWhich execution mode to use.
Reversal ModeDropdown: shown when enabled for this workspaceWhich reversal mode to use.
Database VendorAlways shownDropdown: picks which vendor-specific form to show below.

Bottom buttons

ButtonWhat it does
DisconnectClose the active connection. Shown only when connected.
ConnectActivate the selected connection as the workspace's current database.
TestVerify the connection works without making it active.
CancelClose the dialog without changes.

Auto-connect on startup

At the bottom of the dialog, a checkbox: Auto-connect on startup. Tooltip: "Automatically connect to this database when opening this workspace. Only available when using Windows authentication or when credentials are saved."

Vendor: SQL Server

FieldWhat it holds
Previous ConnectionsDropdown of saved connections. The ✕ button next to it deletes the currently-selected saved connection.
Connection NameThe friendly name the connection will be saved as.
ServerThe SQL Server hostname or host\instance.
DatabaseThe database / catalogue name.
AuthenticationDropdown: picks the auth method (Windows, SQL, etc.).
UsernameOnly shown for password-based authentication.
PasswordOnly shown for password-based authentication. Masked.
Trust Server CertificateCheckbox: bypass certificate validation for the connection.

Vendor: Oracle

Oracle supports four connection types selected via the Connection Type dropdown. Different fields show up for each.

Common fields (all connection types)

FieldWhat it holds
Previous ConnectionsSaved connections dropdown with delete button.
Connection NameFriendly name for the saved connection.
Connection TypeDropdown: Basic, DataSource, Cloud, Custom.
AuthenticationDropdown: auth method.
UsernameAlways shown (enabled when password auth is selected).
PasswordShown only for password auth. Masked.

Connection Type: Basic

Additional fields:

FieldWhat it holds
HostnameThe Oracle server hostname.
PortTCP port (usually 1521).
Service NameThe Oracle service name.
Instance NameThe Oracle instance name.
SIDThe Oracle SID (if using SID-based connection).

Connection Type: DataSource

Additional fields:

FieldWhat it holds
Data SourceThe TNS alias / data-source name.
Wallet LocationFolder path with Browse button.
TnsAdmin LocationFolder path with Browse button.

Connection Type: Cloud

Additional fields:

FieldWhat it holds
URLThe cloud connection URL.

Connection Type: Custom

Additional fields:

FieldWhat it holds
Custom StringA multi-line textbox for a hand-written connection string.

Kerberos authentication

Kerberos single sign-on against Oracle is supported directly through DataStar's managed Oracle driver. In v3, you do not need to install MIT Kerberos on the client machine, which was a prerequisite in v2. DataStar ships with Oracle.ManagedDataAccess.Kerberos and Kerberos.NET built in, so the managed driver negotiates Kerberos authentication itself.

What you still need:

  1. A krb5.conf file that identifies your realm and KDCs. A common location is C:\ProgramData\Kerberos\krb5.conf.

  2. A sqlnet.ora file alongside it with the following settings:

    SQLNET.AUTHENTICATION_SERVICES=(KERBEROS5)
    SQLNET.KERBEROS5_CONF=C:/ProgramData/Kerberos/krb5.conf
    SQLNET.KERBEROS5_CONF_MIT=TRUE
    SQLNET.KERBEROS5_CC_NAME=MSLSA:

    SQLNET.KERBEROS5_CC_NAME=MSLSA: tells the driver to use the current Windows user's credential cache, which is the usual choice on a domain-joined Windows 11 machine.

To connect from the Database Connection dialog:

  1. Set Connection Type to DataSource.
  2. Set Data Source to the TNS name of your Oracle service.
  3. Set Authentication to Windows Authentication.
  4. Set TnsAdmin Location to the folder containing sqlnet.ora.
  5. Connect. The driver picks up your Windows ticket and negotiates Kerberos with Oracle.

The same sqlnet.ora works for DataStar.Tools on build and deployment agents; see the CI/CD overview for how to point the CLI at it.