Establishing a Connection
Configure a Connection Profile
From the CData ribbon, click Get Data and select From HarperDB connection/s to launch the CData Query window. To setup a new connection, you will have to click the New HarperDB Connection button. Here you can set the connection settings, test the connection, and save the connection profile.
Connecting to HarperDB
Set the Server connection property to the hostname or IP address of your HarperDB instance. Set UseSSL to secure connections with TLS/SSL.
Authenticating to HarperDB
The add-in supports Basic authentication and token authentication. To authenticate, select the desired authentication method in the AuthScheme property, and set the necessary credentials described below.
Basic
Set AuthScheme to Basic. Set User and Password to a HarperDB user and password.
Token
Set AuthScheme to Token. The add-in supports Token authentication through the following schemes:
- Driver managed: Set User and Password to a HarperDB user and password. The driver handles obtaining and refreshing OperationToken and RefreshToken. Encrypted token credentials are stored at CredentialsLocation.
- User managed: Directly specify OperationToken and RefreshToken. The driver does not attempt to refresh or reacquire token credentials after the supplied tokens expire. The supplied tokens are located at CredentialsLocation but do not persist across connections.
The add-in also offers the following properties to govern token management in the Driver managed scheme:
- OperationTokenTimeout: this governs how long the driver attempts to use a supplied OperationToken before refreshing it. It should match the setting for operation_token lifetimes in HarperDB. It defaults to the default operation_token lifetime for HarperDB.
- RefreshTokenTimeout: this governs how long the driver attempts to use a supplied RefreshToken before refreshing it. It should match the setting for refresh_token lifetimes in HarperDB. It defaults to the default refresh_token lifetime for HarperDB.
Connection Properties
The Connection properties describe the various options that can be used to establish a connection.
Managing Connections
After successfully authenticating to HarperDB 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 HarperDB data, such as using the available CData Excel Functions.