Ready to get started?

Learn more about the CData ADO.NET Provider for Confluence or download a free trial:

Download Now

Working with Confluence Data in LINQPad

Execute LINQ queries to Confluence data in LINQPad.

The CData ADO.NET Provider for Confluence enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with Confluence data. This article shows how to connect from LINQPad and execute LINQ queries.

Create the Data Model

After downloading and installing the provider and LINQPad, create a new class library project in Visual Studio.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

  1. Right-click your project and click Add -> New Item -> ADO.NET Entity Data Model. In the resulting dialog, select Code First from database. Click New Connection and specify the connection string options in the resulting wizard.

    Obtaining an API Token

    An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

    Connect Using a Confluence Cloud Account

    To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

    • User: The user which will be used to authenticate with the Confluence server.
    • APIToken: The API Token associated with the currently authenticated user.
    • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

    Connect Using a Confluence Server Instance

    To connect to a Server instance, provide the following:

    • User: The user which will be used to authenticate with the Confluence instance.
    • Password: The password which will be used to authenticate with the Confluence server.
    • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

    Below is a typical connection string:

    User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
  2. Select the desired tables and views and click Finish to create the data model.

  3. Build the project. The generated files can be used to create the Confluence connection in LINQPad.

Connect to Confluence Data in LINQPad

After you have obtained the required connection properties and created the data model assembly, follow the steps below to start using the data model in LINQPad.

  1. Open LINQPad and click Add Connection.

  2. Select the "Use a typed data context from your own assembly" option.

  3. Select Entity Framework DbContext.

  4. Click Browse next to the Path to Custom Assembly box and browse to your project folder. Browse to the .dll or .exe under the bin folder.

  5. Select the name of the DbContext.
  6. If you saved your connection string in App.Config, specify the path to the App.config.

You can now query Confluence data through LINQPad. For examples of the supported LINQ queries, see the "LINQ and Entity Framework" chapter in the help documentation.