Managing Enterprise Analytics Links
- how-to
The Analytics Workbench enables you to create or edit remote links and external links:
-
A remote link is a link to a remote Couchbase cluster.
-
An external link is a link to an external data source, such as Amazon S3 or S3-compatible storage.
After you have created a remote link or an external link, you must create an Analytics collection on that link to query the data.
A remote link is disconnected by default. When you create a new Analytics collection on a disconnected link, data ingestion to that collection does not begin immediately. You must connect the remote link to start data ingestion to the Analytics collections on that link.
An external link cannot be connected or disconnected. An external Analytics collection is available for query as soon as you create it. Remote links and external links are displayed in the insights sidebar of the Analytics Workbench.
In the insights sidebar, links are labeled as follows:
-
External links to the Amazon S3 or S3-compatible storage —
S3
-
Remote links —
cb remote
-
Kafka links —
KAFKA
Creating a Link
-
To create a remote link, see Stream Data from Remote Sources
-
To create an external link, see Set Up an External Data Source
Editing a Link
To edit a remote link:
-
In the UI, select the Workbench tab and browse to the link you want to edit.
-
Select the required link. NOTE: You must disconnect the link before you can edit it.
-
Edit the details of the link as required.
You cannot change the name of the link or the link type. Make sure that you enter the password in the Remote Password field. For information about the available options, see:
-
Click Save to update the link.
You can also edit a remote link or external link using the command-line interface or the REST API. See the enterprise-analytics-link-setup or Analytics Links REST API.
To edit an external link:
-
In the UI, select the Workbench tab and browse to the link you want to edit.
-
Select the required link.
-
Edit the details of the link as required.
You cannot change the name of the link or the link type. Make sure that you enter the access key, if it’s provided, in the Secret Access Key field. For more information about the available options, see: -
Click Save to update the link.
You can also edit a remote link or external link using the command-line interface or the REST API. See enterprise-analytics-link-setup or Analytics Links REST API.
Deleting a Link
To delete a remote link or an external link:
-
In the UI, select the Workbench tab and browse to the link you want to edit.
-
Select the required link.
-
Choose Drop Link.
-
To confirm that you want to delete the link, click OK.
You can also delete a remote link or external link using the command-line interface or the REST API. See enterprise-analytics-link-setup or Analytics Links REST API.