CData Sync App は、WordPress データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
WordPress コネクタはCData Sync アプリケーションから使用可能で、WordPress からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、WordPress REST API バージョン2.x のエンティティをリレーショナルテーブルとしてモデル化します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Supply the URL in its full form. For example, if your site is hosted at http://localhost/wp/wordpress', the URL should be http://localhost/wp/wordpress, and not 'htpp://localhost'. Failure to supply the URL in its full form results in a 'site not found' error.
WordPress supports two types of authentication:
Before you configure WordPress to use Basic Authentication:
To configure Basic Authentication:
You are now ready to connect.
The following subsections describe how to authenticate to WordPress from three common authentication flows. For information about how to create a custom OAuth application, see カスタムOAuth アプリケーションの作成. For a complete list of connection string properties available in WordPress, see Connection.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token, do the following:
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL/TLS のネゴシエーションを試みます。別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows システムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらに、HTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、WordPress Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、WordPress にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、WordPress API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、テキストエディタでカスタマイズ可能なコンフィギュレーションファイルです。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Sync App は、WordPress API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをSync App 内で処理します。次のセクションでは、API の制限と要件を説明します。
Sync App はWordPress のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Categories | Create, update, delete, and query Categories to use for categorizing your posts. |
Comments | Create, update, delete, and query Comments associated with a post. |
Media | Create, update, delete, and query Media to attach in your posts. |
Pages | Create, update, delete, and query Wordpress Pages. |
Plugins | Create, update, delete, and query Plugins. |
Posts | Create, update, delete, and query Wordpress Posts. |
Tags | Create, update, delete, and query Tags to associate with your posts. |
Users | Create, update, delete, and list the Users of the website. |
Create, update, delete, and query Categories to use for categorizing your posts.
The Sync App uses the WordPress API to process some of the filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Categories WHERE Parent = 0 SELECT * FROM Categories ORDER BY Id SELECT * FROM Categories WHERE Id IN ('130', '129')Also, ordering by Count, Description and Name, is handled by the WordPress API.
To insert a category the following column is required: Name.
INSERT INTO Categories (Description, Name, Parent) VALUES ('This is an example Category', 'myCategory', '138')
To update a category you must specify the following column: Id.
UPDATE Categories SET Name = 'updatedName', Description = 'Updated description.', Parent = 137 WHERE Id = '139'
To delete a category you must specify the following column: Id.
DELETE FROM Categories WHERE Id = '139'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
Unique identifier for the term. |
Count | Integer | True |
Number of published posts for the term. |
Description | String | False |
HTML description of the term. |
Link | String | True |
URL of the term. |
Name | String | False |
HTML title for the term. |
Taxonomy | String | True |
Type attribution for the term. |
Parent | Integer | False |
The parent term ID. |
Create, update, delete, and query Comments associated with a post.
The Sync App uses the WordPress API to process supported filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Comments WHERE Id = 61 SELECT * FROM Comments WHERE Id IN (61, 45) SELECT * FROM Comments WHERE AuthorEmail = '[email protected]' AND Status = 'approve' AND Type = 'comment' AND PostId = '1' SELECT * FROM Comments WHERE Author IN ('1', '2') SELECT * FROM Comments WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Comments WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Comments ORDER BY Date DESCAlso, ordering by Id, DateGMT, Type, Parent, is handled by the WordPress API.
To insert comments you must specify the following columns: PostId, Content.
INSERT INTO Comments (PostId, Content) VALUES ('1', 'This is a comment in the post with id 1.')
UPDATE Comments SET Content = 'Updated content' WHERE Id = '1234'Other fields that you can use on INSERT / UPDATE queries are: Author, AuthorEmail, AuthorIp, AuthorName, AuthorUrl, Content, Date, DateGMT, Parent, PostId, Status.
To delete a Comment you must specify the following column: Id.
DELETE FROM Comments WHERE Id = '1234'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
Unique identifier for the object. |
Author | Integer | False |
The ID of the user object, if author was a user. |
AuthorEmail | String | False |
Email address for the object author. |
AuthorIp | String | False |
IP address for the object author. |
AuthorName | String | False |
Display name for the object author. |
AuthorUrl | String | False |
URL for the object author. |
Date | Datetime | False |
The date the object was published. |
DateGMT | Datetime | False |
The date the object was published as GMT. |
Status | String | False |
State of the object. |
Type | String | True |
Type of Comment for the object. |
Parent | Integer | False |
The ID for the parent of the object. |
Content | String | False |
The content for the object. |
PostId | Integer | False |
The ID of the associated post object. |
Link | String | True |
URL to the object. |
Name | Type | Description |
Context | String |
Scope under which the request is made; determines fields present in response. 使用できる値は次のとおりです。view, edit, embed |
Create, update, delete, and query Media to attach in your posts.
The Sync App uses the WordPress API to process supported filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Media WHERE Id IN ('1176', '1175') SELECT * FROM Media WHERE Id = '1176' SELECT * FROM Media WHERE AuthorId IN (1, 2) SELECT * FROM Media WHERE MediaType = 'image' SELECT * FROM Media WHERE MimeType = 'image/jpeg' SELECT * FROM Media WHERE Status = 'Inherit' SELECT * FROM Media WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Media WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Media ORDER BY IdAlso, ordering by Date, Modified, and AuthorId is handled by the WordPress API.
To insert a media you must specify the following column: FileLocation.
INSERT INTO Media (Title, FileLocation, Caption) VALUES ('MediaTitle', 'C:/myImages/image.png', 'This is an uploaded media.')
To update a media you must specify the following column: Id.
UPDATE Media SET Title = 'Updated Title' WHERE Id = '4'Other fields that you can use on INSERT and UPDATE queries are: Date, DateGMT, Status, Title, AuthorId, CommentStatus, PingStatus, Caption, Description, PostId.
To delete a media you must specify the following column: Id.
DELETE FROM Media WHERE Id = '1234'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the object. |
Title | String | False |
The title for the object. |
Date | Datetime | False |
The date the object was published, in the site's timezone. |
DateGMT | Datetime | False |
The date the object was published, as GMT. |
Modified | Datetime | True |
The date the object was last modified, in the site's timezone. |
ModifiedGMT | Datetime | True |
The date the object was last modified, as GMT. |
Status | String | False |
A named status for the object. One of: inherit, private, trash. |
Type | String | True |
Type of Post for the object. |
AuthorId | Integer | False |
The ID for the author of the object. |
CommentStatus | String | False |
Whether or not comments are open on the object. |
PingStatus | String | False |
Whether or not the object can be pinged. |
Caption | String | False |
The attachment caption. |
Description | String | False |
The attachment description. |
MediaType | String | True |
Attachment type. |
MimeType | String | True |
The attachment MIME type. |
PostId | Integer | False |
The ID for the associated post of the attachment. |
SourceUrl | String | True |
URL to the original attachment file. |
Link | String | True |
URL to the object. |
Name | Type | Description |
FileLocation | String |
The location of the file to be uploaded. |
Create, update, delete, and query Wordpress Pages.
The Sync App uses the WordPress API to process supported filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Pages WHERE Id IN (1, 2) SELECT * FROM Pages WHERE Author IN ('1', '23') SELECT * FROM Pages WHERE Parent IN (0, 2) SELECT * FROM Pages WHERE Status = 'Publish' SELECT * FROM Pages WHERE MenuOrder = 1 SELECT * FROM Pages WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Pages WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Pages ORDER BY IdAlso, ordering by Author, Title, Date, Modified, Parent, MenuOrder, is handled by the WordPress API.
To insert a page, it's enough to specify one of the fields below:
INSERT INTO Pages (Title, Content, Status) VALUES ('A title', 'Some content here', 'publish')
To update a page you must specify the following column: Id.
UPDATE Pages SET Status = 'draft', Content = 'Updated content', Title = 'Updated title' WHERE Id = '12345'Other fields that you can use on INSERT and UPDATE queries are: Date, DateGMT, Status, Parent, Title, Content, Author, MediaId, CommentStatus, PingStatus, MenuOrder.
To delete a page you must specify the following column: Id.
DELETE FROM Pages WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the object. |
Author | Integer | False |
The ID for the author of the object. |
Title | String | False |
The title for the object. |
Date | Datetime | False |
The date the object was published, in the site's timezone. |
DateGMT | Datetime | False |
The date the object was published, as GMT. |
Link | String | True |
URL to the object. |
Modified | Datetime | False |
The date the object was last modified, in the site's timezone. |
ModifiedGMT | Datetime | False |
The date the object was last modified, as GMT. |
Status | String | False |
A named status for the object. One of: publish, future, draft, pending, private. |
Type | String | True |
Type of Post for the object. |
Parent | Integer | False |
The ID for the parent of the object. |
Content | String | False |
The content for the object. |
MediaId | Integer | False |
The ID of the featured media for the object. |
CommentStatus | String | False |
Whether or not comments are open on the object. |
PingStatus | String | False |
Whether or not the object can be pinged. |
MenuOrder | Integer | False |
The order of the object in relation to other object of its type. |
Create, update, delete, and query Plugins.
The Sync App uses the WordPress API to process supported filters. 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 refers to other columns will cause inconsistent data.
SELECT * FROM Plugins SELECT * FROM Plugins WHERE Plugin='hello-dolly/hello' SELECT * FROM Plugins WHERE Status='inactive' SELECT * FROM Plugins WHERE Context='edit'
To insert into Plugin, you must specify the Slug column.
INSERT INTO Plugins (Slug, Status) VALUES ('hello-dolly', 'active')
To update the Plugin you must specify the Plugin column.
UPDATE Plugins SET Status = 'inactive' WHERE Plugin = 'hello-dolly/hello'
To delete a Plugin you must specify the Plugin column.
DELETE FROM Plugins WHERE Plugin = 'hello-dolly/hello'
Name | Type | ReadOnly | Description |
Plugin [KEY] | String | True |
The plugin file. |
Name | String | True |
The plugin name. |
Author | String | True |
The plugin author. |
DescriptionRaw | String | True |
The plugin description. |
DescriptionRendered | String | True |
The plugin description. |
NetworkOnly | Boolean | True |
Whether the plugin can only be activated network-wide. |
RequiresPhp | String | True |
Minimum required version of PHP. |
RequiresWp | String | True |
Minimum required version of WordPress. |
Status | String | False |
The plugin activation status. 使用できる値は次のとおりです。inactive, active |
TextDomain | String | True |
The plugin's text domain. |
Version | String | True |
The plugin version number. |
AuthorUri | String | True |
Plugin author's website address. |
PluginUri | String | True |
The plugin's website address. |
Name | Type | Description |
Slug | String |
WordPress.org plugin directory slug. This column is required for Insert only and it is not included in the Select response. |
Context | String |
Scope under which the request is made; determines fields present in response. 使用できる値は次のとおりです。view, edit, embed |
Create, update, delete, and query Wordpress Posts.
The Sync App uses the WordPress API to process some of the filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Posts WHERE Id = 1 SELECT * FROM Posts WHERE Status = 'publish' AND Sticky = 'true' SELECT * FROM Posts WHERE Id IN (1, 21) SELECT * FROM Posts WHERE Author IN (1, 2) SELECT * FROM Posts WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Posts WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Posts ORDER BY TitleAlso, ordering by Id, Author, Date, Modified, is handled by the WordPress API.
To insert a post you must specify one of the following columns: Title, Content, and Excerpt.
INSERT INTO Posts (Title, status) VALUES ('New post', 'publish')
To create a post with custom taxonomy, you must specify the TaxonomyTerms(name:terms) in the below format.
INSERT INTO Posts (Title, Content, Status, TaxonomyTerms) VALUES ('The story of Dr Strange', 'This is the content', 'publish', 'books:2,5')"
To update a post you must specify the following column: Id.
UPDATE Posts SET Content = 'Updated content' WHERE Id = '12345'
To update the post with custom taxonomy, you must specify the TaxonomyTerms(name:terms) in the below format.
UPDATE Posts SET taxonomyterms = 'books:2,5' WHERE Id = '10'"Other fields that you can use on INSERT and UPDATE queries are the following: Date, DateGMT, Status, Excerpt, Title, Content, Author, MediaId, CommentStatus, PingStatus, Sticky, Categories, Tags and TaxonomyTerms.
To delete a post you must specify the following column: Id.
DELETE FROM Posts WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the object. |
Title | String | False |
The title for the object. |
CommentStatus | String | False |
Whether or not comments are open on the object. |
Categories | String | False |
Categories assigned to the post in comma separated values |
Tags | String | False |
Tags assigned to the post in comma separated values. |
Author | Integer | False |
The ID for the author of the object. |
Date | Datetime | False |
The date the object was published, in the site's timezone. |
DateGMT | Datetime | False |
The date the object was published, as GMT. |
Modified | Datetime | True |
The date the object was last modified, in the site's timezone. |
ModifiedGMT | Datetime | True |
The date the object was last modified, as GMT. |
Status | String | False |
A named status for the object. One of: publish, future, draft, pending, private. |
Type | String | True |
Type of Post for the object. |
Content | String | False |
The content for the object. |
Excerpt | String | False |
The excerpt for the object. |
PingStatus | String | False |
Whether or not the object can be pinged. |
Format | String | False |
The format for the object. |
Sticky | Boolean | False |
Whether or not the object should be treated as sticky. |
Url | String | True |
URL to the object. |
MediaId | Integer | False |
The ID of the featured media for the object. |
Name | Type | Description |
CategoriesFilter | String |
Accepts categories ids in CSV format. Filters only the posts that have at least one of the categories specified. |
TagsFilter | String |
Accepts tags ids in CSV format. Filters only the posts that have at least one of the tags specified. |
TaxonomyTerms | String |
Terms of the taxonomy that needs to be assigned to the post |
Context | String |
Scope under which the request is made; determines fields present in response. 使用できる値は次のとおりです。view, edit, embed |
Create, update, delete, and query Tags to associate with your posts.
The Sync App uses the WordPress API to process supported filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Tags WHERE Id NOT IN ('8', '9') SELECT * FROM Tags WHERE Id = 5 SELECT * FROM Tags ORDER BY IdAlso, ordering by Count, Description, and Name is handled by the WordPress API.
To insert a tag you must specify the following column: Name.
INSERT INTO Tags (Name, Description) VALUES ('MyTag', 'A tag')
To update a tag you must specify the following column: Id.
UPDATE Tags SET Name = 'Updated name', Description = 'Updated description' WHERE Id = '12345'
To delete a tag you must specify the following column: Id.
DELETE FROM Tags WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the term. |
Count | Integer | True |
Number of published posts for the term. |
Description | String | False |
HTML description of the term. |
Link | String | True |
URL of the term. |
Name | String | False |
HTML title for the term. |
Taxonomy | String | True |
Type attribution for the term. |
Create, update, delete, and list the Users of the website.
The Sync App uses the WordPress API to process supported filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
Only users that have published posts will be returned.
SELECT * FROM Users WHERE Id IN ('1', '23') SELECT * FROM Users WHERE Roles IN ('editor, administrator') SELECT * FROM Users ORDER BY EmailAlso, ordering by Id, Name, RegisteredDate, and Url is handled by the WordPress API.
To insert a user you must specify the following columns: Username, Email, and Password.
INSERT INTO Users (Username, Email, Password) VALUES ('DemoUser', '[email protected]', 'aPassword')
To update a user you must specify the following column: Id.
UPDATE Users SET name = 'First Last' WHERE Id = '12345'Other fields that you can use on INSERT and UPDATE queries are the following: Username, Name, FirstName, LastName, Email, Url, Description, Locale, Nickname, Roles.
To delete a user you must specify the following column: Id.
DELETE FROM Users WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the user. |
Username | String | False |
Login name for the user. |
Name | String | False |
Display name for the user. |
FirstName | String | False |
First name for the user. |
LastName | String | False |
Last name for the user. |
String | False |
The email address for the user. | |
Roles | String | False |
Roles assigned to the user. Use this with IN operator. |
Description | String | False |
Description of the user. |
Locale | String | False |
Locale for the user. |
Nickname | String | False |
The nickname for the user. |
RegisteredDate | Datetime | True |
Registration date for the user. |
Link | String | False |
Author URL of the user. |
Url | String | True |
URL of the user. |
Administrator | Boolean | True |
Whether or not the user is Administrator. |
EditPosts | Boolean | True |
Whether or not the user can edit posts. |
PublishPosts | Boolean | True |
Whether or not the user can publish posts. |
DeletePosts | Boolean | True |
Whether or not the user can delete posts. |
EditPages | Boolean | True |
Whether or not the user can edit pages. |
PublishPages | Boolean | True |
Whether or not the user can publish pages. |
DeletePages | Boolean | True |
Whether or not the user can delete pages. |
EditUsers | Boolean | True |
Whether or not the user can edit users. |
CreateUsers | Boolean | True |
Whether or not the user can create users. |
PromoteUsers | Boolean | True |
Whether or not the user can promote users. |
DeleteUsers | Boolean | True |
Whether or not the user can delete users. |
EditThemes | Boolean | True |
Whether or not the user can edit themes. |
UpdateThemes | Boolean | True |
Whether or not the user can update themes. |
InstallThemes | Boolean | True |
Whether or not the user can install themes. |
DeleteThemes | Boolean | True |
Whether or not the user can delete themes. |
SwitchThemes | Boolean | True |
Whether or not the user can switch themes. |
ActivatePlugins | Boolean | True |
Whether or not the user can activate plugins. |
UpdatePlugins | Boolean | True |
Whether or not the user can update plugins. |
EditPlugins | Boolean | True |
Whether or not the user can edit plugins. |
DeletePlugins | Boolean | True |
Whether or not the user can delete plugins. |
EditFiles | Boolean | True |
Whether or not the user can edit files. |
UploadFiles | Boolean | True |
Whether or not the user can upload files. |
ManageOptions | Boolean | True |
Whether or not the user can manage options. |
ManageCategories | Boolean | True |
Whether or not the user can manage categories. |
EditDashboard | Boolean | True |
Whether or not the user can edit dashboard. |
Name | Type | Description |
Password | String |
Password for the user (never included). |
Context | String |
Scope under which the request is made; determines fields present in response. 使用できる値は次のとおりです。view, edit, embed |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Taxonomies | List all the taxonomies. |
TaxonomyTerms | List all terms of the taxonomies. |
List all the taxonomies.
The Sync App uses the WordPress API to process some of the filters. 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 refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Taxonomies WHERE slug = 'books'
Name | Type | Description |
Hierarchical | Boolean | Whether or not the taxonomy should have children. |
Name | String | The title for the taxonomy. |
Slug [KEY] | String | An alphanumeric identifier for the taxonomy. |
RestBase | String | REST base route for the taxonomy. |
Description | String | A description of the taxonomy. |
Name | Type | Description |
Context | String | Scope under which the request is made; determines fields present in response.
使用できる値は次のとおりです。view, edit, embed |
List all terms of the taxonomies.
The Sync App uses the WordPress API to process some of the filters. 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 refers to other columns will cause inconsistent data. Note: Taxonomy is required to fetch TaxonomyTerms
For example, the following queries are processed server side.
SELECT * FROM TaxonomyTerms WHERE Taxonomy = 'books'
Name | Type | Description |
id | Integer | The id of the term in the taxonomy. |
Count | Integer | Count of it's presence. |
Link | String | Labels for the taxonomy for various contexts. |
Name | String | The title for the taxonomy term. |
Slug | String | An alphanumeric identifier for the taxonomy term. |
Taxonomy | String | Taxonomy in which this term is present |
Parent | Integer | The id of the parent taxonomy |
Description | String | A description of the taxonomy term. |
プロパティ | 説明 |
AuthScheme | Whether to use Basic Authentication or OAuth Authentication when connecting to Wordpress. Basic authentication is only supported over HTTPS. If using Basic authentication, the credentials will be sent as query parameters with every request. |
URL | The URL of your WordPress site. |
User | 認証で使用されるWordPress ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
プロパティ | 説明 |
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 です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Whether to use Basic Authentication or OAuth Authentication when connecting to Wordpress. Basic authentication is only supported over HTTPS. If using Basic authentication, the credentials will be sent as query parameters with every request. |
URL | The URL of your WordPress site. |
User | 認証で使用されるWordPress ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
Whether to use Basic Authentication or OAuth Authentication when connecting to Wordpress. Basic authentication is only supported over HTTPS. If using Basic authentication, the credentials will be sent as query parameters with every request.
The URL of your WordPress site.
The URL of your WordPress site. Required for both Basic and OAuth authentication.
このセクションでは、本プロバイダーの接続文字列で設定可能な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 はWordPress への接続を開き、プロキシを経由して通信が行われます。 |
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 です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Wordpress 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` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計または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 Categories WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。