| title | description | titleSuffix | author | ms.service | ms.subservice | ms.custom | ms.topic | ms.date | ms.author |
|---|---|---|---|---|---|---|---|---|---|
Copy data from Couchbase (Preview) |
Learn how to copy data from Couchbase to supported sink data stores using a copy activity in an Azure Data Factory or Synapse Analytics pipeline. |
Azure Data Factory & Azure Synapse |
jianleishen |
data-factory |
data-movement |
synapse |
conceptual |
09/09/2021 |
jianleishen |
[!INCLUDEappliesto-adf-asa-md] This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from Couchbase. It builds on the copy activity overview article that presents a general overview of copy activity.
Important
This connector is currently in preview. You can try it out and give us feedback. If you want to take a dependency on preview connectors in your solution, please contact Azure support.
This Couchbase connector is supported for the following activities:
You can copy data from Couchbase to any supported sink data store. For a list of data stores that are supported as sources/sinks by the copy activity, see the Supported data stores table.
The service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.
[!INCLUDE data-factory-v2-integration-runtime-requirements]
[!INCLUDE data-factory-v2-connector-get-started]
Use the following steps to create a linked service to Couchbase in the Azure portal UI.
-
Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New:
:::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Screenshot of creating a new linked service with Azure Data Factory UI.":::
:::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Screenshot of creating a new linked service with Azure Synapse UI.":::
-
Search for Couchbase and select the Couchbase connector.
:::image type="content" source="media/connector-couchbase/couchbase-connector.png" alt-text="Screenshot of the Couchbase connector.":::
-
Configure the service details, test the connection, and create the new linked service.
:::image type="content" source="media/connector-couchbase/configure-couchbase-linked-service.png" alt-text="Screenshot of linked service configuration for Couchbase.":::
The following sections provide details about properties that are used to define Data Factory entities specific to Couchbase connector.
The following properties are supported for Couchbase linked service:
| Property | Description | Required |
|---|---|---|
| type | The type property must be set to: Couchbase | Yes |
| connectionString | An ODBC connection string to connect to Couchbase. You can also put credential string in Azure Key Vault and pull the credString configuration out of the connection string. Refer to the following samples and Store credentials in Azure Key Vault article with more details. |
Yes |
| connectVia | The Integration Runtime to be used to connect to the data store. Learn more from Prerequisites section. If not specified, it uses the default Azure Integration Runtime. | No |
Example:
{
"name": "CouchbaseLinkedService",
"properties": {
"type": "Couchbase",
"typeProperties": {
"connectionString": "Server=<server>; Port=<port>;AuthMech=1;CredString=[{\"user\": \"JSmith\", \"pass\":\"access123\"}, {\"user\": \"Admin\", \"pass\":\"simba123\"}];"
},
"connectVia": {
"referenceName": "<name of Integration Runtime>",
"type": "IntegrationRuntimeReference"
}
}
}Example: store credential string in Azure Key Vault
{
"name": "CouchbaseLinkedService",
"properties": {
"type": "Couchbase",
"typeProperties": {
"connectionString": "Server=<server>; Port=<port>;AuthMech=1;",
"credString": {
"type": "AzureKeyVaultSecret",
"store": {
"referenceName": "<Azure Key Vault linked service name>",
"type": "LinkedServiceReference"
},
"secretName": "<secretName>"
}
},
"connectVia": {
"referenceName": "<name of Integration Runtime>",
"type": "IntegrationRuntimeReference"
}
}
}For a full list of sections and properties available for defining datasets, see the datasets article. This section provides a list of properties supported by Couchbase dataset.
To copy data from Couchbase, set the type property of the dataset to CouchbaseTable. The following properties are supported:
| Property | Description | Required |
|---|---|---|
| type | The type property of the dataset must be set to: CouchbaseTable | Yes |
| tableName | Name of the table. | No (if "query" in activity source is specified) |
Example
{
"name": "CouchbaseDataset",
"properties": {
"type": "CouchbaseTable",
"typeProperties": {},
"schema": [],
"linkedServiceName": {
"referenceName": "<Couchbase linked service name>",
"type": "LinkedServiceReference"
}
}
}For a full list of sections and properties available for defining activities, see the Pipelines article. This section provides a list of properties supported by Couchbase source.
To copy data from Couchbase, set the source type in the copy activity to CouchbaseSource. The following properties are supported in the copy activity source section:
| Property | Description | Required |
|---|---|---|
| type | The type property of the copy activity source must be set to: CouchbaseSource | Yes |
| query | Use the custom SQL query to read data. For example: "SELECT * FROM MyTable". |
No (if "tableName" in dataset is specified) |
Example:
"activities":[
{
"name": "CopyFromCouchbase",
"type": "Copy",
"inputs": [
{
"referenceName": "<Couchbase input dataset name>",
"type": "DatasetReference"
}
],
"outputs": [
{
"referenceName": "<output dataset name>",
"type": "DatasetReference"
}
],
"typeProperties": {
"source": {
"type": "CouchbaseSource",
"query": "SELECT * FROM MyTable"
},
"sink": {
"type": "<sink type>"
}
}
}
]To learn details about the properties, check Lookup activity.
For a list of data stores supported as sources and sinks by the copy activity, see supported data stores.