Skip to content
unreal-orm-logo unreal-orm-logo unreal-orm
🚀 This documentation is for unreal-orm 1.0.0 alpha which requires SurrealDB 2.0 alpha SDK. For the stable version, see npm.

v0.6.0

This release enhances the query builder with comprehensive SurrealDB clause support, improves query syntax ordering, and adds extensive test coverage for advanced query features.

✨ Features

Section titled “✨ Features”

Query Builder Enhancements

Section titled “Query Builder Enhancements”

  • Complete SurrealDB clause support: Added support for all modern SurrealDB query clauses:

    • WITH INDEX and WITH NOINDEX for index control
    • SPLIT clause for field splitting operations
    • TIMEOUT clause for query timeout specification
    • PARALLEL clause for parallel query execution
    • TEMPFILES clause for temporary file usage
    • EXPLAIN clause for query plan analysis

  • Query syntax ordering: Reordered SelectQueryOptions interface properties to match SurrealDB’s official syntax order, improving developer experience and consistency.

  • Enhanced ORDER BY support: Added support for COLLATE and NUMERIC options in ORDER BY clauses with correct syntax positioning.

🛠️ Fixes

Section titled “🛠️ Fixes”

Query Builder

Section titled “Query Builder”

  • Fixed ‘only’ clause positioning: Corrected a bug where the ONLY clause was incorrectly positioned in the FROM clause and incorrectly parsed, ensuring proper single record query behavior.

  • Fixed SurrealQL clause ordering: Corrected the order of COLLATE and NUMERIC modifiers in ORDER BY clauses to appear before the sort direction (ASC/DESC), matching SurrealDB syntax requirements.

  • Improved type safety: Enhanced type assertions and boolean coercion in query result processing to prevent type-related issues.

  • Query builder refactoring: Extracted query building logic into focused helper functions for better maintainability while preserving all functionality:

    • buildSelectFromClause() for SELECT/FROM logic and RecordId binding
    • buildOrderByClause() for ORDER BY with collation/numeric options
    • buildQuery() for complete query assembly in correct SQL order
    • executeAndProcessQuery() for query execution and result processing

🧪 Tests

Section titled “🧪 Tests”

  • Comprehensive test coverage: Added extensive test coverage for all new query options including WITH, SPLIT, TIMEOUT, PARALLEL, TEMPFILES, and EXPLAIN clauses.

  • Query debugging tests: Added isolated test cases to identify and document query execution issues, particularly with the PARALLEL clause.

  • Enhanced query validation: Improved test assertions and error handling for complex query combinations.

📚 Documentation

Section titled “📚 Documentation”

  • Enhanced JSDoc: Updated function documentation to reflect new query capabilities and correct clause ordering.

  • Query examples: Added comprehensive examples demonstrating all supported SurrealDB query clauses and their proper usage.