Elastic Path Production Tools

Catalog Syndication Projections

Catalog Syndication Projections

In Elastic Path catalog syndication, a projection is a representation of data that is optimised for syndication users to consume.

A projection is needed to segregate catalog data from relational data. All entity projections reside in a single database table in the Elastic Path Commerce Manager schema.

The schema tables for catalog syndication are TCATALOGPROJECTIONS and TCATALOGHISTORY. Data in both tables are identical.

Catalog Projections Table

The TCATALOGPROJECTIONS table contains a row for each historical version.

Name Type Description
TYPE Varchar (64) The entity type, such as, offer.
STORE Varchar (64) The store code for the entity.
CODE Varchar (64) The unique ID of the projected entity.
VERSION Bigint The projection version number.

Note: Each row with the same TYPE, CODE, and STORE increments by one.

PROJECTION_DATE_TIME TIMESTAMP default CURRENT_TIMESTAMP The time and date the projection is created.

Note: This populates the modifiedDateTime field on projections.

DELETED Boolean/Bit/ Number(1) The deletion status of an entity. The options are:
  • 0: Specifies that the entity is not deleted.
  • 1: Specifies that the entity is deleted. If the entity is deleted, the CONTENT, HASH, and SCHEMA_VERSION columns are empty.
SCHEMA_VERSION Varchar (64) The schema version number for generating the projection.
CONTENT_HASH Varchar (256) The SHA-256 hash of the projection content.
CONTENT mediumtext/CLOB The contents of the projection, encoded as JSON.
DISABLE_DATE_TIME TIMESTAMP The timestamp to start a job to replace the projection with a tombstone projection.

Catalog History Table

The TCATALOGHISTORY table contains a row for each catalog entity.

Name Type Description
TYPE Varchar (64) The entity type, such as, offer.
STORE Varchar (64) The store code for the entity.
CODE Varchar (64) The unique ID of the projected entity.
VERSION Bigint The projection version number.

Note: Each time the projection updates, the version increments by one.

PROJECTION_DATE_TIME TIMESTAMP default CURRENT_TIMESTAMP The time and date the projection is created.

Note: This populates the modifiedDateTime field on projections.

DELETED Boolean/Bit/ Number(1) The deletion status of an entity. The options are:
  • 0: Specifies that the entity is not deleted.
  • 1: Specifies that the entity is deleted. If the entity is deleted, the CONTENT, HASH, and SCHEMA_VERSION columns are empty.
SCHEMA_VERSION Varchar (64) The schema version number for generating the projection.
CONTENT_HASH Varchar (256) The SHA-256 hash of the projection content.
CONTENT mediumtext/CLOB The contents of the projection, encoded as JSON.