Ready to get started?

Connect to Couchbase Data as a Linked Server

Use the SQL Broker and the ODBC Driver to set up a linked server for Couchbase data.

You can use the SQL Broker to configure a TDS (SQL Server) remoting service and set up a linked server for Couchbase data. After you have started the service, you can use the UI in SQL Server Management Studio or call stored procedures to create the linked server. You can then work with Couchbase data just as you would a linked SQL Server instance.

Connect to Couchbase as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

Data Source: Enter the host and port the TDS remoting service is running on, separated by a comma.

Note that a value of "localhost" in this input refers to the machine where SQL Server is running so be careful when creating a linked server in Management Studio when not running on the same machine as SQL Server.

Catalog: Enter the CData system DSN, CData Couchbase Source Sys.

In the Security section, select the option to have the connection "made using this security context" and enter the username and password of a user you created in the Users tab of the SQL Broker.

Create a Linked Server Programmatically

In addition to using the SQL Server Management Studio UI to create a linked server, you can use stored procedures. The following inputs are required:

server: The linked server name.

provider: Enter "SQLNCLI", for the SQL Server Native Client Provider.

datasrc: The host and port the service is running on, separated by a comma.

Note that a value of "localhost" in the datasrc input refers to the machine where SQL Server is running, so be careful when creating a linked server in Management Studio when not running on the same machine as SQL Server.

catalog: Enter the system DSN configured for the service.

srvproduct: Enter the product name of the data source; this can be an arbitrary value, such as "CData SQL Broker" or an empty string.

Follow the steps below to create the linked server and configure authentication to the SQL Broker:

Call the sp_addlinkedsrvlogin stored procedure to allow SQL Server users to connect with the credentials of an authorized user of the service. Note that the credentials you use to connect to the service must specify a user you configured on the Users tab of the SQL Broker.

Connect from SQL Server Management Studio

SQL Server Management Studio uses the SQL Server Client OLE DB provider, which requires the ODBC driver to be used inprocess. You must enable the "Allow inprocess" option for the SQL Server Native Client Provider in Management Studio to query the linked server from SQL Server Management Studio. To do this, open the properties for the provider you are using under Server Objects -> Linked Servers -> Providers. Check the "Allow inprocess" option and save the changes.

Execute Queries

You can now execute queries to the Couchbase linked server from any tool that can connect to SQL Server. Set the table name accordingly: