Establishing a Connection
Enabling SSIS in Visual Studio 2022
If you're using Visual Studio 2022, you will need to install the SQL Server Integration Services Projects extension to use SSIS.
- Navigate to Extensions > Manage Extensions.
- In the Manage Extensions window's search box, search for "SQL Server Integration Services Projects 2022" and select the extension in the list.
- Click Download.
- Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer. Proceed through the installer with default settings.
- Open Visual Studio. There should now be an "Integration Services Project" project template available.
Adding the Couchbase Connection Manager
Create a new connection manager as follows:
- Create a Visual Studio project with the "Integration Services Project" template.
- In the project, right-click within the Connection Managers window and select New Connection from the menu.
- In the Description column, select CData Couchbase Connection Manager and click Add...
- Configure the component as described in the next section.
Alternatively, if you have an existing project and CData Couchbase Source or CData Couchbase Destination:
- Right-click your CData Couchbase source or destination component in your data flow
- Select Edit... to open an editor window.
- Click the New... button next to the Connection manager: dropdown selector to create a connection manager.
- Configure the component as described in the next section.
Connecting to Couchbase
To connect to data, set the Server property to the hostname or IP address of the Couchbase server(s) you are authenticating to.
If your Couchbase server is configured to use SSL, you can enable it either by using an https URL for Server (like https://couchbase.server), or by setting the UseSSL property to True.
Couchbase Analytics
By default, the component connects to the N1QL Query service. In order to connect to the Couchbase Analytics service, you will also need to set the CouchbaseService property to Analytics.
Couchbase Cloud
Set the following to connect to Couchbase Cloud:
- AuthScheme: Set this to Basic.
- ConnectionMode: Set this to Cloud.
- DNSServer: Set this to a DNS server. In most cases, this should be a public DNS service like 1.1.1.1 or 8.8.8.8.
- SSLServerCert: Set this to the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected. Alternatively, set "*" to accept all certificates.
Authenticating to Couchbase
The component supports several forms of authentication. Couchbase Cloud only accepts Standard authentication, while Couchbase Server accepts Standard authentication, client certificates, and credentials files.
Standard Authentication
To authenticate with standard authentication, set the following:
- AuthScheme: Set this to Basic.
- User: The user authenticating to Couchbase.
- Password: The password of the user authenticating to Couchbase.
Client Certificates
The component supports authenticating with client certificates when SSL is enabled. To use client certificate authentication, set the following properties:
- AuthScheme: Set this to SSLCertificate.
- SSLClientCertType: The type of client certificate set within SSLClientCert.
- SSLClientCert: The client certificate in the format given by SSLClientCertType.
- SSLClientCertPassword (optional): The password of the client certificate, if it is encrypted.
- SSLClientCertSubject (optional): The subject of the client certificate, which, by default, is the first certificate found in the store. This is required if more than one certificate is available in the certificate store.
Credentials File
You can also authenticate using using a credentials file containing multiple logins. This is included for legacy use and is not recommended when connecting to a Couchbase Server that supports role-based authentication.
- AuthScheme: Set this to CredentialsFile.
- CredentialsFile: The path to the credentials file. Refer to Couchbase's documentation for more information on the format of this file.