Configure a Connection Profile

From the CData ribbon, click Get Data and select From MariaDB connection/s to launch the CData Query window. To setup a new connection, you will have to click the New MariaDB Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to MariaDB

To connect to MariaDB data, set the following properties:

• Server: The host name or IP address of the server hosting the MariaDB database.
• Port: The port of the server hosting the MariaDB database.
• Database (optional): The default database to connect to. If this is not set, MariaDB returns tables from all available databases.

Authenticating to MariaDB

MariaDB supports the following types of authentication:

• Standard
• NT Lan Manager (NTLM)
• LDAP
• SSL
• SSH
• Azure

Standard Authentication

To authenticate using standard authentication, set AuthScheme to Password and set the following properties:

• User: The username of the authenticating MariaDB user.
• Password: The password associated with the authenticating MariaDB user.

NTLM

To authenticate using NTLM, set AuthScheme to NTLM.

By default, the add-in determines user credentials and the NTLM domain automatically, using either the domain of the PC it is running on or the domain used by the machine running the MariaDB instance.

If you want to specify a different domain, provide different login credentials, or change the target NTLM version using any or all of the following optional connection properties:

• User: The authenticating NTLM user.
• Password: The authenticating NTLM user's password.
• Domain: The name of the domain you want to connect to.
• NTLMVersion: The NTLM version used by the add-in.

LDAP

To authenticate as an LDAP user, set AuthScheme to LDAP.

By default, the add-in auto-detects your LDAP credentials. If you want to designate a specific user and password, set the following optional connection properties:

• User: The user to log in as.
• Password: The user's password.

SSL

To use SSL authentication to connect securely to MariaDB data, set the following connection properties:

• SSLClientCert: The name of the certificate store for the client certificate. Used for mutual (2-way) SSL.
• SSLClientCertPassword: The password for the client certificate store, if password-protected.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
• SSLClientCertType: The type of the client certificate store.
• SSLServerCert: The certificate to accept from the MariaDB server.

SSH

To authenticate to a remote machine via SSH and access MariaDB data, set the following connection properties:

• SSHClientCert: The name of the certificate store for the client certificate.
• SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
• SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
• SSHClientCertType: The certificate type of the client store.
• SSHPassword: The password that you use to authenticate with the SSH server.
• SSHPort: The port used for SSH operations.
• SSHServer: The SSH authentication server you are trying to authenticate against.
• RSBHelpinfo_p_SSHServerFingerprint: The SSH Server fingerprint used to verify the host you are connecting to.
• SSHUser: The username for authenticating to the SSH server.

Azure Authentication

To connect to a MariaDB database hosted on Azure, set AuthScheme to one of the following values:

• AzureAD: Authenticate as a Microsoft Entra ID user (OAuth-based).
• AzureMSI: Use a Managed Service Identity assigned to an Azure VM or app.
• AzurePassword: Authenticate using your Azure username and password.

For all Azure methods, the AzureTenant property typically represents your Microsoft Entra ID tenant, often in the form companyname.microsoft.com or your directory ID as shown in the Azure Portal under Entra ID > Properties.

Managed Service Identity (AzureMSI)

To authenticate using a managed identity, set AuthScheme to AzureMSI and configure the following properties:

• AzureTenant: The Microsoft Online tenant where your MariaDB instance is hosted.
• OAuthClientId (optional): The managed identity's client ID. Required if the VM has multiple user-assigned identities.

Azure Password

To authenticate using your Azure username and password, set AuthScheme to AzurePassword and set the following connection properties:

• User: Your Azure username.
• Password: The password for your Azure account.

Entra ID (formerly Azure AD)

Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".

Entra ID is Microsoft's multi-tenant, cloud-based directory and identity management platform. It supports OAuth-based authentication flows that enable the driver to access MariaDB endpoints securely.

The steps to authenticate depend on your environment. Review the following sections for guidance on connecting from desktop applications, web-based workflows, and headless systems.

Desktop Applications

CData provides an embedded OAuth application that simplifies desktop authentication. You can also authenticate using a custom OAuth application that you configure and register in the MariaDB console. For setup instructions, see Creating a Custom OAuth Application.

Before connecting, set the following connection properties:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• Custom applications only:
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
  • CallbackURL: The redirect URI defined when you registered your custom OAuth application.

When you connect, the add-in opens the MariaDB's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the add-in refreshes it automatically.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to MariaDB you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

• Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
• Using the Excel Add-In: Find other ways to interact with MariaDB data, such as using the available CData Excel Functions.