Establishing a Connection

Adding a Connection to WordPress

To add a connection to WordPress:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the WordPress icon is not available, click the Add More icon to download and install the WordPress connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to WordPress

At this time, CData Sync App only supports connecting to self-hosted WordPress instances. To connect to data, supply the Url to your wordpress site, and then authenticate as described below.

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:

Basic authentication, which is recommended for use in a testing environment; and
OAuth 2.0 authentication, which supports browser-based access from a Desktop application, Web application, or Headless Machine.

Basic Authentication

Basic authentication is recommended for testing environments only.

Before you configure WordPress to use Basic Authentication:

Ensure that your WordPress login has adminstrative privileges.
Know what version of WordPress is running at the local host. (WordPress 4.7 and later support the WordPress REST API natively; earlier versions require the use of a Basic Authentication plug-in to secure access to the REST API.)

To configure Basic Authentication:

Log into your WordPress host.
If you are running an earlier WordPress version than 4.7, install the REST API plugin.
Install the Basic Authentication plugin.
To create custom taxonomies, install the Simple Taxonomy Refreshed
If you prefer installing the plugins manually, extract the compressed folders to the wp-content\plugins folder and then enable the plugins via the WordPress admin interface.
Set the following connection properties:
- AuthScheme: Basic.
- Url: Your WordPress URL.
- User: Your username.
- Password: Your password.

You are now ready to connect.

OAuth 2.0 Authentication

For all non-testing environments, WordPress supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

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 Creating a Custom OAuth Application. 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:

Before connecting to data for the first time, set the following connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your application settings.
- OAuthClientSecret: The client secret in your application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: 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

Advanced Settings

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Advanced Features

This section details a selection of advanced features of the WordPress Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to WordPress and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Sync App models entities in the WordPress API as tables, views, and stored procedures. These are defined in schema files, which are configuration files that you can customize with a text editor.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Using Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to the WordPress APIs and then processes the rest of the query within the Sync App. The following sections document API limitations and requirements.

Tables

The Sync App models the data in WordPress as a list of tables in a relational database that can be queried using standard SQL statements.

WordPress Connector for CData Sync Tables


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.

Comments

Create, update, delete, and query Comments associated with a post.

Table Specific Information

Select

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 DESC

Also, ordering by Id, DateGMT, Type, Parent, is handled by the WordPress API.

Insert

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

To update a comment you must specify the following column: Id

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.

Delete

To delete a Comment you must specify the following column: Id.

DELETE FROM Comments WHERE Id = '1234'

Columns


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.

Pseudo-Columns

Name

Type

Description

Context

String

Scope under which the request is made; determines fields present in response.

The allowed values are view, edit, embed.

Media

Create, update, delete, and query Media to attach in your posts.

Table Specific Information

Select

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 Id

Also, ordering by Date, Modified, and AuthorId is handled by the WordPress API.

Insert and Update

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.

Delete

To delete a media you must specify the following column: Id.

DELETE FROM Media WHERE Id = '1234'

Columns


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.

Pseudo-Columns


Name	Type	Description
FileLocation	String	The location of the file to be uploaded.

Pages

Create, update, delete, and query Wordpress Pages.

Table Specific Information

Select

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 Id

Also, ordering by Author, Title, Date, Modified, Parent, MenuOrder, is handled by the WordPress API.

Insert and Update

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.

Delete

To delete a page you must specify the following column: Id.

DELETE FROM Pages WHERE Id = '12345'

Columns


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.

Plugins

Create, update, delete, and query Plugins.

Table Specific Information

Select

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.

Plugin supports the '='.
Status supports the '='.
Context supports the '='.

The following queries are processed server side.

SELECT * FROM Plugins
SELECT * FROM Plugins WHERE Plugin='hello-dolly/hello'
SELECT * FROM Plugins WHERE Status='inactive'
SELECT * FROM Plugins WHERE Context='edit'

Insert

To insert into Plugin, you must specify the Slug column.

INSERT INTO Plugins (Slug, Status) VALUES ('hello-dolly', 'active')

Update

To update the Plugin you must specify the Plugin column.

UPDATE Plugins SET Status = 'inactive' WHERE Plugin = 'hello-dolly/hello'

Delete

To delete a Plugin you must specify the Plugin column.

DELETE FROM Plugins WHERE Plugin = 'hello-dolly/hello'

Columns


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. The allowed values are 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.

Pseudo-Columns


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. The allowed values are view, edit, embed.

Posts

Create, update, delete, and query Wordpress Posts.

Table Specific Information

SELECT

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 Title

Also, ordering by Id, Author, Date, Modified, is handled by the WordPress API.

Insert and Update

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.

Delete

To delete a post you must specify the following column: Id.

DELETE FROM Posts WHERE Id = '12345'

Columns


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.

Pseudo-Columns


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. The allowed values are view, edit, embed.

Users

Create, update, delete, and list the Users of the website.

Table Specific Information

Select

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 Email

Also, ordering by Id, Name, RegisteredDate, and Url is handled by the WordPress API.

Insert and Update

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')

Update

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.

Delete

To delete a user you must specify the following column: Id.

DELETE FROM Users WHERE Id = '12345'

Columns


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.
Email	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.

Pseudo-Columns


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. The allowed values are view, edit, embed.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

WordPress Connector for CData Sync Views


Name	Description
Taxonomies	List all the taxonomies.
TaxonomyTerms	List all terms of the taxonomies.

Taxonomies

List all the taxonomies.

Table Specific Information

SELECT

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'

Columns


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.

Pseudo-Columns


Name	Type	Description
Context	String	Scope under which the request is made; determines fields present in response. The allowed values are view, edit, embed.

TaxonomyTerms

List all terms of the taxonomies.

Table Specific Information

SELECT

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'

Columns


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.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
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	The WordPress user account used to authenticate.
Password	The password used to authenticate the user.

OAuth

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

Schema

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
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	The WordPress user account used to authenticate.
Password	The password used to authenticate the user.

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.

Remarks

Basic: Set this to use Basic user / password authentication.
OAuth: Set this to perform OAuth authentication..

URL

The URL of your WordPress site.

Remarks

The URL of your WordPress site. Required for both Basic and OAuth authentication.

User

The WordPress user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the WordPress server.

Password

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to WordPress and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Wordpress Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

Each root element defines the name of a view.
Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

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

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

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

Note that the specified path is not embedded in quotation marks.

WordPress Connector for CData Sync

WordPress Connector for CData Sync

Overview

WordPress Version Support

Establishing a Connection

Adding a Connection to WordPress

Connecting to WordPress

Basic Authentication

OAuth 2.0 Authentication

Advanced Settings

Customizing the SSL Configuration

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Stored Procedures

Using Query Processing

Tables

WordPress Connector for CData Sync Tables

Categories

Table Specific Information

SELECT

Insert

Update

Delete

Columns

Comments

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Media

Table Specific Information

Select

Insert and Update

Delete

Columns

Pseudo-Columns

Pages

Table Specific Information

Select

Insert and Update

Delete

Columns

Plugins

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Posts

Table Specific Information

SELECT

Insert and Update

Delete

Columns

Pseudo-Columns

Tags

Table Specific Information

Select

Insert

Update

Delete