Skip to main content

getCategoriesBaseQuery

Get a base SelectQuery for querying categories with category descriptions joined.

Import​

import { getCategoriesBaseQuery } from "@evershop/evershop/catalog/services";

Syntax​

getCategoriesBaseQuery(): SelectQuery

Parameters​

None.

Return Value​

Returns a SelectQuery object with:

  • Base table: category
  • Left join: category_description on category_description_category_id = category_id

Examples​

Basic Usage​

import { getCategoriesBaseQuery } from "@evershop/evershop/catalog/services";

const query = getCategoriesBaseQuery();

// Load all active categories
const categories = await query
  .where('status', '=', 1)
  .execute(pool);

Get Single Category​

import { getCategoriesBaseQuery } from "@evershop/evershop/catalog/services";

const query = getCategoriesBaseQuery();

// Load category by URL key
const category = await query
  .where('url_key', '=', 'electronics')
  .load(pool);

console.log(category.name);
console.log(category.description);

See Also​