Extension packages

On this page

  1. Overview of extension packages
  2. Add SQL Server Connector to CluedIn
  3. Results
  4. Next steps

In this article, you will learn how to add the SQL Server Connector extension package to CluedIn. This is our most commonly used package, and it allows you to stream data towards database instances.

Overview of extension packages

To extend CluedIn with additional features—such as enrichers, export targets, and vocabularies—you can restore extension packages for the environment. Packages are made available through NuGet feeds. NuGet feeds are a convenient way to distribute and manage packages for your local development environment. These feeds can be hosted publicly, privately, or even on your local machine.

To facilitate local development, a preconfigured environment includes a specific folder called packages/local NuGet. This folder serves as a designated location where you can place locally built NuGet packages that need to be included in the CluedIn environment. The easiest way to integrate your locally built packages into CluedIn is to build your extension packages directly to this folder.

CluedIn has many built-in extension packages. To learn more, reach out to your CluedIn contact.

Add SQL Server Connector to CluedIn

The following image presents an overview of the steps involved in adding SQL Server Connector to CluedIn.

add-sql-server-connector.png

In the procedure, we’ll use the following input variables:

  • 202304 – name of the environment
  • CluedIn.Connector.SqlServer – name of the extension package.

To add SQL Server Connector to CluedIn

  1. Add a reference to the package by running the following command:
    pwsh .\cluedin.ps1 packages 202304 -Add CluedIn.Connector.SqlServer
    

    You will get an output similar to the following.

    add-package.png

    You can also specify a version for your package (-version) and use floating versions (for example, 1.0.0-*) for the latest pre-release.

  2. Restore the package by running the following command:
    pwsh .\cluedin.ps1 packages 202304 -Restore
    

    You will get an output similar to the following.

    restore-package.png

  3. Stop the CluedIn server by running the following command:
    pwsh .\cluedin.ps1 stop 202304
    

    You will get an output similar to the following.

    stop-cluedin-server.png

  4. Start the CluedIn server by running the following command:
    pwsh .\cluedin.ps1 up 202304
    

    You will get an output similar to the following.

    start-cluedin-server.png

    Starting the CluedIn server takes some time. When CluedIn starts up, it takes all extension assets from the disk and copies them into the container.

  5. After you start CluedIn, make sure the package was included. In Docker Desktop, select the CluedIn server and look for the similar section in logs.

    sql-connector-logs.png

  6. In browser, open the CluedIn application and check if the SQL Connector is there. To do that, go to Consume > Export Targets > Add Export Target.

    sql-connector-app.png

    The SQL Server Connector may take a few minutes to appear in the application.

Results

You have added the SQL Server Connector extension package. Now, you are ready to stream data to Microsoft SQL Server databases.

Next steps