convex-best-practices

Structure Convex backend functions by organizing them by domain rather than file type. This function organization pattern groups related queries and mutations together, ensuring your application remains maintainable as it scales.

Validate Convex arguments and return types using the convex/values module. Implementing robust argument and return type validation ensures type safety and prevents invalid data from entering your backend system.

Handle errors in a Convex application by employing ConvexError for clear, user-facing error reporting. This pattern ensures that validation failures and backend exceptions are communicated effectively without exposing internal implementation details.

Avoid write conflicts in Convex by implementing specific concurrency control patterns. Understanding and applying these patterns prevents data races when multiple users attempt to modify the same documents simultaneously.

Use indexes for Convex database queries to ensure efficient data retrieval. Optimized queries leverage indexes to scan only relevant documents, significantly improving backend performance as your dataset grows.

The Zen of Convex principles for production apps emphasize treating the schema as truth and utilizing reactive queries. Following these guidelines prevents common pitfalls and ensures your application is robust and scalable.