Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、GitHub への接続を作成します。GitHub アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからGitHub コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Connecting to GitHub

Web Applications

When connecting via a Web application, you need to register a custom OAuth application with GitHub. You can then use the Sync App to get and manage the OAuth token values. See カスタムOAuth アプリの作成 for more information.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
2. Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic Refresh of the OAuth Access Token

To have the Sync App automatically refresh the OAuth access token, set the following on the first data connection.

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.
• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• OAuthSettingsLocation: Set this to the path where you want the Sync App to save the OAuth values, which persist across connections.

On subsequent data connections, set the following:

• InitiateOAuth
• OAuthSettingsLocation
• UserLogin (optional);
• RepositoryName (optional);

このセクションでは、GitHub Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、GitHub にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Sync App は、GitHub API のエンティティをビューおよびストアドプロシージャにモデル化します。これらはスキーマファイルに定義されています。テキストベースのシンプルな設定ファイルです。

このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

ビュー

ビュー は、利用可能なビューについて説明します。ビューは、リポジトリ、コミット、プロジェクトなどをモデル化するために静的に定義されます。

ストアドプロシージャ

ストアドプロシージャ は、データソースへの関数形式のインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

GitHub Connector for CData Sync ビュー

Lists information about branches in a repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin and RepositoryName support the following operator: =

SELECT * FROM Branches WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

Columns

Lists information about comments which were made on a specific commit.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin and RepositoryName support the following operator: =

SELECT * FROM CommitComments WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

Columns

Lists information about commits done in a repository .

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, BranchName and RepositoryName support the following operator: =
• CommittedDate supports the following operators: =,>=,>,<,<=

SELECT * FROM Commits WHERE RepositoryName = 'MyRepo'

SELECT * FROM Commits WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

SELECT * FROM Commits WHERE BranchName = 'master'

SELECT * FROM Commits WHERE RepositoryName = 'MyRepo' AND CommittedDate >= '2017-12-18 09:02:22.0' AND CommittedDate <= '2018-01-11 15:00:08.0'

Columns

Lists information about forks of a repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, and IsLocked support the following operator: =

SELECT * FROM Forks WHERE IsLocked=true

Columns

Lists information about comments which were made on a specific issue.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, and IssueNumber support the following operator: =

SELECT * FROM IssueComments WHERE RepositoryName = 'MyRepo'

SELECT * FROM IssueComments WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

SELECT * FROM IssueComments WHERE IssueNumber = 5 AND RepositoryName = 'MyRepo'

Columns

Lists all project issues.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin and State support the following operator: =
• RepositoryName and Author support the following operators: =,!=
• ClosedAt, CreatedAt, and UpdatedAt support the following operators: =,>,>=,<,<=

SELECT * FROM Issues WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

SELECT * FROM Issues WHERE RepositoryName = 'test' AND UpdatedAt >= '2018-05-10 11:11:38.0'

Columns

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Lists information about the different labels you can apply on an issue.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, and Name support the following operator: =

SELECT * FROM Labels WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

SELECT * FROM Labels WHERE Name = 'duplicate'

Columns

The conditions set by the license.

Table-Specific Information

Select

You must specify the LicenseKey when executing a SELECT query against this table.

• LicenseKey supports the following operator: =

SELECT * FROM LicenseConditions WHERE LicenseKey = 'mit'

Columns

The limitations set by the license.

Table-Specific Information

Select

You must specify the LicenseKey when executing a SELECT query against this table.

• LicenseKey supports the following operator: =

SELECT * FROM LicenseLimitations WHERE LicenseKey = 'mit'

Columns

The permissions set by the license.

Table-Specific Information

Select

You must specify the LicenseKey when executing a SELECT query against this table.

• LicenseKey supports the following operator: =

SELECT * FROM LicensePermissions WHERE LicenseKey = 'mit'

Columns

Lists the open source licenses.

Table-Specific Information

Select

• Key supports the following operator: =

SELECT * FROM Licenses

SELECT * FROM Licenses WHERE Key = 'mit'

Columns

Lists information about milestones in a repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, Number, and State support the following operator: =

SELECT * FROM Milestones WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'
   
SELECT * FROM Milestones WHERE State = 'all'

SELECT * FROM Milestones WHERE Number = 1

Columns

Lists information about about the organizations of the logged in user.

View-Specific Information

By default this view will only return information about the organizations of the logged in user.

Columns

Lists information about project columns.

Table-Specific Information

Select

• UserLogin, RepositoryName, and ProjectNumber support the following operator: =

You can specify the ProjectNumber column to list all columns for a specific project.

SELECT * FROM ProjectColumns WHERE RepositoryName = 'test' AND ProjectNumber = '108'
  

Columns

Lists information about projects.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, Number, and State support the following operator: =

SELECT * FROM Projects WHERE UserLogin = 'MyUserLogin' AND RepositoryName = 'MyRepo'

SELECT * FROM Projects WHERE Number=2

SELECT * FROM Projects WHERE State = 'all'

Columns

Lists information about pull request reviews in a repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, PullRequestNumber, Author, and State support the following operator: =

SELECT * FROM PullRequestReviews WHERE RepositoryName = 'test'

SELECT * FROM PullRequestReviews WHERE RepositoryName = 'test' AND Author = 'testaccount71'

SELECT * FROM PullRequestReviews WHERE RepositoryName='test' AND State IN ('PENDING','DISMISSED')

Columns

Lists information about pull requests in a repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, BaseRefName, HeadRefName, Number, and State support the following operator: =

SELECT * FROM PullRequests WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

SELECT * FROM PullRequests WHERE Number = 8
  
SELECT * FROM PullRequests WHERE State = 'all'

SELECT * FROM PullRequests WHERE BaseRefName = 'newbranch'

SELECT * FROM PullRequests WHERE HeadRefName = 'master'

SELECT * FROM PullRequests WHERE RepositoryName='MyRepo' AND State IN ('OPEN','MERGED')

Columns

List of releases assets which are dependent on a release.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, ReleaseTagName, and Name support the following operator: =

SELECT * FROM ReleaseAssets WHERE RepositoryName = 'test'

SELECT * FROM ReleaseAssets WHERE RepositoryName = 'test' AND ReleaseTagName = 'value8888'

SELECT * FROM ReleaseAssets WHERE RepositoryName = 'test' AND Name = 'hola21.zip'

Columns

Lists information about the different releases of a repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin value.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, and TagName support the following operator: =

SELECT * FROM Releases

SELECT * FROM Releases WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

SELECT * FROM Releases WHERE RepositoryName = 'test' AND TagName = 'value8888'

Columns

Lists information about a user's repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, IsArchived, IsFork, IsMirror, and IsPrivate support the following operator: =
• Name, LicenseKey, and LanguageName support the following operators: =,!=
• CreatedAt, PushedAt, and ForkCountsupport the following operators: =,>,>=,<,<=

SELECT * FROM Repositories WHERE UserLogin = 'MyUser'

SELECT * FROM Repositories WHERE Name = 'aName'

Columns

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

A list of applied repository-topic associations for this repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin and RepositoryName support the following operator: =

SELECT * FROM Topics WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

Columns

Lists information about GitHub users.

View-Specific Information

Select

By default view will return information about all the registered users in GitHub. Note: This can be quite slow since GitHub has more than 20 million registered users.

If you specify the Login column, this view will only return information about the specified user.

The Sync App uses the GitHub API to process search criteria that refer to UserLogin. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

• Login and Location support the following operator: =,!=
• CreatedAt supports the following operators: =,>,>=,<,<=

SELECT * FROM Users WHERE Login = 'MyUser'

Columns

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

A list of users watching the repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin and RepositoryName support the following operator: =

SELECT * FROM Watchers WHERE RepositoryName = 'MyRepo'

SELECT * FROM Watchers WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

Columns

Connection

OAuth

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

Restrict query results by the repository name.

解説

Optional when creating a new connection. However, this table is required to query some tables.

Where RepositoryName is required, you must also specify UserLogin.

Restrict query results by UserLogin.

解説

You can set this connection property to restrict query results by UserLogin.

This property is optional when creating a connection; you can also specify the UserLogin pseudo column in your query to override the value set in the connection. The driver uses the currently authenticated user's UserLogin if one is not explicitly specified as a connection property or as a criteria.

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

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 をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには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 を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

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 のいずれかです。有効な値は次のとおりです。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\GitHub Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、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` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

Specifies how many points a call will cost.

解説

The GraphQL API v4 rate limit is 5,000 points per hour.

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Users WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"