JDBC Driver for Magento

Build 22.0.8462

ProductCategories

ProductCategories is an auto generated table

Select

The CategoryId_p column can be used to filter data within this table. The CategoryId_p can be used only with the equals (=) operator.

The driver will use the Magento API to filter the results by CategoryId_p while the rest of the filter is executed client side within the driver.

The following examples show the types of queries processed server side.

  • Retrieve all product categories:
    SELECT * FROM ProductCategories
  • Retrieve detailed information about a single product category:
    SELECT * FROM ProductCategories WHERE Id = 1
You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns will cause an error.

Insert

The Name and IsActive columns are required to create a new category.

INSERT INTO ProductCategories(Name, IsActive, Position) VALUES ('New category', '1', '0')

Update

To update a category, you must set the Id column.

UPDATE ProductCategories SET Name = 'New category', IsActive = 1 WHERE Id = 1

Delete

Product categories can be deleted by providing the Id column.

DELETE FROM ProductCategories WHERE Id = 1

Columns

Name Type ReadOnly Description
Id [KEY] Int False

This is an auto-generated column

AvailableSortBy String False

This is an auto-generated column

Children String False

This is an auto-generated column

CreatedAt Datetime False

This is an auto-generated column

ExtensionAttributes String False

This is an auto-generated column

IncludeInMenu Bool False

This is an auto-generated column

IsActive Bool False

Whether category is active

Level Int False

Category level

Name String False

Category name

ParentId Int False

Parent category ID

Path String False

This is an auto-generated column

Position Int False

Category position

UpdatedAt Datetime False

This is an auto-generated column

ChildrenData String False

This is an auto-generated column

ProductCount Int False

Product count

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CategoryId_p Int

This is an auto-generated column

Id_p String

This is an auto-generated column

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462