webiny-api-db-catalog

Catalogs six database abstractions from the Webiny api/db layer with import paths and source locations.

8.0k|673|Updated Jan 9, 2018
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-db-catalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webiny-api-db-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/db
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-db-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with the Webiny framework often struggle to locate the correct database abstraction and its exact import path across the api/db layer, leading to wasted time searching source files.

Core Features & Use Cases

  • Abstraction Catalog: Lists six database abstractions including DbRegistry, DynamoDBClient, FilterUtil, and ValueFilter with exact import statements.
  • Source Mapping: Maps each abstraction to its source file location in @webiny/db and @webiny/db-dynamodb packages.
  • Use Case: When building a custom Webiny use case that needs DynamoDB filtering, look up FilterUtil in the catalog, read its source file for the exact interface, and import it directly into your feature code.

Quick Start

Ask the AI to show the import path and source file for the DynamoDBClient abstraction from the Webiny api/db catalog.

Frequently Asked Questions about webiny-api-db-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I import database abstractions in Webiny?

Import database abstractions using the pattern import { Name } from "webiny/api/db". The catalog lists six abstractions including DbRegistry, DynamoDBClient, and FilterUtil, each with its exact import statement and source file location.

What database abstractions does the Webiny api/db layer provide?

The api/db layer provides six abstractions: DbRegistry, DbRegistryFeature, DynamoDBClient, FilterUtil, ValueFilter, and ValueFilterRegistry. These come from the @webiny/db and @webiny/db-dynamodb packages.

Does Webiny support DynamoDB filtering utilities?

Yes, Webiny provides FilterUtil, ValueFilter, and ValueFilterRegistry from the @webiny/db-dynamodb package. Read the source files at @webiny/db-dynamodb/feature/FilterUtil and ValueFilter to get the exact interfaces before use.

When should I read the source file instead of just importing?

Always read the source file before importing to get the exact interface and types, since the catalog only provides names and locations. This prevents type errors when implementing use cases or event handlers.