CData Sync App は、GitHub データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
GitHub コネクタはCData Sync アプリケーションから使用可能で、GitHub からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、GitHub GraphQL API のエンティティをリレーショナルビューとしてモデル化します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
このセクションでは、GitHub Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、GitHub にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
The CData Sync App models entities in the GitHub API as views and stored procedures. These are defined in schema files, which are simple, text-based configuration files.
The Sync App exposes three kinds of schemas:
The Information schema contains tables that expose licensing information and high-level overviews of the projects and repositories associated with the authenticated account. There is only one Information schema.
See Information データモデル for the available entities.
The Sync App exposes a schema for each repository in the authenticated user or organization's account.
See Repository データモデル for the available entities.
The Sync App exposes a schema for each project in the authenticated user or organization's account.
See Project データモデル for the available entities.
Note: The Sync App does not read from classic projects, due their deprecation in the GitHub API.
In this schema, the Sync App models licensing information and high-level overviews of the organizations, projects, and repositories associated with the authenticated account as read-only views.
ビュー are read-only tables that expose GitHub entities like licenses, organizations, and organization teams, as well as high-level information about projects and repositories tied to the authenticated account.
ストアドプロシージャ are function-like interfaces to the data source. They are used to perform functions such as getting the currently authenticated user or retrieving and refreshing OAuth access tokens.
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Enterprises | A list of enterprises that the user belongs to. |
LicenseConditions | The conditions set by the specified license. |
LicenseLimitations | The limitations set by the specified license. |
LicensePermissions | The permissions set by the specified license. |
Licenses | Lists known open source licenses in GitHub. |
OrganizationMannequins | Lists information about the mannequins of the logged in user's organizations or the mannequins of the specified organization. |
OrganizationMembers | Lists information about the users of the logged in user's organizations or the teams of the specified organization. |
Organizations | Lists information about the organizations of the logged in user, the specified user, or the specified organization. |
OrganizationTeams | Lists information about the teams of the logged in user's organizations or the teams of the specified organization. |
Projects | Lists information about the projects of the logged in user, a specific user or a specific organization. |
Repositories | Lists information about a user's or organization's repositories. |
A list of enterprises that the user belongs to.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Information].[Enterprises] WHERE [Information].[Enterprises].[Slug] = 'test-enterprise'
SELECT * FROM [Information].[Enterprises] WHERE [Information].[Enterprises].[MembershipType] = 'ADMIN'
SELECT * FROM [Information].[Enterprises] WHERE [Information].[Enterprises].[Login] = 'test'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the Enterprise object. | ||
UserId | String | The ID of the User object. | ||
Location | String | The location of the enterprise. | ||
Name | String | The name of the enterprise. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Announcement | String | The text of the announcement. | ||
AnnouncementExpiresAt | Datetime | The expiration date of the announcement, if any. | ||
AnnouncementUserDismissible | Bool | Whether the announcement can be dismissed by the user. | ||
BillingEmail | String | The enterprise's billing email. | ||
BillingInfoAllLicensableUsersCount | Int | The number of licenseable users/emails across the enterprise. | ||
BillingInfoAssetPacks | Int | The number of data packs used by all organizations owned by the enterprise. | ||
BillingInfoBandwidthQuota | Double | The bandwidth quota in GB for all organizations owned by the enterprise. | ||
BillingInfoBandwidthUsage | Double | The bandwidth usage in GB for all organizations owned by the enterprise. | ||
BillingInfoBandwidthUsagePercentage | Int | The bandwidth usage as a percentage of the bandwidth quota. | ||
BillingInfoStorageQuota | Double | The storage quota in GB for all organizations owned by the enterprise. | ||
BillingInfoStorageUsage | Double | The storage usage in GB for all organizations owned by the enterprise. | ||
BillingInfoStorageUsagePercentage | Int | The storage usage as a percentage of the storage quota. | ||
BillingInfoTotalAvailableLicenses | Int | The number of available licenses across all owned organizations based on the unique number of billable users. | ||
BillingInfoTotalLicenses | Int | The total number of licenses allocated. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
Description | String | The description of the enterprise. | ||
DescriptionHTML | String | The description of the enterprise as HTML. | ||
OwnerInfoOidcProviderId | String | The ID of the OIDCProvider object. | ||
OwnerInfoOidcProviderTenantId | String | The ID of the tenant this provider is attached to. | ||
OwnerInfoSamlIdentityProviderId | String | The ID of the EnterpriseIdentityProvider object. | ||
ResourcePath | String | The HTTP path for this enterprise. | ||
Slug | String | The URL-friendly identifier for the enterprise. | ||
Url | String | The HTTP URL for this enterprise. | ||
ViewerIsAdmin | Bool | Is the current viewer an admin of this enterprise? | ||
WebsiteUrl | String | The URL of the enterprise website. | ||
MembershipType | String | Filter enterprises returned based on the user's membership type. | ||
Login | String | The user's login. |
The conditions set by the specified license.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Information].[LicenseConditions] WHERE [Information].[LicenseConditions].[LicenseKey] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Key [KEY] | String | The machine-readable condition key. | ||
LicenseKey [KEY] | String |
Licenses.Key | The lowercased SPDX ID of the license. | |
Description | String | A description of the condition. | ||
Label | String | The human-readable condition label. |
The limitations set by the specified license.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Information].[LicenseLimitations] WHERE [Information].[LicenseLimitations].[LicenseKey] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Key [KEY] | String | The machine-readable limitation key. | ||
LicenseKey [KEY] | String |
Licenses.Key | The lowercased SPDX ID of the license. | |
Description | String | A description of the limitation. | ||
Label | String | The human-readable limitation label. |
The permissions set by the specified license.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Information].[LicensePermissions] WHERE [Information].[LicensePermissions].[LicenseKey] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Key [KEY] | String | The machine-readable permission key. | ||
LicenseKey [KEY] | String |
Licenses.Key | The lowercased SPDX ID of the license. | |
Description | String | A description of the permission. | ||
Label | String | The human-readable permission label. |
Lists known open source licenses in GitHub.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Information].[Licenses] WHERE [Information].[Licenses].[Key] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the license. | ||
Key | String | The lowercased SPDX ID of the license. | ||
SpdxId | String | Short identifier specified by https://spdx.org/licenses. | ||
Name | String | The license full name specified by https://spdx.org/licenses. | ||
Nickname | String | Customary short name if applicable (e.g, GPLv3). | ||
Body | String | The full text of the license. | ||
Description | String | A human-readable description of the license. | ||
Featured | Bool | Whether the license should be featured. | ||
Implementation | String | Instructions on how to implement the license. | ||
Url | String | URL to the license on https://choosealicense.com. | ||
PseudoLicense | Bool | Whether the license is a pseudo-license placeholder (e.g., other, no-license). | ||
Hidden | Bool | Whether the license should be displayed in license pickers. |
Lists information about the mannequins of the logged in user's organizations or the mannequins of the specified organization.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Information].[OrganizationMannequins] WHERE [Information].[OrganizationMannequins].[OrganizationLogin] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID for this mannequin. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
OrganizationLogin | String |
Organizations.Login | The organization's login. | |
Login | String | True | The username of the actor. | |
String | The mannequin's email on the source instance. | |||
Url | String | The URL to this resource. | ||
ResourcePath | String | The HTML path to this resource. | ||
CreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
ClaimantId | String | The ID of the claimant. | ||
ClaimantLogin | String | The username used to login. |
Lists information about the users of the logged in user's organizations or the teams of the specified organization.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Information].[OrganizationMembers] WHERE [Information].[OrganizationMembers].[OrganizationLogin] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Whether the current viewer can create new projects on this owner. | ||
ViewerCanChangePinnedItems | Bool | Whether the viewer can pin repositories and gists to the profile. | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. | ||
Role | String | The role of this user has in the organization. | ||
HasTwoFactorEnabled | Bool | Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer. | ||
OrganizationLogin [KEY] | String |
Organizations.Login | The organization's login name. |
Lists information about the organizations of the logged in user, the specified user, or the specified organization.
By default this view will only return information about the organizations of the logged in user.
Specific columns require the authenticated user to be an owner of the organization to retrieve data. These columns include WebCommitSignoffRequired, IpAllowListEnabledSetting, RequiresTwoFactorAuthentication, MembersCanForkPrivateRepositories, NotificationDeliveryRestrictionEnabledSetting and IpAllowListForInstalledAppsEnabledSetting.
Data access to third-parties is limited if an organization has enabled OAuth App access restrictions.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Information].[Organizations] WHERE [Information].[Organizations].[Login] = 'OrganizationLogin'
SELECT * FROM [Information].[Organizations] WHERE [Information].[Organizations].[MemberLogin] = 'UserLogin'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The id of the organization. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The organization's login name. | ||
Name | String | The organization's public profile name. | ||
TwitterUsername | String | The organization's Twitter username. | ||
Description | String | The organization's public profile description. | ||
DescriptionHTML | String | The organization's public profile description rendered to HTML. | ||
String | The organization's public email. | |||
OrganizationBillingEmail | String | The billing email for the organization. | ||
Location | String | The organization's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
WebCommitSignoffRequired | Bool | Whether contributors are required to sign off on web-based commits for repositories in this organization. | ||
MembersCanForkPrivateRepositories | Bool | Members can fork private repositories in this organization. | ||
IpAllowListEnabledSetting | String | The setting value for whether the organization has an IP allow list enabled. | ||
NotificationDeliveryRestrictionEnabledSetting | String | Indicates if email notification delivery for this organization is restricted to verified or approved domains. | ||
IpAllowListForInstalledAppsEnabledSetting | String | The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled. | ||
Announcement | String | The text of the announcement. | ||
AnnouncementUserDismissible | Bool | Whether the announcement can be dismissed by the user. | ||
AnnouncementExpiresAt | Datetime | The expiration date of the announcement, if any. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
ArchivedAt | Datetime | Identifies the date and time when the object was archived. | ||
ResourcePath | String | The HTTP path for this organization. | ||
ProjectsResourcePath | String | The HTTP path listing organization's projects. | ||
TeamsResourcePath | String | The HTTP path listing organization's teams. | ||
NewTeamResourcePath | String | The HTTP path creating a new team. | ||
Url | String | The HTTP URL for this organization. | ||
AvatarUrl | String | A URL pointing to the organization's public avatar. Arguments size (Int) The size of the resulting square image. | ||
ProjectsUrl | String | The HTTP URL listing organization's projects. | ||
WebsiteUrl | String | The organization's public profile URL. | ||
TeamsUrl | String | The HTTP URL listing organization's teams. | ||
NewTeamUrl | String | The HTTP URL creating a new team. | ||
IsVerified | Bool | Whether the organization has verified its profile email and website. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
ViewerCanAdminister | Bool | Organization is adminable by the viewer. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this Organization is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanCreateRepositories | Bool | Viewer can create repositories on this organization. | ||
ViewerCanCreateTeams | Bool | Viewer can create teams on this organization. | ||
ViewerIsAMember | Bool | Viewer is an active member of this organization. | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
RequiresTwoFactorAuthentication | Bool | When true the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication. | ||
SamlIdentityProviderId | String | The ID for the SAML Identity Provider. | ||
SamlIdentityProviderIssuer | String | The Issuer Entity ID for the SAML Identity Provider. | ||
SamlIdentityProviderDigestMethod | String | The digest algorithm used to sign SAML requests for the Identity Provider. | ||
SamlIdentityProviderIdpCertificate | String | The x509 certificate used by the Identity Provider to sign assertions and responses. | ||
SamlIdentityProviderSignatureMethod | String | The signature algorithm used to sign SAML requests for the Identity Provider. | ||
SamlIdentityProviderSsoUrl | String | The URL endpoint for the Identity Provider's SAML SSO. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
MemberLogin | String | Filter organizations based on having a specific member by that user's login. |
Lists information about the teams of the logged in user's organizations or the teams of the specified organization.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[OrganizationLogin] = 'EXAMPLE'
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[Privacy] = 'EXAMPLE'
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[Slug] = 'EXAMPLE'
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[NotificationSetting] = 'EXAMPLE'
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[LdapMapped] = 'true'
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[Role] = 'EXAMPLE'
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[RootTeamsOnly] = 'true'
SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[UserLogins] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the team. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
OrganizationId | String | The ID of the organization. | ||
OrganizationLogin | String |
Organizations.Login | The organization's login name. | |
Name | String | True | The name of the team. | |
Description | String | The description of the team. | ||
Privacy | String | The level of privacy the team has. | ||
Slug | String | The slug corresponding to the team. | ||
Url | String | The HTTP URL for this team. | ||
CombinedSlug | String | The slug corresponding to the organization and team. | ||
DiscussionsUrl | String | The HTTP URL for team discussions. | ||
MembersUrl | String | The HTTP URL for the team' members. | ||
NotificationSetting | String | The notification setting that the team has set. | ||
RepositoriesUrl | String | The HTTP URL for this team's repositories. | ||
ResourcePath | String | The HTTP path for this team. | ||
TeamsUrl | String | The HTTP URL for this team's teams. | ||
ViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
DiscussionsResourcePath | String | The HTTP path for team discussions. | ||
EditTeamUrl | String | The HTTP URL for editing this team. | ||
MembersResourcePath | String | The HTTP path for the team' members. | ||
NewTeamUrl | String | The HTTP URL creating a new team. | ||
RepositoriesResourcePath | String | The HTTP path for this team's repositories. | ||
TeamsResourcePath | String | The HTTP path for this team's teams. | ||
ViewerCanAdminister | Bool | Team is adminable by the viewer. | ||
ViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
EditTeamResourcePath | String | The HTTP path for editing this team. | ||
NewTeamResourcePath | String | The HTTP path creating a new team. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
LdapMapped | Bool | If true, filters teams that are mapped to an LDAP Group (Enterprise only). | ||
Role | String | If non-null, filters teams according to whether the viewer is an admin or member on team. | ||
RootTeamsOnly | Bool | If true, restrict to only root teams. | ||
UserLogins | String | User logins to filter by. |
Lists information about the projects of the logged in user, a specific user or a specific organization.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Information].[Projects] WHERE [Information].[Projects].[OwnerLogin] = 'EXAMPLE'
SELECT * FROM [Information].[Projects] WHERE [Information].[Projects].[Number] = '100'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The project ID. | ||
OwnerLogin | String | The login of the owner of the project. | ||
Number | Int | True | The project's number. | |
DatabaseId | Int | Identifies the primary key from the database. | ||
Title | String | True | The project's name. | |
ShortDescription | String | The project's short description. | ||
Readme | String | The project's readme. | ||
Creator | String | The actor's login name who originally created the project. | ||
Public | Bool | Returns true if the project is public. | ||
Template | Bool | Returns true if this project is a template. | ||
Closed | Bool | Returns true if the project is closed. | ||
ViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
ViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ResourcePath | String | The HTTP path for this project. | ||
Url | String | The HTTP URL for this project. | ||
UpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
ClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
CreatedAt | Datetime | True | Identifies the date and time when the object was created. |
Lists information about a user's or organization's repositories.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[Name] = 'EXAMPLE'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[OwnerLogin] = 'EXAMPLE'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[DiskUsage] = '100'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[ForkCount] = '100'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[StargazerCount] = '100'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[TopicCount] = '100'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsArchived] = 'true'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsFork] = 'true'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsMirror] = 'true'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsPrivate] = 'true'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[LicenseKey] = 'EXAMPLE'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[LanguageName] = 'EXAMPLE'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[PushedAt] = '2000-01-01 01:00:00.0'
SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[CreatedAt] = '2000-01-01 01:00:00.0'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the repository. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Name | String | The name of the repository. | ||
NameWithOwner | String | The repository's name with owner. | ||
OwnerId | String | The repository's owner ID. | ||
OwnerLogin | String | The login field of a user or organization. | ||
Visibility | String | Indicates the repository's visibility level. | ||
DiskUsage | Int | The number of kilobytes this repository occupies on disk. | ||
ForkCount | Int | Returns how many forks there are of this repository in the whole network. | ||
StargazerCount | Int | Returns a count of how many stargazers there are on this object. | ||
WatcherCount | Int | The number of watchers in a repository. | ||
TopicCount | Int | The number of topics that have been applied to the repository. | ||
TempCloneToken | String | Temporary authentication token for cloning this repository. | ||
WebCommitSignoffRequired | Bool | Whether contributors are required to sign off on web-based commits in this repository. | ||
UsesCustomOpenGraphImage | Bool | Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. | ||
Description | String | The description of the repository. | ||
DescriptionHTML | String | The description of the repository rendered to HTML. | ||
ShortDescriptionHTML | String | A description of the repository, rendered to HTML without any links in it. | ||
ResourcePath | String | The HTTP path for this repository. | ||
ProjectsResourcePath | String | The HTTP path listing the repository's projects. | ||
Url | String | The HTTP URL for this repository. | ||
HomepageUrl | String | The repository's URL. | ||
MirrorUrl | String | The repository's original mirror URL. | ||
ProjectsUrl | String | The HTTP URL listing the repository's projects. | ||
SecurityPolicyUrl | String | The security policy URL. | ||
SSHUrl | String | The SSH URL to clone this repository. | ||
OpenGraphImageUrl | String | The image used to represent this repository in Open Graph data. | ||
MergeCommitTitle | String | How the default commit title will be generated when merging a pull request. | ||
MergeCommitMessage | String | How the default commit message will be generated when merging a pull request. | ||
SquashMergeCommitTitle | String | How the default commit title will be generated when squash merging a pull request. | ||
SquashMergeCommitMessage | String | How the default commit message will be generated when squash merging a pull request. | ||
DeleteBranchOnMerge | Bool | Whether or not branches are automatically deleted when merged in this repository. | ||
HasDiscussionsEnabled | Bool | Indicates if the repository has the Discussions feature enabled. | ||
HasIssuesEnabled | Bool | Indicates if the repository has issues feature enabled. | ||
HasProjectsEnabled | Bool | Indicates if the repository has the Projects feature enabled. | ||
HasWikiEnabled | Bool | Indicates if the repository has wiki feature enabled. | ||
HasVulnerabilityAlertsEnabled | Bool | Whether vulnerability alerts are enabled for the repository. | ||
HasSponsorshipsEnabled | Bool | Indicates if the repository displays a Sponsor button for financial contributions. | ||
IsInOrganization | Bool | Indicates if a repository is either owned by an organization, or is a private fork of an organization repository. | ||
IsBlankIssuesEnabled | Bool | Returns true if blank issue creation is allowed. | ||
IsSecurityPolicyEnabled | Bool | Returns true if this repository has a security policy. | ||
IsUserConfigurationRepository | Bool | Is this repository a user configuration repository? | ||
IsArchived | Bool | Indicates if the repository is unmaintained. | ||
IsDisabled | Bool | Returns whether or not this repository disabled. | ||
IsEmpty | Bool | Returns whether or not this repository is empty. | ||
IsFork | Bool | Identifies if the repository is a fork. | ||
IsLocked | Bool | Indicates if the repository has been locked or not. | ||
IsMirror | Bool | Identifies if the repository is a mirror. | ||
IsPrivate | Bool | Identifies if the repository is private. | ||
IsTemplate | Bool | Identifies if the repository is a template that can be used to generate new repositories. | ||
LockReason | String | The reason the repository has been locked. | ||
TemplateRepositoryId | String | The ID of the repository from which this repository was generated, if any. | ||
ParentId | String | The repository parent ID, if this is a fork. | ||
ForkingAllowed | Bool | Whether this repository allows forks. | ||
AutoMergeAllowed | Bool | Whether or not Auto-merge can be enabled on pull requests in this repository. | ||
SquashMergeAllowed | Bool | Whether or not squash-merging is enabled on this repository. | ||
RebaseMergeAllowed | Bool | Whether or not rebase-merging is enabled on this repository. | ||
MergeCommitAllowed | Bool | Whether or not PRs are merged with a merge commit on this repository. | ||
AllowUpdateBranch | Bool | Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. | ||
ViewerPermission | String | The users permission level on the repository. Will return null if authenticated as an GitHub App. | ||
ViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
ViewerHasStarred | Bool | Returns a boolean indicating whether the viewing user has starred this starrable. | ||
ViewerDefaultCommitEmail | String | The last commit email for the viewer. | ||
ViewerDefaultMergeMethod | String | The last used merge method by the viewer or the default for the repository. | ||
ViewerPossibleCommitEmails | String | A list of emails this viewer can commit with. | ||
ViewerCanAdminister | Bool | Indicates whether the viewer has admin permissions on this repository. | ||
ViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanUpdateTopics | Bool | Indicates whether the viewer can update the topics of this repository. | ||
CodeOfConductId | String | The ID of the Code of Conduct. | ||
CodeOfConductName | String | The formal name of the Code of Conduct. | ||
CodeOfConductBody | String | The body of the Code of Conduct. | ||
CodeOfConductKey | String | The key for the Code of Conduct. | ||
CodeOfConductUrl | String | The HTTP URL for this Code of Conduct. | ||
CodeOfConductResourcePath | String | The HTTP path for this Code of Conduct. | ||
DefaultBranchRefId | String | The ref id. | ||
DefaultBranchRefName | String | The ref name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
LatestReleaseId | String | The ID of the release. | ||
LatestReleaseName | String | The title of the release. | ||
LicenseId | String | The ID of the license associated with the repository. | ||
LicenseKey | String |
Licenses.Key | The key of the license associated with the repository. | |
LanguageId | String | The ID of the current primary language. | ||
LanguageName | String | The name defined for the current language. | ||
LanguageColor | String | The color defined for the current language. | ||
PushedAt | Datetime | Identifies when the repository was last pushed to. | ||
ArchivedAt | Datetime | Identifies the date and time when the repository was archived. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. |
The Sync App models each repository associated with the authenticated account as a schema.
ビュー are read-only tables that expose GitHub entities like pull requests, issues, and commits.
ストアドプロシージャ are function-like interfaces to the data source. They are used to perform functions such as retrieving and refreshing OAuth access tokens.
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AssignableUsers | Lists information about the users that can be assigned to issues in this repository. |
Branches | Lists information about branches in a repository. |
Collaborators | A list of collaborators associated with the repository. |
CommitComments | Lists information about comments which were made on a specific commit. |
Commits | Lists information about commits done in a repository . |
Forks | Lists information about forks of a repository. |
IssueAssignees | Lists information about the users assigned to the repository's issues. |
IssueComments | Lists information about comments which were made on a specific issue. |
Issues | Lists all project issues. |
Labels | Lists information about the different labels you can apply on an issue. |
MentionableUsers | Lists information about the users that can be mentioned in the context of the repository. |
MergeQueueEntries | Lists information about the different entries on an merge queue. |
MergeQueues | Lists information about the different labels you can apply on an issue. |
Milestones | Lists information about milestones in a repository. |
PullRequestComments | Lists information about comments which were made on a specific pull request. |
PullRequestReviewComments | Lists information about comments which were made on a pull request review. |
PullRequestReviews | Lists information about pull request reviews in a repository. |
PullRequests | Lists information about pull requests in a repository. |
ReleaseAssets | List of releases assets which are dependent on a release. |
Releases | Lists information about the different releases of a repository. |
Stargazers | Lists information about the users who have starred this repository. |
Topics | A list of applied repository-topic associations for this repository. |
Watchers | A list of users watching the repository. |
Lists information about the users that can be assigned to issues in this repository.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. |
Lists information about branches in a repository.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the branch. | ||
Name | String | The branch name. | ||
Prefix | String | The branch prefix. |
A list of collaborators associated with the repository.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner. | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile?. | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. | ||
RepositoryId | String | The ID of the Repository object. |
Lists information about comments which were made on a specific commit.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The unique identifier. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Body | String | The body as Markdown. | ||
BodyText | String | The body rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
Author | String | The username of the actor who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The username of the actor who edited the comment. | ||
IsMinimized | Bool | Returns whether or not a comment has been minimized. | ||
MinimizedReason | String | Returns why the comment was minimized. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
ResourcePath | String | The HTTP path for this comment. | ||
Url | String | The HTTP URL for this comment. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
ViewerCanDelete | Bool | Check if the current viewer can delete this object. | ||
ViewerCanMinimize | Bool | Check if the current viewer can minimize this object. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
ReactionGroups | String | A list of reactions grouped by content left on the subject. | ||
ViewerId | String | The viewer ID. | ||
CommitId | String |
Commits.Id | Identifies the commit associated with the comment, if the commit exists. | |
Path | String | Identifies the file path associated with the comment. | ||
Position | Int | Identifies the line position associated with the comment. |
Lists information about commits done in a repository .
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Repository].[Commits] WHERE [Repository].[Commits].[BranchName] = 'EXAMPLE'
SELECT * FROM [Repository].[Commits] WHERE [Repository].[Commits].[CommittedDate] >= '2017-12-18 09:02:22.0' AND [Repository].[Commits].[CommittedDate] <= '2018-01-11 15:00:08.0'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the commit. | ||
Oid | String | The Git object ID. | ||
AbbreviatedOid | String | An abbreviated version of the Git object ID. | ||
BranchName [KEY] | String |
Branches.Name | The name of the branch. | |
ChangedFilesIfAvailable | Int | The number of changed files in this commit. If GitHub is unable to calculate the number of changed files (for example due to a timeout), this will return 'null'. We recommend using this field instead of 'changedFiles'. | ||
Additions | Int | The number of additions in this commit. | ||
Deletions | Int | The number of deletions in this commit. | ||
AuthoredByCommitter | Bool | Check if the committer and the author match. | ||
CommittedViaWeb | Bool | Check if committed via GitHub web UI. | ||
AuthoredDate | Datetime | The datetime when this commit was authored. | ||
CommittedDate | Datetime | The datetime when this commit was committed. | ||
ViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
ViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
Message | String | The Git commit message. | ||
MessageBody | String | The Git commit message body. | ||
MessageHeadline | String | The Git commit message headline. | ||
MessageBodyHTML | String | The commit message body rendered to HTML. | ||
MessageHeadlineHTML | String | The commit message headline rendered to HTML. | ||
ResourcePath | String | The HTTP path for this commit. | ||
CommitResourcePath | String | The HTTP path for this Git object. | ||
TreeResourcePath | String | The HTTP path for the tree of this commit. | ||
Url | String | The HTTP URL for this commit. | ||
CommitUrl | String | The HTTP URL for this Git object. | ||
TarballUrl | String | Returns a URL to download a tarball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes. | ||
TreeUrl | String | The HTTP URL for the tree of this commit. | ||
ZipballUrl | String | Returns a URL to download a zipball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes. | ||
AuthorName | String | The name in the Git commit. | ||
AuthorEmail | String | The email of the commit author. | ||
AuthorDate | Datetime | The timestamp of the Git action (authoring or committing). | ||
AuthorUserLogin | String | The GitHub user corresponding to the email field. Null if no such user exists. | ||
CommitterName | String | The name in the Git commit. | ||
CommitterEmail | String | The email of the committer. | ||
CommitterDate | Datetime | The timestamp of the Git action (authoring or committing). | ||
CommitterUserLogin | String | The GitHub user corresponding to the email field. Null if no such user exists. | ||
OnBehalfOfId | String | The organization's ID this commit was made on behalf of. | ||
OnBehalfOf | String | The organization's login name this commit was made on behalf of. | ||
SignatureIsValid | Bool | True if the signature is valid and verified by GitHub. | ||
Signature | String | ASCII-armored signature header from object. | ||
SignatureEmail | String | Email used to sign this object. | ||
SignaturePayload | String | Payload for GPG signing object. Raw ODB object without the signature header. | ||
SignatureState | String | The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid. | ||
SignatureSigner | String | GitHub user's login name corresponding to the email signing this commit. | ||
WasSignedByGitHub | Bool | True if the signature was made with GitHub's signing key. | ||
StatusId | String | The commit status ID. | ||
StatusState | String | The combined commit status. | ||
StatusCheckRollupId | String | The Check and Status rollup ID. | ||
StatusCheckRollupState | String | Check and Status rollup combined status state for this commit. | ||
TreeId | String | The commit's root Tree ID. | ||
TreeOid | String | The Git object ID. | ||
TreeAbbreviatedOid | String | An abbreviated version of the Git object ID. | ||
TreeCommitUrl | String | The HTTP URL for this Git object. | ||
TreeCommitResourcePath | String | The HTTP path for this Git object. |
Lists information about forks of a repository.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[IsLocked] = 'true'
SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[HasIssuesEnabled] = 'false'
SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[Visibility] = 'PUBLIC'
SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[IsPrivate] = 'false'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The fork ID. | ||
ForkOwnerLogin | String | The login name that owns the fork. | ||
Name | String | True | The name of the fork. | |
Description | String | The fork description. | ||
DescriptionHTML | String | The fork HTML description. | ||
HasIssuesEnabled | Bool | Indicates if the fork has issues feature enabled. | ||
IsLocked | Bool | Whether the fork is locked. | ||
IsPrivate | Bool | Identifies if the fork is private. | ||
Visibility | String | Indicates the fork's visibility level. | ||
ForkCount | Int | Returns how many forks there are of this fork in the whole network. | ||
StargazerCount | Int | True | Returns a count of how many stargazers there are on this object. | |
ForkingAllowed | Bool | Whether this fork allows forks. | ||
Url | String | The HTTP URL for this fork. | ||
MirrorUrl | String | The mirror URL of the fork. | ||
CreatedAt | Datetime | True | The creation date of the fork. | |
UpdatedAt | Datetime | True | The date when the fork was last updated. | |
PushedAt | Datetime | True | The date the fork was last pushed to. |
Lists information about the users assigned to the repository's issues.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[IssueAssignees] WHERE [Repository].[IssueAssignees].[IssueNumber] = '100'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. | ||
IssueNumber [KEY] | Int |
Issues.Number | Identifies the issue number associated with the assignee. |
Lists information about comments which were made on a specific issue.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[IssueComments] WHERE [Repository].[IssueComments].[IssueNumber] = '100'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The unique identifier. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Body | String | The body as Markdown. | ||
BodyText | String | The body rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
Author | String | The username of the actor who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The username of the actor who edited the comment. | ||
IsMinimized | Bool | Returns whether or not a comment has been minimized. | ||
MinimizedReason | String | Returns why the comment was minimized. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
ResourcePath | String | The HTTP path for this comment. | ||
Url | String | The HTTP URL for this comment. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
ViewerCanDelete | Bool | Check if the current viewer can delete this object. | ||
ViewerCanMinimize | Bool | Check if the current viewer can minimize this object. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
ReactionGroups | String | A list of reactions grouped by content left on the subject. | ||
ViewerId | String | The viewer ID. | ||
IssueNumber | Int |
Issues.Number | Identifies the issue number associated with the comment. | |
IssueId | String | Identifies the issue ID associated with the comment. | ||
PullRequestId | String | Returns the ID of the pull request associated with the comment, if this comment was made on a pull request. | ||
FullDatabaseId | Long | Identifies the primary key from the database as a BigInt. |
Lists all project issues.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[Author] = 'EXAMPLE'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[State] = 'EXAMPLE'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[ClosedAt] = '2018-05-10 11:11:38.0'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[UpdatedAt] = '2018-05-10 11:11:38.0'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[CreatedAt] = '2018-05-10 11:11:38.0'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[CommentCount] = '100'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[ReactionCount] = '100'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[Mentions] = 'User'
SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[Assignee] = 'User'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The Issue ID. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
FullDatabaseId | Long | Identifies the primary key from the database as a BigInt. | ||
Title | String | Identifies the issue title. | ||
TitleHTML | String | Identifies the issue title rendered to HTML. | ||
Author | String | The username of the actor who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The username of the actor who edited the comment. | ||
Body | String | Identifies the body of the issue. | ||
BodyText | String | Identifies the body of the issue rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
BodyResourcePath | String | The http path for this issue body. | ||
BodyUrl | String | The http URL for this issue body. | ||
Number | Int | Identifies the issue number. | ||
State | String | Identifies the state of the issue. | ||
StateReason | String | Identifies the reason for the issue state. | ||
Locked | Bool | True if the object is locked. | ||
ActiveLockReason | String | Reason that the conversation was locked. | ||
Closed | Bool | True if the object is closed (definition of closed may depend on type). | ||
IsPinned | Bool | Indicates whether or not this issue is currently pinned to the repository issues list. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
ResourcePath | String | The HTTP path for this issue. | ||
Url | String | The HTTP URL for this issue. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
ClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
UpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
CreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
MilestoneId | String |
Milestones.Id | Identifies the milestone associated with the issue. | |
MilestoneTitle | String | Identifies the title of the milestone. | ||
MilestoneNumber | Int | Identifies the number of the milestone. | ||
IsReadByViewer | Bool | Is this issue read by the viewer. | ||
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
ViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
ViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
ViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
ViewerCanDelete | Bool | Check if the current viewer can delete this object. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
ViewerThreadSubscriptionStatus | String | Identifies the viewer's thread subscription status. | ||
ViewerThreadSubscriptionFormAction | String | Identifies the viewer's thread subscription form action. | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
CommentCount | Int | The number of comments on the issue. | ||
ReactionCount | Int | The number of reactions on the issue. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Mentions | String | You can find issues that mention a certain user. | |
Assignee | String | You can find find issues and pull requests that are assigned to a certain user. |
Lists information about the different labels you can apply on an issue.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[Labels] WHERE [Repository].[Labels].[Name] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the label. | ||
Name | String | True | Identifies the label name. | |
Description | String | A brief description of this label. | ||
Color | String | Identifies the label color. | ||
IsDefault | Bool | Indicates whether or not this is a default label. | ||
ResourcePath | String | The HTTP path for this label. | ||
Url | String | The HTTP URL for this label. | ||
UpdatedAt | Datetime | Identifies the date and time when the label was last updated. | ||
CreatedAt | Datetime | True | Identifies the date and time when the label was created. |
Lists information about the users that can be mentioned in the context of the repository.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. |
Lists information about the different entries on an merge queue.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the MergeQueueEntry object. | ||
RepositoryId | String | The ID of the Repository object. | ||
RepositoryMergeQueueId | String | The ID of the MergeQueue object. | ||
BaseCommitId | String | The ID of the base commit. | ||
EnqueuedAt | Datetime | The date and time this entry was added to the merge queue. | ||
EstimatedTimeToMerge | Int | The estimated time in seconds until this entry will be merged. | ||
HeadCommitId | String | The ID of the head commit. | ||
Jump | Bool | Whether this pull request should jump the queue. | ||
Position | Int | The position of this entry in the queue. | ||
PullRequestId | String | The ID of the PullRequest object. | ||
Solo | Bool | Does this pull request need to be deployed on its own? | ||
State | String | The state of this entry in the queue. |
Lists information about the different labels you can apply on an issue.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Repository].[MergeQueues] WHERE [Repository].[MergeQueues].[Branch] = 'test'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the MergeQueueEntry object. | ||
ResourcePath | String | The HTTP path for the merge queue. | ||
Branch | String | The name of the branch to get the merge queue for. | ||
Url | String | The HTTP URL for the merge queue. | ||
RepositoryId | String | The ID of the repository. | ||
NextEntryEstimatedTimeToMerge | Int | The estimated time in seconds until a newly added entry would be merged. |
Lists information about milestones in a repository.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[Milestones] WHERE [Repository].[Milestones].[Number] = '100'
SELECT * FROM [Repository].[Milestones] WHERE [Repository].[Milestones].[State] = 'all'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the milestone. | ||
Title | String | Identifies the title of the milestone. | ||
Closed | Bool | True if the object is closed (definition of closed may depend on type). | ||
ProgressPercentage | Double | Progress Percentage for this milestone. | ||
Description | String | Identifies the description of the milestone. | ||
Number | Int | True | Identifies the number of the milestone. | |
State | String | Identifies the state of the milestone. | ||
ResourcePath | String | The HTTP path for this milestone. | ||
Url | String | The HTTP URL for this milestone. | ||
ViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
ViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
DueOn | Datetime | True | Identifies the due date of the milestone. | |
ClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
UpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
CreatedAt | Datetime | True | Identifies the date and time when the object was created. |
Lists information about comments which were made on a specific pull request.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Repository].[PullRequestComments] WHERE [Repository].[PullRequestComments].[PullRequestId] = 'PR_kwDO00RTuc5l2kMj'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The unique identifier. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Body | String | The body as Markdown. | ||
BodyText | String | The body rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
Author | String | The username of the actor who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The username of the actor who edited the comment. | ||
IsMinimized | Bool | Returns whether or not a comment has been minimized. | ||
MinimizedReason | String | Returns why the comment was minimized. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
ResourcePath | String | The HTTP path for this comment. | ||
Url | String | The HTTP URL for this comment. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
ViewerCanDelete | Bool | Check if the current viewer can delete this object. | ||
ViewerCanMinimize | Bool | Check if the current viewer can minimize this object. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
IssueId | String | Identifies the issue ID associated with the comment. | ||
PullRequestId | String | Returns the ID of the pull request associated with the comment, if this comment was made on a pull request. | ||
FullDatabaseId | Long | Identifies the primary key from the database as a BigInt. |
Lists information about comments which were made on a pull request review.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Repository].[PullRequestReviewComments] WHERE [Repository].[PullRequestReviewComments].[PullRequestReviewId] = 'PRR_kwDO000Tuc5yOHvY'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The unique identifier. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Body | String | The body as Markdown. | ||
BodyText | String | The body rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
Author | String | The username of the actor who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The username of the actor who edited the comment. | ||
IsMinimized | Bool | Returns whether or not a comment has been minimized. | ||
MinimizedReason | String | Returns why the comment was minimized. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
ResourcePath | String | The HTTP path for this comment. | ||
Url | String | The HTTP URL for this comment. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
ViewerCanDelete | Bool | Check if the current viewer can delete this object. | ||
ViewerCanMinimize | Bool | Check if the current viewer can minimize this object. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
PullRequestId | String | Returns the ID of the pull request associated with the comment, if this comment was made on a pull request. | ||
PullRequestReviewId | String | Identifies the pull request number associated with this pull request review. | ||
FullDatabaseId | Long | Identifies the primary key from the database as a BigInt. |
Lists information about pull request reviews in a repository.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Repository].[PullRequestReviews] WHERE [Repository].[PullRequestReviews].[PullRequestNumber] = '100'
SELECT * FROM [Repository].[PullRequestReviews] WHERE [Repository].[PullRequestReviews].[State] = 'PENDING'
SELECT * FROM [Repository].[PullRequestReviews] WHERE [Repository].[PullRequestReviews].[Author] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The unique identifier. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Body | String | The body as Markdown. | ||
BodyText | String | The body rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
Author | String | The actor's username login who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The username of the actor who edited the comment. | ||
IsMinimized | Bool | Returns whether or not a comment has been minimized. | ||
MinimizedReason | String | Returns why the comment was minimized. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
ResourcePath | String | The HTTP path for this comment. | ||
Url | String | The HTTP URL for this comment. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
ViewerCanDelete | Bool | Check if the current viewer can delete this object. | ||
ViewerCanMinimize | Bool | Check if the current viewer can minimize this object. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
ReactionGroups | String | A list of reactions grouped by content left on the subject. | ||
ViewerId | String | The viewer ID. | ||
PullRequestId | String |
PullRequests.Id | Identifies the pull request ID associated with this pull request review. | |
PullRequestNumber | Int | Identifies the pull request number associated with this pull request review. | ||
CommitId | String | Identifies the commit associated with this pull request review. | ||
SubmittedAt | Datetime | Identifies when the Pull Request Review was submitted. | ||
State | String | Identifies the current state of the pull request review. | ||
AuthorCanPushToRepository | Bool | Indicates whether the author of this review has push access to the repository. | ||
FullDatabaseId | Long | Identifies the primary key from the database as a BigInt. |
Lists information about pull requests in a repository.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[PullRequests] WHERE [Repository].[PullRequests].[BaseRefName] = 'newbranch'
SELECT * FROM [Repository].[PullRequests] WHERE [Repository].[PullRequests].[HeadRefName] = 'master'
SELECT * FROM [Repository].[PullRequests] WHERE [Repository].[PullRequests].[State] = 'OPEN'
SELECT * FROM [Repository].[PullRequests] WHERE [Repository].[PullRequests].[Number] = '100'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the pull request. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
FullDatabaseId | Long | Identifies the primary key from the database as a BigInt. | ||
Author | String | The actor's login name who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The actor's login name who edited this pull request's body. | ||
HeadRepositoryOwner | String | The owner's login name of the repository associated with this pull request's head Ref. | ||
MergedBy | String | The actor's login name who merged the pull request. | ||
BaseRefId | String | Identifies the ID of the base ref associated with the pull request, even if the ref has been deleted. | ||
BaseRefOid | String | Identifies the OID of the base ref associated with the pull request, even if the ref has been deleted. | ||
BaseRefPrefix | String | Identifies the prefix of the base Ref associated with the pull request. | ||
BaseRefName | String | Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. | ||
HeadRefId | String | Identifies the ID of the head ref associated with the pull request, even if the ref has been deleted. | ||
HeadRefOid | String | Identifies the OID of the head ref associated with the pull request, even if the ref has been deleted. | ||
HeadRefPrefix | String | Identifies the prefix of the head Ref associated with the pull request. | ||
HeadRefName | String | Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. | ||
Title | String | Identifies the pull request title. | ||
TitleHTML | String | Identifies the pull request title rendered to HTML. | ||
Body | String | The body as Markdown. | ||
BodyText | String | The body rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
State | String | Identifies the state of the pull request. | ||
Number | Int | Identifies the pull request number. | ||
Mergeable | String | Whether or not the pull request can be merged based on the existence of merge conflicts. | ||
Merged | Bool | Whether or not the pull request was merged. | ||
Closed | Bool | true if the pull request is closed. | ||
ChangedFiles | Int | The number of changed files in this pull request. | ||
Additions | Int | The number of additions in this pull request. | ||
Deletions | Int | The number of deletions in this pull request. | ||
TotalCommentsCount | Int | Returns a count of how many comments this pull request has received. | ||
ReviewDecision | String | The current status of this pull request with respect to code review. | ||
Locked | Bool | true if the pull request is locked. | ||
ActiveLockReason | String | Reason that the conversation was locked. | ||
IsDraft | Bool | Identifies if the pull request is a draft. | ||
IsCrossRepository | Bool | The head and base repositories are different. | ||
MaintainerCanModify | Bool | Indicates whether maintainers can modify the pull request. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
MergeCommitId | String | The commit ID that was created when this pull request was merged. | ||
PotentialMergeCommitId | String | The commit ID that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request. | ||
Permalink | String | The permalink to the pull request. | ||
ResourcePath | String | The HTTP path for this pull request. | ||
ChecksResourcePath | String | The HTTP path for the checks of this pull request. | ||
RevertResourcePath | String | The HTTP path for reverting this pull request. | ||
Url | String | The HTTP URL for this pull request. | ||
ChecksUrl | String | The HTTP URL for the checks of this pull request. | ||
RevertUrl | String | The HTTP URL for reverting this pull request. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
MergedAt | Datetime | The date and time that the pull request was merged. | ||
ClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
UpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
CreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
MilestoneId | String | Identifies the milestone's ID associated with the pull request. | ||
MilestoneTitle | String | Identifies the title of the milestone. | ||
MilestoneNumber | Int | Identifies the number of the milestone. | ||
AutoMergeRequestCommitHeadline | String | The commit title of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
AutoMergeRequestAuthorEmail | String | The email address of the author of this auto-merge request. | ||
AutoMergeRequestCommitBody | String | The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
AutoMergeRequestEnabledAt | Datetime | When was this auto-merge request was enabled. | ||
AutoMergeRequestMergeMethod | String | The merge method of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
IsReadByViewer | Bool | Is this pull request read by the viewer? | ||
ViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
ViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
ViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
ViewerCanApplySuggestion | Bool | Whether or not the viewer can apply suggestion. | ||
ViewerCanEditFiles | Bool | Can the viewer edit files within this pull request? | ||
ViewerCanDeleteHeadRef | Bool | Check if the viewer can restore the deleted head ref. | ||
ViewerCanDisableAutoMerge | Bool | Whether or not the viewer can disable auto-merge. | ||
ViewerCanEnableAutoMerge | Bool | Whether or not the viewer can enable auto-merge. | ||
ViewerCanMergeAsAdmin | Bool | Indicates whether the viewer can bypass branch protections and merge the pull request immediately. | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCanUpdateBranch | Bool | Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref. If the head ref is up to date or unable to be updated by this user, this will return false. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
ViewerLatestReviewRequestId | String | The ID of the viewer's latest review request. | ||
ViewerLatestReviewId | String | The ID of the viewer's latest review. | ||
IsMergeQueueEnabled | Bool | Indicates whether the pull request's base ref has a merge queue enabled. | ||
IsInMergeQueue | Bool | Indicates whether the pull request is in a merge queue. | ||
MergeQueueEntryId | String | The ID of this entry in the queue. | ||
MergeQueueEntryJump | Bool | Whether this pull request should jump the queue. | ||
MergeQueueEntryPosition | Int | The position of this entry in the queue. | ||
MergeQueueEntrySolo | Bool | Does this pull request need to be deployed on its own? | ||
MergeQueueEntryState | String | The state of this entry in the queue. | ||
MergeQueueEntryEnqueuedAt | Datetime | The date and time this entry was added to the merge queue. | ||
MergeQueueEntryEstimatedTimeToMerge | Int | The estimated time in seconds until this entry will be merged. | ||
MergeQueueEntryBaseCommitId | String | The ID of the base commit in the queue entry. | ||
MergeQueueEntryHeadCommitId | String | The ID of the head commit in the queue entry. | ||
MergeQueueEntryMergeQueueId | String | The ID of the entry's queue. | ||
MergeQueueEntryMergeQueueUrl | String | The HTTP URL for this merge queue. | ||
MergeQueueEntryMergeQueueResourcePath | String | The HTTP path for this merge queue. | ||
MergeQueueEntryMergeQueueNextEntryEstimatedTimeToMerge | Int | The estimated time in seconds until a newly added entry would be merged. |
List of releases assets which are dependent on a release.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Repository].[ReleaseAssets] WHERE [Repository].[ReleaseAssets].[ReleaseTagName] = 'EXAMPLE'
SELECT * FROM [Repository].[ReleaseAssets] WHERE [Repository].[ReleaseAssets].[Name] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the asset. | ||
ReleaseTagName | String |
Releases.TagName | The ID of the release that the asset is associated with. | |
Name | String | Identifies the title of the release asset. | ||
ContentType | String | The asset's content-type. | ||
Size | Int | The size (in bytes) of the asset. | ||
UploadedBy | String | The user login name that performed the upload. | ||
Url | String | Identifies the URL of the release asset. | ||
DownloadCount | Int | The number of times this asset was downloaded. | ||
DownloadUrl | String | Identifies the URL where you can download the release asset via the browser. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. |
Lists information about the different releases of a repository.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Repository].[Releases] WHERE [Repository].[Releases].[TagName] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the release. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Name | String | True | The title of the release. | |
Description | String | The description of the release. | ||
ShortDescriptionHTML | String | A description of the release, rendered to HTML without any links in it. Arguments limit (Int) How many characters to return. The default value is 200. | ||
DescriptionHTML | String | The description of this release rendered to HTML. | ||
IsDraft | Bool | Whether or not the release is a draft. | ||
IsLatest | Bool | Whether or not the release is the latest release. | ||
IsPrerelease | Bool | Whether or not the release is a prerelease. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
AuthorId | String | The author's ID of the release. | ||
Author | String | The author's login name of the release. | ||
TagId | String | The ID of the release's Git tag. | ||
TagName | String | The name of the release's Git tag. | ||
TagCommitId | String | The ID of the release's Git tag commit. | ||
Url | String | The HTTP URL for this issue. | ||
ResourcePath | String | The HTTP path for this issue. | ||
CreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
PublishedAt | Datetime | Identifies the date and time when the release was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. |
Lists information about the users who have starred this repository.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. |
A list of applied repository-topic associations for this repository.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The id of the topic. | ||
URL | String | The HTTP URL for this repository-topic. | ||
ResourcePath | String | The HTTP path for this repository-topic. | ||
Name | String | The topic's name. | ||
StargazerCount | Int | Returns a count of how many stargazers there are on this object. | ||
ViewerHasStarred | Bool | Returns a boolean indicating whether the viewing user has starred this starrable. |
A list of users watching the repository.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. |
The Sync App models each project associated with the authenticated account as a schema.
Note: The Sync App does not read from classic projects, due their deprecation in the GitHub API.
ビュー are read-only tables that expose GitHub entities like item information and custom views.
ストアドプロシージャ are function-like interfaces to the data source. They are used to perform functions such as getting the currently authenticated user or retrieving and refreshing OAuth access tokens.
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
CustomView | The Sync App dynamically models your custom project views as SQL views. This is a sample of one such custom view.
This view has a filter of 'label:bug', and is order by the following fields 'Labels' in the corresponding order 'ASC'. |
ItemAssignees | Lists information and values of the 'Assignees' field for the project items. |
ItemLabels | Lists information and values of the 'Labels' field for the project items. |
ItemLinkedpullrequests | Lists information and values of the 'Linked pull requests' field for the project items. |
ItemReviewers | Lists information and values of the 'Reviewers' field for the project items. |
Items | Lists items information within the project. |
ItemsView | This view has no filter and includes all project view fields. |
The Sync App dynamically models your custom project views as SQL views. This is a sample of one such custom view.
This view has a filter of 'label:bug', and is order by the following fields 'Labels' in the corresponding order 'ASC'.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
ItemId [KEY] | String | The ID of the item. | ||
Title | String | Text value of a field. | ||
Assignees | String | The username used to login. | ||
Status | String | The name of the selected single select option. | ||
Labels | String | Identifies the label name. | ||
Repository | String | The repository's name with owner. | ||
Milestone | String | Identifies the title of the milestone. | ||
Date | Date | Date value for the field. | ||
Iteration | String | The tile of the iteration. | ||
TextField | String | Text value of a field. |
Lists information and values of the 'Assignees' field for the project items.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM [Project].[ItemAssignees] WHERE [Project].[ItemAssignees].[ItemId] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
ItemId [KEY] | String | The ID of the item. | ||
Id [KEY] | String | The ID of the user. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
Login | String | The username used to login. | ||
Name | String | The user's public profile name. | ||
String | The user's publicly visible profile email. | |||
TwitterUsername | String | The user's Twitter username. | ||
Pronouns | String | The user's profile pronouns. | ||
Bio | String | The user's public profile bio. | ||
BioHTML | String | The user's public profile bio as HTML. | ||
Company | String | The user's public profile company. | ||
CompanyHTML | String | The user's public profile company as HTML. | ||
Location | String | The user's public profile location. | ||
AnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
PinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
ItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
IsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
IsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
IsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
IsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
IsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
IsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
IsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
IsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
IsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
IsViewer | Bool | Whether or not this user is the viewing user. | ||
ViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
ViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
ViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
ViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
StatusId | String | The emoji's id. | ||
StatusEmoji | String | An emoji summarizing the user's status. | ||
StatusMessage | String | A brief message describing what the user is doing. | ||
StatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
StatusEmojiHTML | String | The status emoji as HTML. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusOrganizationId | String | The organization's id. | ||
StatusOrganizationLogin | String | The organization's login name. | ||
InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
SponsorsListingId | String | The listing's id. | ||
SponsorsListingName | String | The listing's full name. | ||
TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
ResourcePath | String | The HTTP path for this user. | ||
ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
Url | String | The HTTP URL for this user. | ||
ProjectsUrl | String | The HTTP URL listing user's projects. | ||
WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
AvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
RepositoryCount | Int | The number of repositories that a user owns. | ||
FollowerCount | Int | The number of followers that a user has. |
Lists information and values of the 'Labels' field for the project items.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Project].[ItemLabels] WHERE [Project].[ItemLabels].[ItemId] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
ItemId [KEY] | String | The ID of the item. | ||
Id [KEY] | String | The ID of the label. | ||
Name | String | True | Identifies the label name. | |
Description | String | A brief description of this label. | ||
Color | String | Identifies the label color. | ||
IsDefault | Bool | Indicates whether or not this is a default label. | ||
ResourcePath | String | The HTTP path for this label. | ||
Url | String | The HTTP URL for this label. | ||
UpdatedAt | Datetime | Identifies the date and time when the label was last updated. | ||
CreatedAt | Datetime | True | Identifies the date and time when the label was created. |
Lists information and values of the 'Linked pull requests' field for the project items.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Project].[ItemLinked_pull_requests] WHERE [Project].[ItemLinked_pull_requests].[ItemId] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
ItemId [KEY] | String | The ID of the item. | ||
Id [KEY] | String | The ID of the pull request. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
FullDatabaseId | Long | Identifies the primary key from the database as a BigInt. | ||
Author | String | The actor's login name who authored the comment. | ||
AuthorAssociation | String | Author's association with the subject of the comment. | ||
Editor | String | The actor's login name who edited this pull request's body. | ||
HeadRepositoryOwner | String | The owner's login name of the repository associated with this pull request's head Ref. | ||
MergedBy | String | The actor's login name who merged the pull request. | ||
BaseRefId | String | Identifies the ID of the base ref associated with the pull request, even if the ref has been deleted. | ||
BaseRefOid | String | Identifies the OID of the base ref associated with the pull request, even if the ref has been deleted. | ||
BaseRefPrefix | String | Identifies the prefix of the base Ref associated with the pull request. | ||
BaseRefName | String | Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. | ||
HeadRefId | String | Identifies the ID of the head ref associated with the pull request, even if the ref has been deleted. | ||
HeadRefOid | String | Identifies the OID of the head ref associated with the pull request, even if the ref has been deleted. | ||
HeadRefPrefix | String | Identifies the prefix of the head Ref associated with the pull request. | ||
HeadRefName | String | Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. | ||
Title | String | Identifies the pull request title. | ||
TitleHTML | String | Identifies the pull request title rendered to HTML. | ||
Body | String | The body as Markdown. | ||
BodyText | String | The body rendered to text. | ||
BodyHTML | String | The body rendered to HTML. | ||
State | String | Identifies the state of the pull request. | ||
Number | Int | Identifies the pull request number. | ||
Mergeable | String | Whether or not the pull request can be merged based on the existence of merge conflicts. | ||
Merged | Bool | Whether or not the pull request was merged. | ||
Closed | Bool | true if the pull request is closed. | ||
ChangedFiles | Int | The number of changed files in this pull request. | ||
Additions | Int | The number of additions in this pull request. | ||
Deletions | Int | The number of deletions in this pull request. | ||
TotalCommentsCount | Int | Returns a count of how many comments this pull request has received. | ||
ReviewDecision | String | The current status of this pull request with respect to code review. | ||
Locked | Bool | True if the pull request is locked. | ||
ActiveLockReason | String | Reason that the conversation was locked. | ||
IsDraft | Bool | Identifies if the pull request is a draft. | ||
IsCrossRepository | Bool | The head and base repositories are different. | ||
MaintainerCanModify | Bool | Indicates whether maintainers can modify the pull request. | ||
CreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
MergeCommitId | String | The commit ID that was created when this pull request was merged. | ||
PotentialMergeCommitId | String | The commit ID that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request. | ||
Permalink | String | The permalink to the pull request. | ||
ResourcePath | String | The HTTP path for this pull request. | ||
ChecksResourcePath | String | The HTTP path for the checks of this pull request. | ||
RevertResourcePath | String | The HTTP path for reverting this pull request. | ||
Url | String | The HTTP URL for this pull request. | ||
ChecksUrl | String | The HTTP URL for the checks of this pull request. | ||
RevertUrl | String | The HTTP URL for reverting this pull request. | ||
LastEditedAt | Datetime | The moment the editor made the last edit. | ||
MergedAt | Datetime | The date and time that the pull request was merged. | ||
ClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
PublishedAt | Datetime | Identifies when the comment was published at. | ||
UpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
CreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
MilestoneId | String | Identifies the milestone's ID associated with the pull request. | ||
MilestoneTitle | String | Identifies the title of the milestone. | ||
MilestoneNumber | Int | Identifies the number of the milestone. | ||
AutoMergeRequestCommitHeadline | String | The commit title of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
AutoMergeRequestAuthorEmail | String | The email address of the author of this auto-merge request. | ||
AutoMergeRequestCommitBody | String | The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
AutoMergeRequestEnabledAt | Datetime | When was this auto-merge request was enabled. | ||
AutoMergeRequestMergeMethod | String | The merge method of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
ViewerDidAuthor | Bool | Did the viewer author this comment? | ||
IsReadByViewer | Bool | Is this pull request read by the viewer? | ||
ViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
ViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
ViewerCanReact | Bool | Can user react to this subject? | ||
ViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
ViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
ViewerCanApplySuggestion | Bool | Whether or not the viewer can apply suggestion. | ||
ViewerCanEditFiles | Bool | Can the viewer edit files within this pull request? | ||
ViewerCanDeleteHeadRef | Bool | Check if the viewer can restore the deleted head ref. | ||
ViewerCanDisableAutoMerge | Bool | Whether or not the viewer can disable auto-merge. | ||
ViewerCanEnableAutoMerge | Bool | Whether or not the viewer can enable auto-merge. | ||
ViewerCanMergeAsAdmin | Bool | Indicates whether the viewer can bypass branch protections and merge the pull request immediately. | ||
ViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
ViewerCanUpdateBranch | Bool | Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref. If the head ref is up to date or unable to be updated by this user, this will return false. | ||
ViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
ViewerLatestReviewRequestId | String | The ID of the viewer's latest review request. | ||
ViewerLatestReviewId | String | The ID of the viewer's latest review. | ||
IsMergeQueueEnabled | Bool | Indicates whether the pull request's base ref has a merge queue enabled. | ||
IsInMergeQueue | Bool | Indicates whether the pull request is in a merge queue. | ||
MergeQueueEntryId | String | The ID of this entry in the queue. | ||
MergeQueueEntryJump | Bool | Whether this pull request should jump the queue. | ||
MergeQueueEntryPosition | Int | The position of this entry in the queue. | ||
MergeQueueEntrySolo | Bool | Does this pull request need to be deployed on its own? | ||
MergeQueueEntryState | String | The state of this entry in the queue. | ||
MergeQueueEntryEnqueuedAt | Datetime | The date and time this entry was added to the merge queue. | ||
MergeQueueEntryEstimatedTimeToMerge | Int | The estimated time in seconds until this entry will be merged. | ||
MergeQueueEntryBaseCommitId | String | The ID of the base commit in the queue entry. | ||
MergeQueueEntryHeadCommitId | String | The ID of the head commit in the queue entry. | ||
MergeQueueEntryMergeQueueId | String | The ID of the entry's queue. | ||
MergeQueueEntryMergeQueueUrl | String | The HTTP URL for this merge queue. | ||
MergeQueueEntryMergeQueueResourcePath | String | The HTTP path for this merge queue. | ||
MergeQueueEntryMergeQueueNextEntryEstimatedTimeToMerge | Int | The estimated time in seconds until a newly added entry would be merged. |
Lists information and values of the 'Reviewers' field for the project items.
The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM [Project].[ItemReviewers] WHERE [Project].[ItemReviewers].[ItemId] = 'EXAMPLE'
Name | Type | References | OrderBySupport | Description |
ItemId [KEY] | String | The ID of the item. | ||
UserId [KEY] | String | The ID of the user. | ||
UserDatabaseId | Int | Identifies the primary key from the database. | ||
UserLogin | String | The username used to login. | ||
UserName | String | The user's public profile name. | ||
UserEmail | String | The user's publicly visible profile email. | ||
UserTwitterUsername | String | The user's Twitter username. | ||
UserPronouns | String | The user's profile pronouns. | ||
UserBio | String | The user's public profile bio. | ||
UserBioHTML | String | The user's public profile bio as HTML. | ||
UserCompany | String | The user's public profile company. | ||
UserCompanyHTML | String | The user's public profile company as HTML. | ||
UserLocation | String | The user's public profile location. | ||
UserAnyPinnableItems | Bool | Determine if this repository owner has any items that can be pinned to their profile. Arguments type (PinnableItemType) Filter to only a particular kind of pinnable item. | ||
UserPinnedItemsRemaining | Int | Returns how many more items this profile owner can pin to their profile. | ||
UserItemShowcaseHasPinnedItems | Bool | Whether or not the owner has pinned any repositories or gists. | ||
UserIsEmployee | Bool | Whether or not this user is a GitHub employee. | ||
UserIsHireable | Bool | Whether or not the user has marked themselves as for hire. | ||
UserIsBountyHunter | Bool | Whether or not this user is a participant in the GitHub Security Bug Bounty. | ||
UserIsCampusExpert | Bool | Whether or not this user is a participant in the GitHub Campus Experts Program. | ||
UserIsFollowingViewer | Bool | Whether or not this user is following the viewer. Inverse of viewerIsFollowing. | ||
UserIsSiteAdmin | Bool | Whether or not this user is a site administrator. | ||
UserIsDeveloperProgramMember | Bool | Whether or not this user is a GitHub Developer Program member. | ||
UserIsGitHubStar | Bool | Whether or not this user is a member of the GitHub Stars Program. | ||
UserIsSponsoringViewer | Bool | True if the viewer is sponsored by this user/organization. | ||
UserIsViewer | Bool | Whether or not this user is the viewing user. | ||
UserViewerCanFollow | Bool | Whether or not the viewer is able to follow the user. | ||
UserViewerCanSponsor | Bool | Whether or not the viewer is able to sponsor this user/organization. | ||
UserViewerIsFollowing | Bool | Whether or not this user is followed by the viewer. | ||
UserViewerIsSponsoring | Bool | True if the viewer is sponsoring this user/organization. | ||
UserViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner. | ||
UserViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile?. | ||
UserStatusId | String | The emoji's id. | ||
UserStatusEmoji | String | An emoji summarizing the user's status. | ||
UserStatusMessage | String | A brief message describing what the user is doing. | ||
UserStatusIndicatesLimitedAvailability | Bool | Whether this status indicates the user is not fully available on GitHub. | ||
UserStatusEmojiHTML | String | The status emoji as HTML. | ||
UserStatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UserStatusExpiresAt | Datetime | If set, the status will not be shown after this date. | ||
UserStatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
UserStatusOrganizationId | String | The organization's id. | ||
UserStatusOrganizationLogin | String | The organization's login name. | ||
UserInteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
UserInteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
UserInteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
UserHasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
UserMonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
UserEstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
UserSponsorsListingId | String | The listing's id. | ||
UserSponsorsListingName | String | The listing's full name. | ||
UserTotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
UserResourcePath | String | The HTTP path for this user. | ||
UserProjectsResourcePath | String | The HTTP path listing user's projects. | ||
UserUrl | String | The HTTP URL for this user. | ||
UserProjectsUrl | String | The HTTP URL listing user's projects. | ||
UserWebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
UserAvatarUrl | String | A URL pointing to the user's public avatar. Arguments size (Int) The size of the resulting square image. | ||
UserCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
UserUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
UserRepositoryCount | Int | The number of repositories that a user owns. | ||
UserFollowerCount | Int | The number of followers that a user has. | ||
BotId | String | The ID for this bot. | ||
BotDatabaseId | Int | Identifies the primary key from the database. | ||
BotLogin | String | The username of the actor. | ||
BotUrl | String | The HTTP URL for this bot. | ||
BotResourcePath | String | The HTTP path for this bot. | ||
BotCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
BotUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
MannequinId [KEY] | String | The ID for this mannequin. | ||
MannequinDatabaseId | Int | Identifies the primary key from the database. | ||
MannequinLogin | String | True | The username of the actor. | |
MannequinEmail | String | The mannequin's email on the source instance. | ||
MannequinUrl | String | The URL to this resource. | ||
MannequinResourcePath | String | The HTML path to this resource. | ||
MannequinCreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
MannequinUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
MannequinClaimantId | String | The ID of the claimant. | ||
MannequinClaimantLogin | String | The username used to login. | ||
TeamId [KEY] | String | The ID of the team. | ||
TeamDatabaseId | Int | Identifies the primary key from the database. | ||
TeamOrganizationId | String | The ID of the organization. | ||
TeamName | String | True | The name of the team. | |
TeamDescription | String | The description of the team. | ||
TeamPrivacy | String | The level of privacy the team has. | ||
TeamSlug | String | The slug corresponding to the team. | ||
TeamUrl | String | The HTTP URL for this team. | ||
TeamCombinedSlug | String | The slug corresponding to the organization and team. | ||
TeamDiscussionsUrl | String | The HTTP URL for team discussions. | ||
TeamMembersUrl | String | The HTTP URL for the team' members. | ||
TeamNotificationSetting | String | The notification setting that the team has set. | ||
TeamRepositoriesUrl | String | The HTTP URL for this team's repositories. | ||
TeamResourcePath | String | The HTTP path for this team. | ||
TeamTeamsUrl | String | The HTTP URL for this team's teams. | ||
TeamViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
TeamDiscussionsResourcePath | String | The HTTP path for team discussions. | ||
TeamEditTeamUrl | String | The HTTP URL for editing this team. | ||
TeamMembersResourcePath | String | The HTTP path for the team' members. | ||
TeamNewTeamUrl | String | The HTTP URL creating a new team. | ||
TeamRepositoriesResourcePath | String | The HTTP path for this team's repositories. | ||
TeamTeamsResourcePath | String | The HTTP path for this team's teams. | ||
TeamViewerCanAdminister | Bool | Team is adminable by the viewer. | ||
TeamViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
TeamEditTeamResourcePath | String | The HTTP path for editing this team. | ||
TeamNewTeamResourcePath | String | The HTTP path creating a new team. | ||
TeamCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
TeamUpdatedAt | Datetime | Identifies the date and time when the object was last updated. |
Lists items information within the project.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | The item ID. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
FullDatabaseId | Long | Identifies the primary key from the database. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
IsArchived | Bool | Whether the item is archived. | ||
Type | String | The type of the item. | ||
DraftIssueId | String | The ID of the draft issue. | ||
DraftIssueTitle | String | The title of the draft issue. | ||
DraftIssueBody | String | The body of the draft issue. | ||
DraftIssueBodyText | String | The body of the draft issue rendered to text. | ||
DraftIssueBodyHTML | String | The body of the draft issue rendered to HTML. | ||
DraftIssueUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
DraftIssueCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
IssueId | String | The Issue ID. | ||
IssueDatabaseId | Int | Identifies the primary key from the database. | ||
IssueFullDatabaseId | Long | Identifies the primary key from the database as a BigInt. | ||
IssueTitle | String | Identifies the issue title. | ||
IssueTitleHTML | String | Identifies the issue title rendered to HTML. | ||
IssueAuthor | String | The username of the actor who authored the comment. | ||
IssueAuthorAssociation | String | Author's association with the subject of the comment. | ||
IssueEditor | String | The username of the actor who edited the comment. | ||
IssueBody | String | Identifies the body of the issue. | ||
IssueBodyText | String | Identifies the body of the issue rendered to text. | ||
IssueBodyHTML | String | The body rendered to HTML. | ||
IssueBodyResourcePath | String | The http path for this issue body. | ||
IssueBodyUrl | String | The http URL for this issue body. | ||
IssueNumber | Int | Identifies the issue number. | ||
IssueState | String | Identifies the state of the issue. | ||
IssueStateReason | String | Identifies the reason for the issue state. | ||
IssueLocked | Bool | True if the object is locked. | ||
IssueActiveLockReason | String | Reason that the conversation was locked. | ||
IssueClosed | Bool | True if the object is closed (definition of closed may depend on type). | ||
IssueIsPinned | Bool | Indicates whether or not this issue is currently pinned to the repository issues list. | ||
IssueIncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
IssueCreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
IssueResourcePath | String | The HTTP path for this issue. | ||
IssueUrl | String | The HTTP URL for this issue. | ||
IssueLastEditedAt | Datetime | The moment the editor made the last edit. | ||
IssuePublishedAt | Datetime | Identifies when the comment was published at. | ||
IssueClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
IssueUpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
IssueCreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
IssueMilestoneId | String | Identifies the milestone associated with the issue. | ||
IssueMilestoneTitle | String | Identifies the title of the milestone. | ||
IssueMilestoneNumber | Int | Identifies the number of the milestone. | ||
IssueIsReadByViewer | Bool | Is this issue read by the viewer. | ||
IssueViewerDidAuthor | Bool | Did the viewer author this comment? | ||
IssueViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
IssueViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
IssueViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
IssueViewerCanDelete | Bool | Check if the current viewer can delete this object. | ||
IssueViewerCanReact | Bool | Can user react to this subject? | ||
IssueViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
IssueViewerThreadSubscriptionStatus | String | Identifies the viewer's thread subscription status. | ||
IssueViewerThreadSubscriptionFormAction | String | Identifies the viewer's thread subscription form action. | ||
IssueViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
IssueViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
IssueCommentCount | Int | The number of comments on the issue. | ||
IssueReactionCount | Int | The number of reactions on the issue. | ||
PullRequestId | String | The ID of the pull request. | ||
PullRequestDatabaseId | Int | Identifies the primary key from the database. | ||
PullRequestFullDatabaseId | Long | Identifies the primary key from the database as a BigInt. | ||
PullRequestAuthor | String | The actor's login name who authored the comment. | ||
PullRequestAuthorAssociation | String | Author's association with the subject of the comment. | ||
PullRequestEditor | String | The actor's login name who edited this pull request's body. | ||
PullRequestHeadRepositoryOwner | String | The owner's login name of the repository associated with this pull request's head Ref. | ||
PullRequestMergedBy | String | The actor's login name who merged the pull request. | ||
PullRequestBaseRefId | String | Identifies the ID of the base ref associated with the pull request, even if the ref has been deleted. | ||
PullRequestBaseRefOid | String | Identifies the OID of the base ref associated with the pull request, even if the ref has been deleted. | ||
PullRequestBaseRefPrefix | String | Identifies the prefix of the base Ref associated with the pull request. | ||
PullRequestBaseRefName | String | Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. | ||
PullRequestHeadRefId | String | Identifies the ID of the head ref associated with the pull request, even if the ref has been deleted. | ||
PullRequestHeadRefOid | String | Identifies the OID of the head ref associated with the pull request, even if the ref has been deleted. | ||
PullRequestHeadRefPrefix | String | Identifies the prefix of the head Ref associated with the pull request. | ||
PullRequestHeadRefName | String | Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. | ||
PullRequestTitle | String | Identifies the pull request title. | ||
PullRequestTitleHTML | String | Identifies the pull request title rendered to HTML. | ||
PullRequestBody | String | The body as Markdown. | ||
PullRequestBodyText | String | The body rendered to text. | ||
PullRequestBodyHTML | String | The body rendered to HTML. | ||
PullRequestState | String | Identifies the state of the pull request. | ||
PullRequestNumber | Int | Identifies the pull request number. | ||
PullRequestMergeable | String | Whether or not the pull request can be merged based on the existence of merge conflicts. | ||
PullRequestMerged | Bool | Whether or not the pull request was merged. | ||
PullRequestClosed | Bool | true if the pull request is closed. | ||
PullRequestChangedFiles | Int | The number of changed files in this pull request. | ||
PullRequestAdditions | Int | The number of additions in this pull request. | ||
PullRequestDeletions | Int | The number of deletions in this pull request. | ||
PullRequestTotalCommentsCount | Int | Returns a count of how many comments this pull request has received. | ||
PullRequestReviewDecision | String | The current status of this pull request with respect to code review. | ||
PullRequestLocked | Bool | true if the pull request is locked. | ||
PullRequestActiveLockReason | String | Reason that the conversation was locked. | ||
PullRequestIsDraft | Bool | Identifies if the pull request is a draft. | ||
PullRequestIsCrossRepository | Bool | The head and base repositories are different. | ||
PullRequestMaintainerCanModify | Bool | Indicates whether maintainers can modify the pull request. | ||
PullRequestCreatedViaEmail | Bool | Check if this comment was created via an email reply. | ||
PullRequestIncludesCreatedEdit | Bool | Check if this comment was edited and includes an edit with the creation data. | ||
PullRequestMergeCommitId | String | The commit ID that was created when this pull request was merged. | ||
PullRequestPotentialMergeCommitId | String | The commit ID that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request. | ||
PullRequestPermalink | String | The permalink to the pull request. | ||
PullRequestResourcePath | String | The HTTP path for this pull request. | ||
PullRequestChecksResourcePath | String | The HTTP path for the checks of this pull request. | ||
PullRequestRevertResourcePath | String | The HTTP path for reverting this pull request. | ||
PullRequestUrl | String | The HTTP URL for this pull request. | ||
PullRequestChecksUrl | String | The HTTP URL for the checks of this pull request. | ||
PullRequestRevertUrl | String | The HTTP URL for reverting this pull request. | ||
PullRequestLastEditedAt | Datetime | The moment the editor made the last edit. | ||
PullRequestMergedAt | Datetime | The date and time that the pull request was merged. | ||
PullRequestClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
PullRequestPublishedAt | Datetime | Identifies when the comment was published at. | ||
PullRequestUpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
PullRequestCreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
PullRequestMilestoneId | String | Identifies the milestone's ID associated with the pull request. | ||
PullRequestMilestoneTitle | String | Identifies the title of the milestone. | ||
PullRequestMilestoneNumber | Int | Identifies the number of the milestone. | ||
PullRequestAutoMergeRequestCommitHeadline | String | The commit title of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
PullRequestAutoMergeRequestAuthorEmail | String | The email address of the author of this auto-merge request. | ||
PullRequestAutoMergeRequestCommitBody | String | The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
PullRequestAutoMergeRequestEnabledAt | Datetime | When was this auto-merge request was enabled. | ||
PullRequestAutoMergeRequestMergeMethod | String | The merge method of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging. | ||
PullRequestViewerDidAuthor | Bool | Did the viewer author this comment? | ||
PullRequestIsReadByViewer | Bool | Is this pull request read by the viewer? | ||
PullRequestViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
PullRequestViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
PullRequestViewerCanReact | Bool | Can user react to this subject? | ||
PullRequestViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
PullRequestViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
PullRequestViewerCanApplySuggestion | Bool | Whether or not the viewer can apply suggestion. | ||
PullRequestViewerCanEditFiles | Bool | Can the viewer edit files within this pull request? | ||
PullRequestViewerCanDeleteHeadRef | Bool | Check if the viewer can restore the deleted head ref. | ||
PullRequestViewerCanDisableAutoMerge | Bool | Whether or not the viewer can disable auto-merge. | ||
PullRequestViewerCanEnableAutoMerge | Bool | Whether or not the viewer can enable auto-merge. | ||
PullRequestViewerCanMergeAsAdmin | Bool | Indicates whether the viewer can bypass branch protections and merge the pull request immediately. | ||
PullRequestViewerCanUpdate | Bool | Check if the current viewer can update this object. | ||
PullRequestViewerCanUpdateBranch | Bool | Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref. If the head ref is up to date or unable to be updated by this user, this will return false. | ||
PullRequestViewerCannotUpdateReasons | String | Reasons why the current viewer can not update this comment. | ||
PullRequestViewerLatestReviewRequestId | String | The ID of the viewer's latest review request. | ||
PullRequestViewerLatestReviewId | String | The ID of the viewer's latest review. | ||
PullRequestIsMergeQueueEnabled | Bool | Indicates whether the pull request's base ref has a merge queue enabled. | ||
PullRequestIsInMergeQueue | Bool | Indicates whether the pull request is in a merge queue. | ||
PullRequestMergeQueueEntryId | String | The ID of this entry in the queue. | ||
PullRequestMergeQueueEntryJump | Bool | Whether this pull request should jump the queue. | ||
PullRequestMergeQueueEntryPosition | Int | The position of this entry in the queue. | ||
PullRequestMergeQueueEntrySolo | Bool | Does this pull request need to be deployed on its own? | ||
PullRequestMergeQueueEntryState | String | The state of this entry in the queue. | ||
PullRequestMergeQueueEntryEnqueuedAt | Datetime | The date and time this entry was added to the merge queue. | ||
PullRequestMergeQueueEntryEstimatedTimeToMerge | Int | The estimated time in seconds until this entry will be merged. | ||
PullRequestMergeQueueEntryBaseCommitId | String | The ID of the base commit in the queue entry. | ||
PullRequestMergeQueueEntryHeadCommitId | String | The ID of the head commit in the queue entry. | ||
PullRequestMergeQueueEntryMergeQueueId | String | The ID of the entry's queue. | ||
PullRequestMergeQueueEntryMergeQueueUrl | String | The HTTP URL for this merge queue. | ||
PullRequestMergeQueueEntryMergeQueueResourcePath | String | The HTTP path for this merge queue. | ||
PullRequestMergeQueueEntryMergeQueueNextEntryEstimatedTimeToMerge | Int | The estimated time in seconds until a newly added entry would be merged. | ||
TitleId | String | The ID of the value. | ||
TitleDatabaseId | Int | Identifies the primary key from the database. | ||
TitleCreatorLogin | String | The actor who created the item. | ||
TitleCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
TitleUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
TitleText | String | Text value of a field. | ||
StatusId | String | The ID of the value. | ||
StatusDatabaseId | Int | Identifies the primary key from the database. | ||
StatusCreatorLogin | String | The actor who created the item. | ||
StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
StatusName | String | The name of the selected single select option. | ||
StatusNameHTML | String | The html name of the selected single select option. | ||
StatusDescription | String | A plain-text description of the selected single-select option, such as what the option means. | ||
StatusDescriptionHTML | String | The description of the selected single-select option, including HTML tags. | ||
StatusColor | String | The color applied to the selected single-select option. | ||
StatusOptionId | String | The id of the selected single select option. | ||
RepositoryId | String | The ID of the repository. | ||
RepositoryDatabaseId | Int | Identifies the primary key from the database. | ||
RepositoryName | String | The name of the repository. | ||
RepositoryNameWithOwner | String | The repository's name with owner. | ||
RepositoryOwnerId | String | The repository's owner ID. | ||
RepositoryOwnerLogin | String | The login field of a user or organization. | ||
RepositoryVisibility | String | Indicates the repository's visibility level. | ||
RepositoryDiskUsage | Int | The number of kilobytes this repository occupies on disk. | ||
RepositoryForkCount | Int | Returns how many forks there are of this repository in the whole network. | ||
RepositoryStargazerCount | Int | Returns a count of how many stargazers there are on this object. | ||
RepositoryWatcherCount | Int | The number of watchers in a repository. | ||
RepositoryTopicCount | Int | The number of topics that have been applied to the repository. | ||
RepositoryTempCloneToken | String | Temporary authentication token for cloning this repository. | ||
RepositoryWebCommitSignoffRequired | Bool | Whether contributors are required to sign off on web-based commits in this repository. | ||
RepositoryUsesCustomOpenGraphImage | Bool | Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. | ||
RepositoryDescription | String | The description of the repository. | ||
RepositoryDescriptionHTML | String | The description of the repository rendered to HTML. | ||
RepositoryShortDescriptionHTML | String | A description of the repository, rendered to HTML without any links in it. | ||
RepositoryResourcePath | String | The HTTP path for this repository. | ||
RepositoryProjectsResourcePath | String | The HTTP path listing the repository's projects. | ||
RepositoryUrl | String | The HTTP URL for this repository. | ||
RepositoryHomepageUrl | String | The repository's URL. | ||
RepositoryMirrorUrl | String | The repository's original mirror URL. | ||
RepositoryProjectsUrl | String | The HTTP URL listing the repository's projects. | ||
RepositorySecurityPolicyUrl | String | The security policy URL. | ||
RepositorySSHUrl | String | The SSH URL to clone this repository. | ||
RepositoryOpenGraphImageUrl | String | The image used to represent this repository in Open Graph data. | ||
RepositoryMergeCommitTitle | String | How the default commit title will be generated when merging a pull request. | ||
RepositoryMergeCommitMessage | String | How the default commit message will be generated when merging a pull request. | ||
RepositorySquashMergeCommitTitle | String | How the default commit title will be generated when squash merging a pull request. | ||
RepositorySquashMergeCommitMessage | String | How the default commit message will be generated when squash merging a pull request. | ||
RepositoryDeleteBranchOnMerge | Bool | Whether or not branches are automatically deleted when merged in this repository. | ||
RepositoryHasDiscussionsEnabled | Bool | Indicates if the repository has the Discussions feature enabled. | ||
RepositoryHasIssuesEnabled | Bool | Indicates if the repository has issues feature enabled. | ||
RepositoryHasProjectsEnabled | Bool | Indicates if the repository has the Projects feature enabled. | ||
RepositoryHasWikiEnabled | Bool | Indicates if the repository has wiki feature enabled. | ||
RepositoryHasVulnerabilityAlertsEnabled | Bool | Whether vulnerability alerts are enabled for the repository. | ||
RepositoryHasSponsorshipsEnabled | Bool | Indicates if the repository displays a Sponsor button for financial contributions. | ||
RepositoryIsInOrganization | Bool | Indicates if a repository is either owned by an organization, or is a private fork of an organization repository. | ||
RepositoryIsBlankIssuesEnabled | Bool | Returns true if blank issue creation is allowed. | ||
RepositoryIsSecurityPolicyEnabled | Bool | Returns true if this repository has a security policy. | ||
RepositoryIsUserConfigurationRepository | Bool | Is this repository a user configuration repository? | ||
RepositoryIsArchived | Bool | Indicates if the repository is unmaintained. | ||
RepositoryIsDisabled | Bool | Returns whether or not this repository disabled. | ||
RepositoryIsEmpty | Bool | Returns whether or not this repository is empty. | ||
RepositoryIsFork | Bool | Identifies if the repository is a fork. | ||
RepositoryIsLocked | Bool | Indicates if the repository has been locked or not. | ||
RepositoryIsMirror | Bool | Identifies if the repository is a mirror. | ||
RepositoryIsPrivate | Bool | Identifies if the repository is private. | ||
RepositoryIsTemplate | Bool | Identifies if the repository is a template that can be used to generate new repositories. | ||
RepositoryLockReason | String | The reason the repository has been locked. | ||
RepositoryTemplateRepositoryId | String | The ID of the repository from which this repository was generated, if any. | ||
RepositoryParentId | String | The repository parent ID, if this is a fork. | ||
RepositoryForkingAllowed | Bool | Whether this repository allows forks. | ||
RepositoryAutoMergeAllowed | Bool | Whether or not Auto-merge can be enabled on pull requests in this repository. | ||
RepositorySquashMergeAllowed | Bool | Whether or not squash-merging is enabled on this repository. | ||
RepositoryRebaseMergeAllowed | Bool | Whether or not rebase-merging is enabled on this repository. | ||
RepositoryMergeCommitAllowed | Bool | Whether or not PRs are merged with a merge commit on this repository. | ||
RepositoryAllowUpdateBranch | Bool | Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. | ||
RepositoryViewerPermission | String | The users permission level on the repository. Will return null if authenticated as an GitHub App. | ||
RepositoryViewerSubscription | String | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | ||
RepositoryViewerHasStarred | Bool | Returns a boolean indicating whether the viewing user has starred this starrable. | ||
RepositoryViewerDefaultCommitEmail | String | The last commit email for the viewer. | ||
RepositoryViewerDefaultMergeMethod | String | The last used merge method by the viewer or the default for the repository. | ||
RepositoryViewerPossibleCommitEmails | String | A list of emails this viewer can commit with. | ||
RepositoryViewerCanAdminister | Bool | Indicates whether the viewer has admin permissions on this repository. | ||
RepositoryViewerCanSubscribe | Bool | Check if the viewer is able to change their subscription status for the repository. | ||
RepositoryViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
RepositoryViewerCanUpdateTopics | Bool | Indicates whether the viewer can update the topics of this repository. | ||
RepositoryCodeOfConductId | String | The ID of the Code of Conduct. | ||
RepositoryCodeOfConductName | String | The formal name of the Code of Conduct. | ||
RepositoryCodeOfConductBody | String | The body of the Code of Conduct. | ||
RepositoryCodeOfConductKey | String | The key for the Code of Conduct. | ||
RepositoryCodeOfConductUrl | String | The HTTP URL for this Code of Conduct. | ||
RepositoryCodeOfConductResourcePath | String | The HTTP path for this Code of Conduct. | ||
RepositoryDefaultBranchRefId | String | The ref id. | ||
RepositoryDefaultBranchRefName | String | The ref name. | ||
RepositoryInteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
RepositoryInteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
RepositoryInteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
RepositoryLatestReleaseId | String | The ID of the release. | ||
RepositoryLatestReleaseName | String | The title of the release. | ||
RepositoryLicenseId | String | The ID of the license associated with the repository. | ||
RepositoryLicenseKey | String | The key of the license associated with the repository. | ||
RepositoryLanguageId | String | The ID of the current primary language. | ||
RepositoryLanguageName | String | The name defined for the current language. | ||
RepositoryLanguageColor | String | The color defined for the current language. | ||
RepositoryPushedAt | Datetime | Identifies when the repository was last pushed to. | ||
RepositoryArchivedAt | Datetime | Identifies the date and time when the repository was archived. | ||
RepositoryCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
RepositoryUpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
MilestoneId | String | The ID of the milestone. | ||
MilestoneTitle | String | Identifies the title of the milestone. | ||
MilestoneClosed | Bool | True if the object is closed (definition of closed may depend on type). | ||
MilestoneProgressPercentage | Double | Progress Percentage for this milestone. | ||
MilestoneDescription | String | Identifies the description of the milestone. | ||
MilestoneNumber | Int | True | Identifies the number of the milestone. | |
MilestoneState | String | Identifies the state of the milestone. | ||
MilestoneResourcePath | String | The HTTP path for this milestone. | ||
MilestoneUrl | String | The HTTP URL for this milestone. | ||
MilestoneViewerCanClose | Bool | Indicates if the object can be closed by the viewer. | ||
MilestoneViewerCanReopen | Bool | Indicates if the object can be reopened by the viewer. | ||
MilestoneDueOn | Datetime | True | Identifies the due date of the milestone. | |
MilestoneClosedAt | Datetime | Identifies the date and time when the object was closed. | ||
MilestoneUpdatedAt | Datetime | True | Identifies the date and time when the object was last updated. | |
MilestoneCreatedAt | Datetime | True | Identifies the date and time when the object was created. | |
IterationId | String | The ID of the value. | ||
IterationDatabaseId | Int | Identifies the primary key from the database. | ||
IterationCreatorLogin | String | The actor who created the item. | ||
IterationCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
IterationUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
IterationTitle | String | The title of the iteration. | ||
IterationTitleHTML | String | The title of the iteration, with HTML. | ||
IterationStartDate | Date | The start date of the iteration. | ||
IterationDuration | Int | The duration of the iteration in days. | ||
IterationIterationId | String | The ID of the iteration. | ||
CustomNameId | String | The ID of the value. | ||
CustomNameDatabaseId | Int | Identifies the primary key from the database. | ||
CustomNameCreatorLogin | String | The actor who created the item. | ||
CustomNameCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
CustomNameUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CustomNameText | String | Text value of a field. | ||
CustomNumberId | String | The ID of the value. | ||
CustomNumberDatabaseId | Int | Identifies the primary key from the database. | ||
CustomNumberCreatorLogin | String | The actor who created the item. | ||
CustomNumberCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
CustomNumberUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CustomNumberNumber | Double | Number as a float. | ||
CustomDateId | String | The ID of the value. | ||
CustomDateDatabaseId | Int | Identifies the primary key from the database. | ||
CustomDateCreatorLogin | String | The actor who created the item. | ||
CustomDateCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
CustomDateUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CustomDateDate | Date | Date value for the field. | ||
CustomSelectId | String | The ID of the value. | ||
CustomSelectDatabaseId | Int | Identifies the primary key from the database. | ||
CustomSelectCreatorLogin | String | The actor who created the item. | ||
CustomSelectCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
CustomSelectUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CustomSelectName | String | The name of the selected single select option. | ||
CustomSelectNameHTML | String | The html name of the selected single select option. | ||
CustomSelectDescription | String | A plain-text description of the selected single-select option, such as what the option means. | ||
CustomSelectDescriptionHTML | String | The description of the selected single-select option, including HTML tags. | ||
CustomSelectColor | String | The color applied to the selected single-select option. | ||
CustomSelectOptionId | String | The id of the selected single select option. | ||
CustomIterationId | String | The ID of the value. | ||
CustomIterationDatabaseId | Int | Identifies the primary key from the database. | ||
CustomIterationCreatorLogin | String | The actor who created the item. | ||
CustomIterationCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
CustomIterationUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CustomIterationTitle | String | The title of the iteration. | ||
CustomIterationTitleHTML | String | The title of the iteration, with HTML. | ||
CustomIterationStartDate | Date | The start date of the iteration. | ||
CustomIterationDuration | Int | The duration of the iteration in days. | ||
CustomIterationIterationId | String | The ID of the iteration. |
This view has no filter and includes all project view fields.
The Sync App processes filters client-side within the Sync App.
Name | Type | References | OrderBySupport | Description |
ItemId [KEY] | String | The ID of the item. | ||
DatabaseId | Int | Identifies the primary key from the database. | ||
UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
IsArchived | Bool | Whether the item is archived. | ||
Type | String | The type of the item. | ||
PullRequestState | String | Identifies the state of the pull request. | ||
IssueState | String | Identifies the state of the issue. | ||
Reason | String | The possible state reasons of an issue. | ||
Title | String | Text value of a field. | ||
Assignees | String | The username used to login. | ||
Status | String | The name of the selected single select option. | ||
Labels | String | Identifies the label name. | ||
Linked_pull_requests | Int | Identifies the pull request number. | ||
Reviewers | String | The username. | ||
Repository | String | The repository's name with owner. | ||
Milestone | String | Identifies the title of the milestone. | ||
Iteration | String | The tile of the iteration. | ||
CustomName | String | Text value of a field. | ||
CustomNumber | Double | Number as a float. | ||
CustomDate | Date | Date value for the field. | ||
CustomSelect | String | The name of the selected single select option. | ||
CustomIteration | String | The tile of the iteration. |
プロパティ | 説明 |
OwnerLogin | A unique login name belonging either to a user or an organization. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Schema | This property can be used to restrict the dynamically retrieved schemas to a specific project or repository schema. This property is optional. |
プロパティ | 説明 |
MaxPointsPerCall | Specifies how many points a call will cost. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
プロパティ | 説明 |
OwnerLogin | A unique login name belonging either to a user or an organization. |
A unique login name belonging either to a user or an organization.
You can set this connection property to have the driver list repositories and projects owned by a specific user or organization in GitHub.
All table default login filters or similar, where possible, will be set to the value of this property.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はGitHub への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Schema | This property can be used to restrict the dynamically retrieved schemas to a specific project or repository schema. This property is optional. |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\GitHub Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
This property can be used to restrict the dynamically retrieved schemas to a specific project or repository schema. This property is optional.
This property can be used to restrict the dynamically retrieved schemas to a specific project or repository schema. This property is optional.
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxPointsPerCall | Specifies how many points a call will cost. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
Specifies how many points a call will cost.
The GraphQL API v4 rate limit is 5,000 points per hour.
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Repositories WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。