sequelize_skill

Overview

This skill provides concise, actionable documentation and examples from Sequelize v6. It helps developers find authoritative guidance on associations, model definitions, querying, transactions, and less common topics like paranoid models and custom naming strategies. Use it to quickly locate patterns, options, and best practices from the official docs.

How this skill works

The skill inspects the official Sequelize v6 documentation and surfaces relevant sections for a given question. It maps user queries to focused reference areas (advanced associations, core concepts, transactions, etc.) and returns distilled explanations, examples, and recommended options. It favors minimal, practical guidance and points to the appropriate doc topics for deeper reading.

When to use it

• You need concrete examples for One-To-One, One-To-Many, or Many-To-Many associations.
• You want correct usage patterns for eager loading, aliases, or through tables.
• You’re designing models and need guidance on paranoid, underscored, or custom table names.
• You must implement managed or unmanaged transactions with Sequelize.
• You need querying examples: findOne, findAll, attribute selection, limits, and pagination.
• You want platform-specific tips (e.g., PostgreSQL ranges, AWS Lambda usage) and edge-case patterns.

Best practices

• Define associations explicitly in models and keep association setup centralized for clarity.
• Use aliases and scoped includes when loading multiple relationships to avoid naming collisions.
• Prefer managed transactions for simple flows and unmanaged transactions for advanced control.
• Use paranoid models only when soft-deletes are required; index frequently queried columns for performance.
• Apply constraints and foreign keys where the database should enforce integrity; use validations for application-level checks.

Example use cases

• Implementing a Many-To-Many relationship with a through table that stores extra attributes.
• Eager loading nested associations with includes and custom aliases to fetch related data in one query.
• Switching an existing table to paranoid mode to preserve deleted rows without changing application logic.
• Handling transactions across several model updates with a managed transaction pattern.
• Customizing naming strategy (underscored, singular/plural) to match an existing database schema.