List of the shop's articles.

Table-Specific Information

Select

The driver uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The driver processes other filters client-side within the driver.

• Id supports the '=, IN' comparison operators.
• AuthorName supports the '=, !=' comparison operators.
• BlogTitle supports the '=, !=' comparison operators.
• IsPublished supports the '=, !=' comparison operators.
• UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
• CreatedAt supports the '=, !=, <, >, >=, <=' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM Articles WHERE Id = 'Val1'
  SELECT * FROM Articles WHERE AuthorName = 'Val1'
  SELECT * FROM Articles WHERE BlogTitle = 'Val1'
  SELECT * FROM Articles WHERE IsPublished = true
  SELECT * FROM Articles WHERE UpdatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Articles WHERE CreatedAt = '2023-01-01 11:10:00'

Insert

The following columns can be used to create a new record:

Title, Body, Handle, Summary, Tags, TemplateSuffix, AuthorName, BlogId, BlogTitle, ImageAltText, ImageUrl, PublishedAt

The following pseudo-columns can be used to create a new record:

AuthorUserId, Metafields (references Metafields)

Metafields Temporary Table Columns

Column Name	Type	Description
Id	String	The unique ID of the metafield.
Namespace	String	A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.
Key	String	The name of the metafield.
Value	String	The information to be stored as metadata.
Type	String	The metafield's information type.

Update

The following columns can be updated:

Title, Body, Handle, Summary, Tags, TemplateSuffix, AuthorName, BlogId, BlogTitle, ImageAltText, ImageUrl, IsPublished, PublishedAt

The following pseudo-columns can be used to update a record:

AuthorUserId, RedirectNewHandle, Metafields (references Metafields)

Metafields Temporary Table Columns

Column Name	Type	Description
Id	String	The unique ID of the metafield.
Namespace	String	A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.
Key	String	The name of the metafield.
Value	String	The information to be stored as metadata.
Type	String	The metafield's information type.

Delete

You can delete entries by specifying the following column:

Id

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A globally-unique ID.
Title	String	False		The title of the article.
Body	String	False		The text of the article's body, complete with HTML markup.
Handle	String	False		A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL.
Summary	String	False		A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.
Tags	String	False		Tags are additional short descriptors.
TemplateSuffix	String	False		The name of the template an article is using if it's using an alternate template. If an article is using the default 'article. liquid' template, then the value returned is 'null'.
AuthorName	String	False		The author's full name.
BlogId	String	False		A globally-unique ID.
BlogTitle	String	False		The title of the blog.
ImageId	String	True		A unique ID for the image.
ImageAltText	String	False		A word or phrase to share the nature or contents of an image.
ImageUrl	String	False		The location of the image as a URL.
ImageWidth	Int	True		The original width of the image in pixels. Returns 'null' if the image isn't hosted by Shopify.
ImageHeight	Int	True		The original height of the image in pixels. Returns 'null' if the image isn't hosted by Shopify.
CommentsCount	Int	True		Count of comments.
CommentPrecision	String	True		The count's precision, or the exactness of the value.
IsPublished	Bool	False		Whether or not the article is visible.
PublishedAt	Datetime	False		The date and time when the article became or will become visible. Returns null when the article isn't visible.
UpdatedAt	Datetime	True		The date and time when the article was last updated.
CreatedAt	Datetime	True		The date and time when the article was created.

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.

Name	Type	Description
AuthorUserId	String	The ID of a staff member's account.
RedirectNewHandle	Bool	Whether a redirect is required after a new handle has been provided. If true, then the old handle is redirected to the new one automatically.
Metafields	String	The input fields to create or update a metafield.