home / skills / bankkroll / skills-builder / typeorm

typeorm skill

unsafe

This skill provides comprehensive TypeORM documentation to answer questions about data sources, entities, relations, migrations, and advanced features.

npx playbooks add skill bankkroll/skills-builder --skill typeorm

Review the files below or copy the command above to add this skill to your agents.

Files (13)

SKILL.md

3.1 KB

---
name: "typeorm"
description: "Scraped from https://typeorm.io/ Source: https://typeorm.io. Use when questions involve: docs."
---

# Typeorm

> Official documentation: https://typeorm.io

## Overview

This skill provides comprehensive documentation for typeorm.

**Total references:** 12 files (~72,647 tokens)

**Topics covered:**
Extending Schemas, Materialized Path aka Path Enumeration, Getting a count, Sync database schema, Column Types, Want community support, AddingHAVINGexpression, What is a DataSource, 5 Advanced optimization, Concrete Table Inheritance, Using Both Options Together, Other model settings...

## Reference Files

Load only the reference files relevant to the user's question:

### Docs

- **[Indices and more](references/docs-1.md)** (~7,991 tokens)
  - Topics: Column indices, Unique indices, Indices with multiple columns
- **[DataSource and more](references/docs-2.md)** (~7,317 tokens)
  - Topics: What is a DataSource, Creating a new DataSource, How to use DataSource
- **[MySQL / MariaDB and more](references/docs-3.md)** (~7,831 tokens)
  - Topics: Installation, Data Source Options, Column Types
- **[Entity Inheritance and more](references/docs-4.md)** (~4,832 tokens)
  - Topics: Concrete Table Inheritance, Single Table Inheritance, Using embeddeds
- **[Getting Started and more](references/docs-5.md)** (~7,863 tokens)
  - Topics: Features, Installation, Quick Start
- **[Migration from Sequelize to TypeORM and more](references/docs-6.md)** (~7,172 tokens)
  - Topics: Setting up a data source, Schema synchronization, Creating a models
- **[FAQ and more](references/docs-7.md)** (~7,738 tokens)
  - Topics: How do I update a database schema, How do I change a column name in the database, How can I set the default value to some function for exampleNOW
- **[Caching queries and more](references/docs-8.md)** (~2,298 tokens)
  - Topics: Delete, Soft-Delete, Restore-Soft-Delete
- **[Select using Query Builder and more](references/docs-9.md)** (~7,848 tokens)
  - Topics: What is a QueryBuilder, Important note when using theQueryBuilder, How to create and use a QueryBuilder
- **[Many and more](references/docs-10.md)** (~6,165 tokens)
  - Topics: How to create self referencing relation, How to use relation id without joining relation, How to load relations in entities
- **[Find Options and more](references/docs-11.md)** (~5,231 tokens)
  - Topics: Basic options, Advanced options, Combining Advanced Options

### General

- **[TypeORM and more](references/general.md)** (~361 tokens)
  - Topics: Elegant Type-Safe API, Supported Databases, Works Everywhere

## Usage Guidelines

1. **Identify relevant sections** - Match the user's question to the appropriate reference file(s)
2. **Load minimally** - Only read files directly relevant to the question to conserve context
3. **Cite sources** - Reference specific sections when answering
4. **Combine knowledge** - For complex questions, you may need multiple reference files

### When to use each reference:

- **Docs**: Docs-related features and documentation
- **General**: General documentation, overview, and getting started

Overview

This skill provides compact, searchable documentation and usage guidance for TypeORM features and APIs. It condenses key topics — data sources, entities, relations, query builder, migrations, indices, and column types — into practical guidance developers can apply quickly. The content is drawn from official TypeORM documentation and organized for fast lookup when answering docs-related questions.

How this skill works

The skill inspects common TypeORM documentation areas and extracts actionable instructions, examples, and configuration patterns. It maps user questions to relevant documentation sections (DataSource, Entities, Relations, QueryBuilder, Migrations, Find Options, indices, etc.) and returns concise, implementation-focused answers. For complex scenarios it synthesizes recommendations across multiple doc topics to produce step-by-step guidance.

When to use it

When a question asks how to configure or initialize a DataSource
When you need examples for entities, relations, or inheritance patterns
When troubleshooting QueryBuilder usage, advanced Find Options, or loading relations
When planning or running schema sync, migrations, or altering columns/indexes
When you need column type references, index definitions, or DB-specific options

Best practices

Prefer DataSource-based initialization for predictable connection management and migrations
Use explicit relations and proper eager/lazy loading to avoid N+1 queries; load relation ids when full joins are unnecessary
Keep schema changes in migrations for production; use schema sync only for development or prototyping
Define indices and unique constraints at the entity level for consistent DDL across environments
Use QueryBuilder for complex queries; use repository methods or Find Options for simple reads to keep code readable

Example use cases

Setting up a new DataSource for Postgres and running initial migrations
Modeling OneToMany/ManyToOne relations with explicit join columns and relation ids
Converting a Sequelize project to TypeORM-style entities and migrations
Creating composite indices or unique constraints on multiple columns for performance and data integrity
Using QueryBuilder to construct complex filtered joins with GROUP BY and HAVING

FAQ

How do I update the database schema safely in production?

Generate and run migrations rather than using schema synchronization. Test migrations in a staging environment and back up data before applying them.

When should I use QueryBuilder versus repository/find methods?

Use repository/find methods for straightforward queries and pagination. Use QueryBuilder for complex joins, aggregates, custom SQL fragments, or when you need fine-grained control over the generated SQL.