core-api-reference

Document API signatures for pgdbm database managers and transactions.

Updated Jul 28, 2025
One-click install
npx skills add https://github.com/juanre/pgdbm --skill core-api-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: core-api-reference
Source: https://github.com/juanre/pgdbm/tree/main/skills/core-api-reference
Command: npx skills add https://github.com/juanre/pgdbm --skill core-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive, ready-to-use API reference for pgdbm's core database managers, removing the need to search through code or docs when implementing features.

Core Features & Use Cases

  • Complete API surface for AsyncDatabaseManager, DatabaseConfig, and TransactionManager, including initialization, lifecycle, and transaction support.
  • Practical examples covering common workflows such as creating pools, running queries, and managing transactions.
  • Reference-driven learning enabling developers to implement, test, and integrate pgdbm with confidence across projects.

Quick Start

Reference the core-api-reference when wiring AsyncDatabaseManager, DatabaseConfig, and TransactionManager in your application.

Frequently Asked Questions about core-api-reference

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

FAQPage Schema
How do I initialize AsyncDatabaseManager and DatabaseConfig for PostgreSQL connections?

AsyncDatabaseManager initialization requires DatabaseConfig to specify connection parameters, pool size, and credentials. Pass the configured DatabaseConfig instance to AsyncDatabaseManager during setup to establish and manage your PostgreSQL connection pool.

What are the exact method signatures and parameters for running queries with pgdbm?

The core-api-reference documents complete method signatures, parameter types, and return values for AsyncDatabaseManager query methods. Reference it to understand argument requirements and response formats when executing queries against your database.

How do I manage transactions with TransactionManager in pgdbm?

TransactionManager provides methods to begin, commit, and rollback transactions. The API reference covers initialization, lifecycle management, and practical transaction workflows to ensure consistent database state across your application operations.

Can I use pgdbm's AsyncDatabaseManager for connection pooling in production applications?

AsyncDatabaseManager includes pool management capabilities for production use. The API reference details pool configuration, lifecycle control, and query execution patterns to support development, debugging, and integration at scale.

What's the difference between DatabaseConfig and AsyncDatabaseManager in pgdbm?

DatabaseConfig defines connection parameters and pool settings as configuration data. AsyncDatabaseManager consumes that config to initialize, manage, and execute queries against your database connection pool.

Where do I find example code for common pgdbm workflows?

The core-api-reference includes practical examples covering pool creation, query execution, and transaction management. Use these examples to implement, test, and integrate pgdbm managers with confidence in your projects.