Help Manual - Couchbase Source

Documentation on SSIS Couchbase Source Component

The Couchbase Source Component is an SSIS data flow pipeline component that can be used to read/retrieve data from Couchbase.

The component includes the following three pages to configure how you want to read data from Couchbase.

  • General
  • Document Designer
  • Column

General Page

The General page of the Couchbase Source Component allows you to specify the general settings of the component.

Couchbase Source component.png

Connection Manager

The Couchbase Source Component requires a Couchbase connection in order to connect with Couchbase. The Connection Manager drop-down will show a list of all Couchbase connection managers that are available to your current SSIS package.

Bucket
The Bucket dropdown shows a list of Couchbase buckets available to you. After selecting the bucket you wish to read from, the scope and Collection drop-down will be populated with available ones.
Scope
The scope dropdown shows a list of Couchbase scopes available to you based on the bucket selected.
Collection
The Collection specifies the Couchbase Collection you wish to read from. When you choose a collection, the Couchbase Document Importer opens up.

Couchbase - Importer.png

The Bucket name and the scope and collection can be chosen, or left as it was for what was chosen on the general page. Choose the 'Items to scan" to set how many document records to be scanned to get the design. Set to "0" to read all. And add a query if required. Once done, click "Import" to import the document design, which can be viewed on the "Document designer" page.

Output as Raw Text

The Output as Raw Text option specifies whether the output should be one single output column that contains the values in Raw Text format for each row returned by Couchbase.

Query

Specify a Couchbase query to filter the documents returned from the Couchbase Collection selected.

Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve an updated list of Databases and Collections.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic updates of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Document Designer Page

The Document Designer page allows you to build the design of the document you are trying to read or import the design from an existing document.

Couchbase Source component - Document Designer.png

The Document Designer includes the following two tabs:

  • Details View
  • Additional Settings

In the Details View tab, the top part of the page is used to manually configure the nodes in the design:

  • Add Node: This button will add a new node to your Document design.
  • Remove Nodes: This button will remove a node from your Document design.
  • Direction buttons: These buttons can be used to rearrange the position of the nodes.
  • Rename Nodes: This option allows you to specify how the node name should be represented.
    • Use Qualified Names: When this option is selected, the output/column name will be set to the full qualified node name based on the node location in the document.
    • Use Short Names: When this option is selected, the output/column name will be set to the given Node Name directly.
  • Filter Columns: This option allows you to show or hide certain Columns in the grid.
    • Show Basic Columns: When this option is selected, only basic columns will be shown in the grid.
    • Show All Columns: When this option is selected, all available columns will be shown in the grid.
  • Filter Nodes: This option allows you to filter the list of nodes shown in the grid by typing a keyword in the textbox.

The Details View grid consists of:

  • Node Type: This option allows you to specify the type of the Node in your document design. There are four options available:
    • Array
    • Object
    • Value
    • Raw
  • Node Name: The Name of the Node in the document.
  • Output/Column Name: The name which will be set for the output or the column of a node.
  • Is Repeated: This option allows you to specify if a node is repeated within a document (Available when Show All Columns is selected).
  • Output type: The type of output for a node; available options are:
    • Column
    • Variable
    • Property Name As Column Value
    • Key Value Pivot
  • Output Settings: This option allows you to specify the settings of each output such as the datatype of Value Node Types.

In the Additional Settings tab, you would find the following options:

  • Null Mode: This option allows you to specify the handling of Null values.
  • 'Is Repeated' Text Qualifier: This option allows you to specify the Text Qualifier used in a document when the Is Repeated property is set to True for one or more nodes. There are four options available:
    • Double-quote(“)
    • Single-quote (‘)
    • Tick (`)
    • None
  • 'Is Repeated' Text Delimiter: This option allows you to specify the Text Delimiter used in a document when the Is Repeated property is set to True for one or more nodes. There are seven options available:
    • Newline (\n)
    • Carriage Return (\r)
    • Semicolon (;)
    • Colon (:)
    • Comma (,)
    • Tab (\t)
    • Vertical Bar (|)
Import

This option allows you to import the design of your document from one of the following four sources:

  • Designer Settings: Import the design from an existing .designer.settings file.
  • JSON (Local File): Import the design based on a JSON file on your local file system.
  • JSON (Web): Import the design based on the retrieved document from the connection manager.
  • JSON Schema (Local File): Import the design based on a JSON Schema file on your local file system.
Export

Designer Settings: This option allows you to export the current document design to a .designer.settings file which can be used later to import the same design in a different component.

Columns Page

The Columns page of the Couchbase Source Component shows you all available attributes from the table specified on the General page.

Couchbase Source component - Columns.png

On the top left of the grid, you can see a checkbox, which can be used to toggle the selection of all available fields. This is a productive way to check or uncheck all available fields.

The Columns Page grid consists of:

  • Column Name: Column that will be retrieved from Couchbase.
  • Data Type: The data type of this field.

Advanced Page

The General page of the Couchbase Source Component allows you to specify the general settings of the component.

Couchbase Source component - Advanced.png

Rex Index

Enable Rex Index by checking this option.

Is Ad Hoc

Enable this option to specify if its Ad Hoc.

Include Metrics

Specify whether to include metrics.

Max server parallelism

Specify the max server parallelism here.

Pipeline batch

Pipeline batch number to be chosen in this option.

Pipeline Cap

The pipeline cap can be set here.

Read Only

Specify read only option if applicable.

Scan Cap

Set the Scan cap in this option.

Max Item Count

Specify the max item count in here.