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

OAuthClient Authentication

The user can use the client credential grant type to authenticate from either a Desktop application or the web. To enable this authscheme, set AuthScheme to OAuthClient.

Authentication by client credential grant type is similar to OAuth -- in fact, it requires that you have already set up a custom OAuth application, as described in Creating a Custom OAuth Application

To connect, set these properties:

InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the access token in the connection string.
AuthScheme: Set the AuthScheme to OAuthClient to perform authentication with the Client Credential grant type.
OAuthClientId: The Client Id specified in your custom OAuth application.
OAuthClientSecret: The Client Secret specified in your custom OAuth application.

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 supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

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

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

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.
Members	Create, update, delete, and list the Members of the website.
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. To retrieve and filter the values for AuthorEmail column, use context=edit in the WHERE clause. 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' and context='edit';
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. To retrieve and filter the values for this column, use context=edit in the WHERE clause.
AuthorIp	String	False	IP address for the object author. To retrieve the values for this column, use context=edit in the WHERE clause.
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. The allowed values are hold, approved, spam, trash.
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. Note : Status column only accepts the following values for select operation: inherit and private. 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 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

Note : Status column only accepts the following values for insert and update operations: publish, future, draft, pending, and private. 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	True	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.
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.

Members

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

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 Members WHERE Id = 10

Update

To update a member you must specify the following column: Id.

UPDATE Members SET Title = 'updatedName' WHERE Id = '139'

Delete

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

DELETE FROM Members WHERE Id = '139'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Unique identifier for the post
Date	Datetime	False	The date the post was created in the site's timezone
DateGMT	Datetime	False	Date in the GMT format
Slug	String	False	Slug Type
Status	String	False	A named status for the post
Title	Object	False	The title for the post
Link	String	False	Member link

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

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

The following queries are processed server side.

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

Insert

To insert into Plugins, 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 only required for INSERT 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	True	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. The allowed values are 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
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. To retrieve and filter the values for Roles column, use context=edit in the WHERE clause. 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') and context='edit'
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	True	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. To retrieve and filter the values for this column, use context=edit in the WHERE clause.
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	True	Author URL of the user.
Url	String	False	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. Use the slug values from the taxonomies view to retrieve the taxonomy column value.

For example, the following queries are processed server side.

SELECT * FROM TaxonomyTerms WHERE Taxonomy = 'books';
SELECT * from WordPress.taxonomyterms WHERE taxonomy in ('post_tag','Category');

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	Specifies the user ID of the authenticating WordPress user account.
Password	Specifies the password of the authenticating user account.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

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

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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	Specifies the user ID of the authenticating WordPress user account.
Password	Specifies the password of the authenticating user account.

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..
OAuthClient: Set this to perform OAuth authentication with Client Credentials grant type.

URL

The URL of your WordPress site.

Remarks

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

User

Specifies the user ID of the authenticating WordPress user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Password

Specifies the password of the authenticating user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

OAuth

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

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SSL

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

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

SSLServerCert

Specifies 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	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: 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.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to WordPress. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to WordPress. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to WordPress. If the SOCKS 5 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

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

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

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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 the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

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.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made 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 proxy server set in the ProxyServer connection property.

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, set ProxyAutoDetect to False.

Logging

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

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

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

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:


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

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may 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	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

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

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

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

OAuthClient 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

Members

Table Specific Information

SELECT

Update

Delete

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