CData Cloud offers access to WordPress across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to WordPress through CData Cloud.
CData Cloud allows you to standardize and configure connections to WordPress as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to WordPress in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to WordPress and configure any necessary connection properties to create a database in CData Cloud
Accessing data from WordPress through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to WordPress by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Supply the URL in its full form. For example, if your site is hosted at http://localhost/wp/wordpress', the URL should be http://localhost/wp/wordpress, and not 'htpp://localhost'. Failure to supply the URL in its full form results in a 'site not found' error.
WordPress supports two types of authentication:
Before you configure WordPress to use Basic Authentication:
To configure Basic Authentication:
You are now ready to connect.
The following subsections describe how to authenticate to WordPress from three common authentication flows. For information about how to create a custom OAuth application, see 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 Cloud automatically refresh the OAuth access token, do the following:
By default, the Cloud 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.
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.
Set the following properties:
By default, the Cloud 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.
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.
Set the following properties:
The CData Cloud 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 are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
The Cloud offloads as much of the SELECT statement processing as possible to the WordPress APIs and then processes the rest of the query within the Cloud. The following sections document API limitations and requirements.
The Cloud models the data in WordPress as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
Categories | Create, update, delete, and query Categories to use for categorizing your posts. |
Comments | Create, update, delete, and query Comments associated with a post. |
Media | Create, update, delete, and query Media to attach in your posts. |
Pages | Create, update, delete, and query Wordpress Pages. |
Plugins | Create, update, delete, and query Plugins. |
Posts | Create, update, delete, and query Wordpress Posts. |
Tags | Create, update, delete, and query Tags to associate with your posts. |
Users | Create, update, delete, and list the Users of the website. |
Create, update, delete, and query Categories to use for categorizing your posts.
The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Categories WHERE Parent = 0 SELECT * FROM Categories ORDER BY Id SELECT * FROM Categories WHERE Id IN ('130', '129')Also, ordering by Count, Description and Name, is handled by the WordPress API.
To insert a category the following column is required: Name.
INSERT INTO Categories (Description, Name, Parent) VALUES ('This is an example Category', 'myCategory', '138')
To update a category you must specify the following column: Id.
UPDATE Categories SET Name = 'updatedName', Description = 'Updated description.', Parent = 137 WHERE Id = '139'
To delete a category you must specify the following column: Id.
DELETE FROM Categories WHERE Id = '139'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
Unique identifier for the term. |
Count | Integer | True |
Number of published posts for the term. |
Description | String | False |
HTML description of the term. |
Link | String | True |
URL of the term. |
Name | String | False |
HTML title for the term. |
Taxonomy | String | True |
Type attribution for the term. |
Parent | Integer | False |
The parent term ID. |
Create, update, delete, and query Comments associated with a post.
The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Comments WHERE Id = 61 SELECT * FROM Comments WHERE Id IN (61, 45) SELECT * FROM Comments WHERE AuthorEmail = '[email protected]' AND Status = 'approve' AND Type = 'comment' AND PostId = '1' SELECT * FROM Comments WHERE Author IN ('1', '2') SELECT * FROM Comments WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Comments WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Comments ORDER BY Date DESCAlso, ordering by Id, DateGMT, Type, Parent, is handled by the WordPress API.
To insert comments you must specify the following columns: PostId, Content.
INSERT INTO Comments (PostId, Content) VALUES ('1', 'This is a comment in the post with id 1.')
UPDATE Comments SET Content = 'Updated content' WHERE Id = '1234'Other fields that you can use on INSERT / UPDATE queries are: Author, AuthorEmail, AuthorIp, AuthorName, AuthorUrl, Content, Date, DateGMT, Parent, PostId, Status.
To delete a Comment you must specify the following column: Id.
DELETE FROM Comments WHERE Id = '1234'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
Unique identifier for the object. |
Author | Integer | False |
The ID of the user object, if author was a user. |
AuthorEmail | String | False |
Email address for the object author. |
AuthorIp | String | False |
IP address for the object author. |
AuthorName | String | False |
Display name for the object author. |
AuthorUrl | String | False |
URL for the object author. |
Date | Datetime | False |
The date the object was published. |
DateGMT | Datetime | False |
The date the object was published as GMT. |
Status | String | False |
State of the object. |
Type | String | True |
Type of Comment for the object. |
Parent | Integer | False |
The ID for the parent of the object. |
Content | String | False |
The content for the object. |
PostId | Integer | False |
The ID of the associated post object. |
Link | String | True |
URL to the object. |
Name | Type | Description |
Context | String |
Scope under which the request is made; determines fields present in response. The allowed values are view, edit, embed. |
Create, update, delete, and query Media to attach in your posts.
The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Media WHERE Id IN ('1176', '1175') SELECT * FROM Media WHERE Id = '1176' SELECT * FROM Media WHERE AuthorId IN (1, 2) SELECT * FROM Media WHERE MediaType = 'image' SELECT * FROM Media WHERE MimeType = 'image/jpeg' SELECT * FROM Media WHERE Status = 'Inherit' SELECT * FROM Media WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Media WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Media ORDER BY IdAlso, ordering by Date, Modified, and AuthorId is handled by the WordPress API.
To insert a media you must specify the following column: FileLocation.
INSERT INTO Media (Title, FileLocation, Caption) VALUES ('MediaTitle', 'C:/myImages/image.png', 'This is an uploaded media.')
To update a media you must specify the following column: Id.
UPDATE Media SET Title = 'Updated Title' WHERE Id = '4'Other fields that you can use on INSERT and UPDATE queries are: Date, DateGMT, Status, Title, AuthorId, CommentStatus, PingStatus, Caption, Description, PostId.
To delete a media you must specify the following column: Id.
DELETE FROM Media WHERE Id = '1234'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the object. |
Title | String | False |
The title for the object. |
Date | Datetime | False |
The date the object was published, in the site's timezone. |
DateGMT | Datetime | False |
The date the object was published, as GMT. |
Modified | Datetime | True |
The date the object was last modified, in the site's timezone. |
ModifiedGMT | Datetime | True |
The date the object was last modified, as GMT. |
Status | String | False |
A named status for the object. One of: inherit, private, trash. |
Type | String | True |
Type of Post for the object. |
AuthorId | Integer | False |
The ID for the author of the object. |
CommentStatus | String | False |
Whether or not comments are open on the object. |
PingStatus | String | False |
Whether or not the object can be pinged. |
Caption | String | False |
The attachment caption. |
Description | String | False |
The attachment description. |
MediaType | String | True |
Attachment type. |
MimeType | String | True |
The attachment MIME type. |
PostId | Integer | False |
The ID for the associated post of the attachment. |
SourceUrl | String | True |
URL to the original attachment file. |
Link | String | True |
URL to the object. |
Name | Type | Description |
FileLocation | String |
The location of the file to be uploaded. |
Create, update, delete, and query Wordpress Pages.
The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Pages WHERE Id IN (1, 2) SELECT * FROM Pages WHERE Author IN ('1', '23') SELECT * FROM Pages WHERE Parent IN (0, 2) SELECT * FROM Pages WHERE Status = 'Publish' SELECT * FROM Pages WHERE MenuOrder = 1 SELECT * FROM Pages WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Pages WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Pages ORDER BY IdAlso, ordering by Author, Title, Date, Modified, Parent, MenuOrder, is handled by the WordPress API.
To insert a page, it's enough to specify one of the fields below:
INSERT INTO Pages (Title, Content, Status) VALUES ('A title', 'Some content here', 'publish')
To update a page you must specify the following column: Id.
UPDATE Pages SET Status = 'draft', Content = 'Updated content', Title = 'Updated title' WHERE Id = '12345'Other fields that you can use on INSERT and UPDATE queries are: Date, DateGMT, Status, Parent, Title, Content, Author, MediaId, CommentStatus, PingStatus, MenuOrder.
To delete a page you must specify the following column: Id.
DELETE FROM Pages WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the object. |
Author | Integer | False |
The ID for the author of the object. |
Title | String | False |
The title for the object. |
Date | Datetime | False |
The date the object was published, in the site's timezone. |
DateGMT | Datetime | False |
The date the object was published, as GMT. |
Link | String | True |
URL to the object. |
Modified | Datetime | False |
The date the object was last modified, in the site's timezone. |
ModifiedGMT | Datetime | False |
The date the object was last modified, as GMT. |
Status | String | False |
A named status for the object. One of: publish, future, draft, pending, private. |
Type | String | True |
Type of Post for the object. |
Parent | Integer | False |
The ID for the parent of the object. |
Content | String | False |
The content for the object. |
MediaId | Integer | False |
The ID of the featured media for the object. |
CommentStatus | String | False |
Whether or not comments are open on the object. |
PingStatus | String | False |
Whether or not the object can be pinged. |
MenuOrder | Integer | False |
The order of the object in relation to other object of its type. |
Create, update, delete, and query Plugins.
The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Plugins SELECT * FROM Plugins WHERE Plugin='hello-dolly/hello' SELECT * FROM Plugins WHERE Status='inactive' SELECT * FROM Plugins WHERE Context='edit'
To insert into Plugin, you must specify the Slug column.
INSERT INTO Plugins (Slug, Status) VALUES ('hello-dolly', 'active')
To update the Plugin you must specify the Plugin column.
UPDATE Plugins SET Status = 'inactive' WHERE Plugin = 'hello-dolly/hello'
To delete a Plugin you must specify the Plugin column.
DELETE FROM Plugins WHERE Plugin = 'hello-dolly/hello'
Name | Type | ReadOnly | Description |
Plugin [KEY] | String | True |
The plugin file. |
Name | String | True |
The plugin name. |
Author | String | True |
The plugin author. |
DescriptionRaw | String | True |
The plugin description. |
DescriptionRendered | String | True |
The plugin description. |
NetworkOnly | Boolean | True |
Whether the plugin can only be activated network-wide. |
RequiresPhp | String | True |
Minimum required version of PHP. |
RequiresWp | String | True |
Minimum required version of WordPress. |
Status | String | False |
The plugin activation status. 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. |
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. |
Create, update, delete, and query Wordpress Posts.
The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Posts WHERE Id = 1 SELECT * FROM Posts WHERE Status = 'publish' AND Sticky = 'true' SELECT * FROM Posts WHERE Id IN (1, 21) SELECT * FROM Posts WHERE Author IN (1, 2) SELECT * FROM Posts WHERE Date < '2018-02-02T02:02:23' SELECT * FROM Posts WHERE Date > '2018-02-02T02:02:23' SELECT * FROM Posts ORDER BY TitleAlso, ordering by Id, Author, Date, Modified, is handled by the WordPress API.
To insert a post you must specify one of the following columns: Title, Content, and Excerpt.
INSERT INTO Posts (Title, status) VALUES ('New post', 'publish')
To create a post with custom taxonomy, you must specify the TaxonomyTerms(name:terms) in the below format.
INSERT INTO Posts (Title, Content, Status, TaxonomyTerms) VALUES ('The story of Dr Strange', 'This is the content', 'publish', 'books:2,5')"
To update a post you must specify the following column: Id.
UPDATE Posts SET Content = 'Updated content' WHERE Id = '12345'
To update the post with custom taxonomy, you must specify the TaxonomyTerms(name:terms) in the below format.
UPDATE Posts SET taxonomyterms = 'books:2,5' WHERE Id = '10'"Other fields that you can use on INSERT and UPDATE queries are the following: Date, DateGMT, Status, Excerpt, Title, Content, Author, MediaId, CommentStatus, PingStatus, Sticky, Categories, Tags and TaxonomyTerms.
To delete a post you must specify the following column: Id.
DELETE FROM Posts WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the object. |
Title | String | False |
The title for the object. |
CommentStatus | String | False |
Whether or not comments are open on the object. |
Categories | String | False |
Categories assigned to the post in comma separated values |
Tags | String | False |
Tags assigned to the post in comma separated values. |
Author | Integer | False |
The ID for the author of the object. |
Date | Datetime | False |
The date the object was published, in the site's timezone. |
DateGMT | Datetime | False |
The date the object was published, as GMT. |
Modified | Datetime | True |
The date the object was last modified, in the site's timezone. |
ModifiedGMT | Datetime | True |
The date the object was last modified, as GMT. |
Status | String | False |
A named status for the object. One of: publish, future, draft, pending, private. |
Type | String | True |
Type of Post for the object. |
Content | String | False |
The content for the object. |
Excerpt | String | False |
The excerpt for the object. |
PingStatus | String | False |
Whether or not the object can be pinged. |
Format | String | False |
The format for the object. |
Sticky | Boolean | False |
Whether or not the object should be treated as sticky. |
Url | String | True |
URL to the object. |
MediaId | Integer | False |
The ID of the featured media for the object. |
Name | Type | Description |
CategoriesFilter | String |
Accepts categories ids in CSV format. Filters only the posts that have at least one of the categories specified. |
TagsFilter | String |
Accepts tags ids in CSV format. Filters only the posts that have at least one of the tags specified. |
TaxonomyTerms | String |
Terms of the taxonomy that needs to be assigned to the post |
Context | String |
Scope under which the request is made; determines fields present in response. The allowed values are view, edit, embed. |
Create, update, delete, and query Tags to associate with your posts.
The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Tags WHERE Id NOT IN ('8', '9') SELECT * FROM Tags WHERE Id = 5 SELECT * FROM Tags ORDER BY IdAlso, ordering by Count, Description, and Name is handled by the WordPress API.
To insert a tag you must specify the following column: Name.
INSERT INTO Tags (Name, Description) VALUES ('MyTag', 'A tag')
To update a tag you must specify the following column: Id.
UPDATE Tags SET Name = 'Updated name', Description = 'Updated description' WHERE Id = '12345'
To delete a tag you must specify the following column: Id.
DELETE FROM Tags WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the term. |
Count | Integer | True |
Number of published posts for the term. |
Description | String | False |
HTML description of the term. |
Link | String | True |
URL of the term. |
Name | String | False |
HTML title for the term. |
Taxonomy | String | True |
Type attribution for the term. |
Create, update, delete, and list the Users of the website.
The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
Only users that have published posts will be returned.
SELECT * FROM Users WHERE Id IN ('1', '23') SELECT * FROM Users WHERE Roles IN ('editor, administrator') SELECT * FROM Users ORDER BY EmailAlso, ordering by Id, Name, RegisteredDate, and Url is handled by the WordPress API.
To insert a user you must specify the following columns: Username, Email, and Password.
INSERT INTO Users (Username, Email, Password) VALUES ('DemoUser', '[email protected]', 'aPassword')
To update a user you must specify the following column: Id.
UPDATE Users SET name = 'First Last' WHERE Id = '12345'Other fields that you can use on INSERT and UPDATE queries are the following: Username, Name, FirstName, LastName, Email, Url, Description, Locale, Nickname, Roles.
To delete a user you must specify the following column: Id.
DELETE FROM Users WHERE Id = '12345'
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
Unique identifier for the user. |
Username | String | False |
Login name for the user. |
Name | String | False |
Display name for the user. |
FirstName | String | False |
First name for the user. |
LastName | String | False |
Last name for the user. |
String | False |
The email address for the user. | |
Roles | String | False |
Roles assigned to the user. Use this with IN operator. |
Description | String | False |
Description of the user. |
Locale | String | False |
Locale for the user. |
Nickname | String | False |
The nickname for the user. |
RegisteredDate | Datetime | True |
Registration date for the user. |
Link | String | False |
Author URL of the user. |
Url | String | True |
URL of the user. |
Administrator | Boolean | True |
Whether or not the user is Administrator. |
EditPosts | Boolean | True |
Whether or not the user can edit posts. |
PublishPosts | Boolean | True |
Whether or not the user can publish posts. |
DeletePosts | Boolean | True |
Whether or not the user can delete posts. |
EditPages | Boolean | True |
Whether or not the user can edit pages. |
PublishPages | Boolean | True |
Whether or not the user can publish pages. |
DeletePages | Boolean | True |
Whether or not the user can delete pages. |
EditUsers | Boolean | True |
Whether or not the user can edit users. |
CreateUsers | Boolean | True |
Whether or not the user can create users. |
PromoteUsers | Boolean | True |
Whether or not the user can promote users. |
DeleteUsers | Boolean | True |
Whether or not the user can delete users. |
EditThemes | Boolean | True |
Whether or not the user can edit themes. |
UpdateThemes | Boolean | True |
Whether or not the user can update themes. |
InstallThemes | Boolean | True |
Whether or not the user can install themes. |
DeleteThemes | Boolean | True |
Whether or not the user can delete themes. |
SwitchThemes | Boolean | True |
Whether or not the user can switch themes. |
ActivatePlugins | Boolean | True |
Whether or not the user can activate plugins. |
UpdatePlugins | Boolean | True |
Whether or not the user can update plugins. |
EditPlugins | Boolean | True |
Whether or not the user can edit plugins. |
DeletePlugins | Boolean | True |
Whether or not the user can delete plugins. |
EditFiles | Boolean | True |
Whether or not the user can edit files. |
UploadFiles | Boolean | True |
Whether or not the user can upload files. |
ManageOptions | Boolean | True |
Whether or not the user can manage options. |
ManageCategories | Boolean | True |
Whether or not the user can manage categories. |
EditDashboard | Boolean | True |
Whether or not the user can edit dashboard. |
Name | Type | Description |
Password | String |
Password for the user (never included). |
Context | String |
Scope under which the request is made; determines fields present in response. The allowed values are view, edit, embed. |
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.
Name | Description |
Taxonomies | List all the taxonomies. |
TaxonomyTerms | List all terms of the taxonomies. |
List all the taxonomies.
The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
For example, the following queries are processed server side.
SELECT * FROM Taxonomies WHERE slug = 'books'
Name | Type | Description |
Hierarchical | Boolean | Whether or not the taxonomy should have children. |
Name | String | The title for the taxonomy. |
Slug [KEY] | String | An alphanumeric identifier for the taxonomy. |
RestBase | String | REST base route for the taxonomy. |
Description | String | A description of the taxonomy. |
Name | Type | Description |
Context | String | Scope under which the request is made; determines fields present in response.
The allowed values are view, edit, embed. |
List all terms of the taxonomies.
The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. Note: Taxonomy is required to fetch TaxonomyTerms
For example, the following queries are processed server side.
SELECT * FROM TaxonomyTerms WHERE Taxonomy = 'books'
Name | Type | Description |
id | Integer | The id of the term in the taxonomy. |
Count | Integer | Count of it's presence. |
Link | String | Labels for the taxonomy for various contexts. |
Name | String | The title for the taxonomy term. |
Slug | String | An alphanumeric identifier for the taxonomy term. |
Taxonomy | String | Taxonomy in which this term is present |
Parent | Integer | The id of the parent taxonomy |
Description | String | A description of the taxonomy term. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with WordPress.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from WordPress, along with an indication of whether the procedure succeeded or failed.
Name | Description |
UpdateSettings | Updates the settings of the website. |
Updates the settings of the website.
Call this procedure to update settings. For example:
EXECUTE UpdateSettings Title = 'New Title!'
Name | Type | Description |
Title | String | Site title. |
Description | String | Site description. |
Url | String | Site URL. |
String | This address is used for admin purposes. If you change this you will get an email at your new address to confirm it. The new address will not become active until confirmed. | |
Timezone | String | A city in the same timezone as you. |
DateFormat | String | A date format for all date strings. |
TimeFormat | String | A time format for all time strings. |
Language | String | WordPress locale code. |
UseSmilies | Boolean | Convert emoticons like :-) and :-P to graphics on display. |
DefaultCategory | Integer | Default category. |
DefaultPostFormat | String | Default post format. |
PostsPerPage | Integer | Blog pages show at most. |
DefaultPingStatus | String | Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. |
DefaultCommentStatus | String | Allow people to post comments on new articles. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for WordPress:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Categories table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Categories'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Categories table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Categories'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:wordpress:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | Whether outer joins are supported. | YES, NO |
SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated Id returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
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.
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. |
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. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
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. |
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. |
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. |
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.
string
"Basic"
The URL of your WordPress site.
string
""
The URL of your WordPress site. Required for both Basic and OAuth authentication.
The WordPress user account used to authenticate.
string
""
Together with Password, this field is used to authenticate against the WordPress server.
The password used to authenticate the user.
string
""
The User and Password are together used to authenticate with the server.
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. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
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.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
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.
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. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
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.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
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. |
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. |
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
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, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
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 Cloud throws an exception.