Overview

The component models Jira entities as relational tables/views or stored procedures, allowing you to write SQL to query Jira data or execute operations.

Live connectivity to these objects means any changes to your Jira account are immediately reflected when using the component.

• Tables are entities that can be modified. Tables support SELECT, INSERT, UPDATE, and DELETE statements. For example: Issues.
• Views are read-only tables. Only SELECT statements are supported for them. For example: Dashboards.
• Stored procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations. For example: CreateCustomField.

Jira Schema (non-cloud)

The Jira Data Center schema exposes Jira Core, Jira Software, and Jira administration-related objects as SQL entities.

Jira Cloud Schema

The Jira schema exposes tables, views, and stored procedures that apply exclusively to Jira Cloud instances.

Shared entities

The entities in System Tables and Stored Procedures are shared across the data model and can be used regardless of the schema chosen.

Customizing Schemas

Custom schema objects (such as tables and views) are defined in .rsd configuration files. These files have a simple format that makes them easy to extend; for example, to gain more control over custom fields.

To save a schema to an .rsd file, call the CreateSchema stored procedure; for example, with the IncludeCustomFields connection property set.

To include tables/views modeled by these .rsd files in the component schema, set the Location property to the folder containing your custom .rsd files. The schemas included with the component are located in the db subfolder of the installation folder.

Controlling Column Names

You can use the following properties to gain more control over column names:

• UseSimpleNames: Specifies whether to simplify column names by hiding special characters. If enabled, column names only include alphanumeric characters and underscores.
• UseDisplayNames: Specifies whether columns are displayed using their display names, rather than their API names.

Custom Fields

By default, the table and view schemas describe the column behavior of only system fields. However, you can enable custom fields for the Issues table. See Custom Fields for more information.

Handling Key Column Operators

By default, all supported operators are passed directly to the Jira API, enabling efficient server-side filtering. However, when queries include invalid Id or Key values, errors can occur, or queries may return 0 results.

See Handling Key Column Operators for information about controlling how these operators are handled by the component.