JQLBuilder 1.2.0

JQL Builder

NOTE: In its current state, the package is in the RELEASE CANDIDATE phase, offering partial implementation for specified fields, along with support for all functions and operators.

Introduction

This repository houses a C# library designed to provide a JQL (Jira Query Language) builder, aiding programmers in constructing JQL queries programmatically.

The JqlBuilder library provides a fluent interface for constructing Jira Query Language (JQL) queries in a flexible and expressive manner.

For more details about JQL, please refer to the wiki.

Installation

You should install JqlBuilder with NuGet:

NuGet\Install-Package JQLBuilder

Or via the .NET Core command line interface:

dotnet add package JQLBuilder

Either commands, from Package Manager Console or .NET Core CLI, will download and install JqlBuilder and all required dependencies.

Getting Started

To start building JQL queries, use the JqlBuilder.Query entry point. The library follows a fluent API design, allowing you to chain methods to construct complex queries.

JqlBuilder.Query
    .Where(f => f.Project == "example")
    .And(f => f.Assignee == "john.doe")
    .OrderBy(f => f.Project)
    .ThenByDescending(f => f.Priority)
    .ToString();

Query Construction

The library provides extension methods for constructing various parts of a JQL query:

Filtering

• Where: Start the query with a filter condition.
• And: Add an AND condition to the existing filter.
• Or: Add an OR condition to the existing filter.

JqlBuilder.Query
    .Where(f => f.Project == "example")
    .And(f => f.Assignee == "john.doe")
    .Or(f => f.Status == "In Progress");

Ordering

• OrderBy: Specify the primary ordering field.
• OrderByDescending: Specify the primary ordering field in descending order.
• ThenBy: Add secondary ordering fields.
• ThenByDescending: Add secondary ordering fields in descending order.

JqlBuilder.Query
    .OrderBy(f => f.Project)
    .ThenByDescending(f => f.Priority)
    .ThenBy(f => f.Assignee);

Building

The ToString method is used to obtain the final JQL query string.

JqlBuilder.Query
    .Where(f => f.Project == "example")
    .And(f => f.Assignee == "john.doe")
    .OrderBy(f => f.Project)
    .ThenByDescending(f => f.Priority)
    .ToString();

Supported JQL

The following table lists the supported fields and their corresponding types, along with the supported functions and operations grouped by type

Supported Fields

Supported Operators

Supported Functions