Bugzilla Connection
This documentation is based on version 21.0.8383 of the connector.
This documentation is based on version 21.0.8383 of the connector.
The connector leverages the Bugzilla API to enable bidirectional access to Bugzilla.
You can use the Bugzilla developer's UI to establish a connection to your Bugzilla instance. For details on this process, see Connecting to Bugzilla.
This section documents how to provide authentication for your account type.
You can authenticate to your Bugzilla account using these two parameters:
This section details a selection of advanced features of the Bugzilla connector.
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.
The Jitterbit Connector for Bugzilla allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:For example:
{ "MyView": { "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
SELECT * FROM Customers WHERE City = 'Raleigh';An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
The Jitterbit Connector for Bugzilla models Bugzilla objects as relational tables and views. A Bugzilla object has relationships to other objects in the tables, and these relationships are expressed through foreign keys.
The following sections show the available API objects and provide more information on executing SQL to Bugzilla APIs.
Schemas for most database objects are defined in simple, text-based configuration files.
The connector offloads as much of the SELECT statement processing as possible to the Bugzilla APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure* is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.
Name | Description |
Attachments | Get data about attachments, given a list of bugs and/or attachment IDs. Private attachments will only be returned if you are in the appropriate group or if you are the submitter of the attachment. |
BugCcDetail | Returns details of the CC of a certain Bug.
The 'SELECT * FROM BugCcDetail' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance. |
BugFields | Get information about valid bug fields. |
BugHistory | Returns information on the history of the bug you specified.
The 'SELECT * FROM BugHistory' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance. |
Bugs | Get information about your bugs. |
Comments | Allows you to get data about comments, given a bug ID or comment ID. |
CommentTags | Get information about the tags currently set for a comment. |
ComponentFlagTypes | Get information about the flag types of a component. |
Flags | Get information on either the flags of an attachment or the flags of a bug. |
Groups | Returns information about Bugzilla groups. |
ProductComponents | Get information on the components of a product.
Querying 'SELECT * FROM ProductComponents' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductComponents. In that case use 'IN' filtering for better performance. |
ProductMilestones | Get information about milestones of a certain product.
Querying 'SELECT * FROM ProductMilestones' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductMilestones. In that case use 'IN' filtering for better performance. |
Products | List the available products and get information about them.
By default this view will retrieve all accessible and selectable products. If you want to get only the products you can enter bugs against, you must use the 'type' filter like this: type='enterable' |
ProductVersions | Allows you to get information about versions of a certain product.
Querying 'SELECT * FROM ProductVersions' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductVersions. In that case use 'IN' filtering for better performance. |
Users | Allows you to get information about user accounts. |
Get data about attachments, given a list of bugs and/or attachment IDs. Private attachments will only be returned if you are in the appropriate group or if you are the submitter of the attachment.
Name | Type | Description |
Id [KEY] | Int | The numeric ID of the attachment. |
FileName | String | The file name of the attachment. |
Data | String | The raw data of the attachment, encoded as Base64. |
Size | Int | The length (in bytes) of the attachment. |
BugId | Int | The numeric ID of the bug that the attachment is attached to. |
Summary | String | A short string describing the attachment. |
CreationTime | Datetime | The time the attachment was created. |
LastChangeTime | Datetime | The last time the attachment was modified. |
ContentType | String | The MIME type of the attachment. |
Creator | String | The login name of the user that created the attachment. |
IsPrivate | Boolean | 'true' if the attachment is private (only visible to a certain group called the |
IsObsolete | Boolean | 'true' if the attachment is obsolete, 'false' otherwise. |
IsPatch | Boolean | 'true' if the attachment is a patch, 'false' otherwise. |
Returns details of the CC of a certain Bug.
The 'SELECT * FROM BugCcDetail' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | The ID of the cc list member. |
Name | String | The name of the cc list member. |
RealName | String | The 'real' name of the cc list member. |
String | The e-mail of the cc list member. | |
BugId | Int | The ID of the bug you're trying to get the CC details from. |
Get information about valid bug fields.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying this field in this installation only. |
Name | String | The internal name of this field. This is a unique identifier for this field. If this is not a custom field, then this name will be the same across all Bugzilla installations. |
DisplayName | String | The name of the field, as it is shown in the user interface. |
Type | Int | The number of the fieldtype. The following values are defined: '0' - Field type unknown, '1' - Single-line string field, '2' - Single value field, '3' - Multiple value field, '4' - Multi-line text value, '5' - Date field with time, '6' - Bug ID field, '7' - See Also field, '8' - Keywords field, '9' - Date field, '10' - Integer field |
IsCustom | Boolean | 'true' when this is a custom field, 'false' otherwise. |
IsMandatory | Boolean | 'true' if the field must have a value when filing new bugs. Also, mandatory fields cannot have their value cleared when updating bugs. |
IsOnBugEntry | Boolean | For custom fields, this is 'true' if the field is shown when you enter a new bug. For standard fields, this is currently always 'false', even if the field shows up when entering a bug. |
VisibilityField | String | The name of a field that controls the visibility of this field in the user interface. This field only appears in the user interface when the named field is equal to one of the values is VisibilityValues. Can be null. |
ValueField | String | The name of the field that controls whether or not particular values of the field are shown in the user interface. Can be null. |
VisibilityValues | String | This field is only shown when visibility_field matches one of these string values. When VisibilityField is null, then this is an empty array. |
Values | String | The legal values for select-type (drop-down and multiple-selection) fields. This is also populated for the Component, Version, TargetMilestone, and Keywords fields, but not for the Product field. |
Returns information on the history of the bug you specified.
The 'SELECT * FROM BugHistory' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance.
Name | Type | Description |
Who | String | The login name of the user who performed the bug change. |
When | Datetime | The date the bug activity/change happened. |
FieldName | String | The name of the bug field that has changed. |
Was | String | The previous value of the bug field which has been deleted by the change. |
Became | String | The new value of the bug field which has been added by the change. |
AttachmentId | Int | The ID of the attachment that was changed. This has a value only if the change was to an attachment. |
BugId | Int | The ID of the bug. |
Get information about your bugs.
Name | Type | Description |
Id | Int | The login name of the user who performed the bug change. |
Summary | String | The summary of this bug. |
AssignedTo | String | The login name of the user to whom the bug is assigned. |
Status | String | The current status of the bug. |
AliasAggregate | String | The unique aliases of this bug. |
ActualTime | Double | The total number of hours that this bug has taken so far. If you are not in the time-tracking group, this field will not be included in the return value. |
AssignedToId | Int | The ID of the user to whom the bug is assigned |
AssignedToRealName | String | The 'real' name of the user to whom the bug is assigned. |
Classification | String | The name of the current classification the bug is in. |
Component | String | The name of the component this bug belongs to. |
CreationTime | Datetime | When the bug was created. |
Creator | String | The login name of the person who filed this bug (the reporter). |
CreatorId | Int | The ID of the person who filed this bug (the reporter). |
Deadline | String | The day that this bug is due to be completed, in the format YYYY-MM-DD. |
DuplicateOf | Int | The bug ID of the bug that this bug is a duplicate of. If this bug isn't a duplicate of any bug, this will be null. |
EstimatedTime | Double | The number of hours that it was estimated that this bug would take. If you are not in the time-tracking group, this field will not be included in the return value. |
IsCcAccessible | Boolean | If true, this bug can be accessed by members of the CC list, even if they are not in the groups the bug is restricted to. |
IsConfirmed | Boolean | 'true' if the bug has been confirmed. Usually this means that the bug has at some point been moved out of the 'UNCONFIRMED' status and into another open status. |
IsOpen | Boolean | 'true' true if this bug is open, 'false' if it is closed. |
IsCreatorAccessible | Boolean | If true, this bug can be accessed by the creator of the bug, even if they are not a member of the groups the bug is restricted to. |
LastChangeTime | Datetime | When the bug was last changed. |
CreatorRealName | String | The real name of the person who filed this bug (the reporter). |
CreatorName | String | The name of the person who filed this bug (the reporter). |
CreatorEmail | String | The e-mail of the person who filed this bug (the reporter). |
OperatingSystem | String | The name of the operating system that the bug was filed against. |
Platform | String | The name of the platform (hardware) that the bug was filed against. |
Priority | String | The priority of the bug. |
Product | String | The name of the product this bug is in. |
QAContact | String | The login name of the current QA Contact on the bug. |
RemainingTime | Double | The number of hours of work remaining until work on this bug is complete. If you are not in the time-tracking group, this field will not be included in the return value. |
Resolution | String | The current resolution of the bug, or an empty string if the bug is open. |
Severity | String | The current severity of the bug. |
TargetMilestone | String | The milestone that this bug is supposed to be fixed by, or for closed bugs, the milestone that it was fixed for. |
UpdateToken | String | The token that you would have to pass to the process_bug.cgi page in order to update this bug. This changes every time the bug is updated. This field is not returned to logged-out users. |
URL | String | A URL that demonstrates the problem described in the bug, or is somehow related to the bug report. |
Version | String | The version the bug was reported against. |
Whiteboard | String | The value of the |
BlocksAggregate | String | The IDs of bugs that are |
CCAggregate | String | The login names of users on the CC list of this bug. |
DependsOnAggregate | String | The IDs of bugs that this bug |
KeywordsAggregate | String | Each keyword that is on this bug. |
SeeAlsoAggregate | String | The URLs in the See Also field on the bug. |
Allows you to get data about comments, given a bug ID or comment ID.
Name | Type | Description |
Id [KEY] | Int | The globally unique ID for the comment. |
BugId | Int | The ID of the bug that this comment is on. |
AttachmentId | Int | If the comment was made on an attachment, this will be the ID of that attachment. Otherwise it will be null. |
Text | String | The actual text of the comment. |
Count | Int | The number of the comment local to the bug. The Description is 0, comments start with 1. |
Creator | String | The login name of the comment's author. |
CreationTime | Datetime | The time (in Bugzilla's timezone) that the comment was added. |
IsPrivate | Boolean | 'true' if this comment is private (only visible to a certain group called the |
Get information about the tags currently set for a comment.
Name | Type | Description |
Tag | String | The comment tag that matched the specified query. |
Query | String | The query specified. |
Get information about the flag types of a component.
Name | Type | Description |
Id [KEY] | Int | The ID of the flagtype. |
FlagName | String | The name of the flagtype. |
Description | String | The description of the flagtype. |
CcList | String | The concatenated CC list for the flagtype, as a single string. |
SortKey | Int | The sortkey of the flagtype. |
IsActive | Boolean | Whether the flagtype is active or disabled. Flags being in a disabled flagtype are not deleted. It only prevents you from adding new flags to it. |
IsRequestable | Boolean | Whether you can request for the given flagtype (i.e. whether the '?' flag is available or not). |
IsRequesteeble | Boolean | Whether you can ask someone specifically or not. |
IsMultiplicable | Boolean | Whether you can have more than one flag for the given flagtype in a given bug/attachment. |
GrantGroup | Int | The group ID that is allowed to grant/deny flags of this type. If the item is not included all users are allowed to grant/deny this flagtype. |
RequestGroup | Int | The group ID that is allowed to request the flag if the flag is of the type requestable. If the item is not included all users are allowed request this flagtype. |
ProductName | String | The product that contains the component these flagtypes are in. |
ComponentName | String | The component these flagtypes are in. |
Type | String | Whether this flag type belongs to a 'bug' or an 'attachment' |
Get information on either the flags of an attachment or the flags of a bug.
Name | Type | Description |
Id [KEY] | Int | The ID of the flag. |
Name | String | The name of the flag. |
TypeId | Int | The type ID of the flag. |
Status | String | The current status of the flag. |
Setter | String | The login name of the user who created or last modified the flag. |
CreationDate | Datetime | The timestamp when this flag was originally created. |
ModificationDate | Datetime | The timestamp when the flag was last modified. |
BugId | Int | The ID of the flag. |
AttachmentId | Int | The ID of the flag. |
Returns information about Bugzilla groups.
Name | Type | Description |
Id [KEY] | Int | The unique integer ID that Bugzilla uses to identify this group. Even if the name of the group changes, this ID will stay the same. |
Name | String | The name of the group. |
Description | String | The description of the group. |
IsBugGroup | Int | Whether this group is to be used for bug reports or is only administrative specific. |
UserRegExp | String | A regular expression that allows users to be added to this group if their login matches. |
IsActive | Boolean | Whether this group is currently active or not. |
Membership | Int | Set this to 1 to get the Users of the group. This field holds no information. |
Users | String | User objects that are members of this group; only returned if the user sets the 'Membership' parameter to 1. |
Get information on the components of a product.
Querying 'SELECT * FROM ProductComponents' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductComponents. In that case use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying the component in this installation only. |
Name | String | The name of the component. This is a unique identifier for this component. |
Description | String | A description of the component, which may contain HTML. |
DefaulAssignedTo | String | The login name of the user to whom new bugs will be assigned by default. |
DefaultQAContact | String | The login name of the user who will be set as the QA Contact for new bugs by default. Empty string if the QA contact is not defined. |
SortKey | Int | Components, when displayed in a list, are sorted first by this integer and then secondly by their name. |
IsActive | Boolean | A boolean indicating if the component is active. Inactive components are not enabled for new bugs. |
ProductId | Int | The ID of the product this component belongs to. |
ProductName | String | The name of the product this component belongs to. |
Get information about milestones of a certain product.
Querying 'SELECT * FROM ProductMilestones' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductMilestones. In that case use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying this milestone. |
Name | String | The name of the milestone of the product. |
IsActive | Boolean | A boolean indicating if this milestone of the product is active. |
SortKey | Int | The sorting key of this milestone of the product. |
ProductId | Int | The ID of the product this milestone belongs to. |
ProductName | String | The name of the product this milestone belongs to. |
List the available products and get information about them.
By default this view will retrieve all accessible and selectable products. If you want to get only the products you can enter bugs against, you must use the 'type' filter like this: type='enterable'
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying the product in this installation only. |
Name [KEY] | String | The name of the product. This is a unique identifier for the product. |
Description | String | A description of the product, which may contain HTML. |
IsActive | Boolean | A boolean indicating if the product is active. |
Classification | String | The classification name for the product. |
DefaultMilestone | String | The name of the default milestone for the product. |
HasUnconfirmed | Boolean | Indicates whether the UNCONFIRMED bug status is available for this product. |
Type | String | Return information about specific type of products such as 'accessible', 'selectable', or 'enterable' |
Allows you to get information about versions of a certain product.
Querying 'SELECT * FROM ProductVersions' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductVersions. In that case use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying the version of this product. |
Name | String | The name of the version of the product. |
IsActive | Boolean | A boolean indicating if this version of the product is active. |
SortKey | Int | The sorting key of this version of the product. |
ProductId | Int | The ID of the product this version belongs to. |
ProductName | String | The name of the product this version belongs to. |
Allows you to get information about user accounts.
Name | Type | Description |
Id [KEY] | Int | The unique integer ID that Bugzilla uses to represent this user. Even if the user's login name changes, this will not change. |
Name | String | The login name of the user. |
RealName | String | The actual name of the user. May be blank. |
String | The email address of the user. | |
CanLogin | Boolean | A boolean value to indicate if the user can login into Bugzilla. |
EmailEnabled | Boolean | A boolean value to indicate if bug-related mail will be sent to the user or not. |
LoginDeniedText | String | A text field that holds the reason for disabling a user from logging into Bugzilla. If empty then the user account is enabled; otherwise it is disabled/closed. |
SavedSearches | String | User's saved searches. |
SavedReports | String | User's saved reports. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Bugzilla:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the SampleTable_1 table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure* parameters.
The following query returns information about all of the input parameters for the SampleProcedure stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure* containing the parameter. |
ColumnName | String | The name of the stored procedure* parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys. The following query retrieves the primary key for the SampleTable_1 table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys. The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:bugzilla:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the connector can offload to the data source.
When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures* that can be used for generating schema files. |
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
URL | The URL to the Bugzilla server used for logging in. |
APIKey | An ApiKey to authenticate to your account. API keys can be created in the Preferences > API Keys section. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
IncludeCustomFields | Determines if Custom Fields should be included as table columns or not. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Bugzilla. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
The URL to the Bugzilla server used for logging in.
string
""
The URL to the Bugzilla server used for logging in.
An ApiKey to authenticate to your account. API keys can be created in the Preferences > API Keys section.
string
""
ApiKey
This section provides a complete list of SSL properties you can configure.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of schema properties you can configure.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
string
"%APPDATA%\\Bugzilla Data Provider\Schema"
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\Bugzilla Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
IncludeCustomFields | Determines if Custom Fields should be included as table columns or not. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Bugzilla. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
Determines if Custom Fields should be included as table columns or not.
string
"false"
It is possible to create custom fields in Bugzilla. To retrieve their values you can set IncludeCustomFields=true as a connection property. Doing so will list the custom fields created as table columns.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
These hidden properties are used only in specific use cases.
string
""
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
The maximum number of results to return per page from Bugzilla.
int
-1
The Pagesize property affects the maximum number of results to return per page from Bugzilla. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The maximum number of rows to scan to look for the columns available in a table.
int
40
The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the connector throws an exception.