|
1 | 1 | # Table of contents |
2 | 2 |
|
3 | | -- [README](README.md) |
4 | | -- [Introduction](introduction.md) |
| 3 | +- [CQL Documentation](README.md) |
5 | 4 | - [Installation](installation.md) |
6 | | -- [Quick Reference](reference-and-utilities/quick-reference.md) |
7 | | - |
8 | | -## Foundation |
9 | | - |
10 | | -- [Core Concepts Overview](foundation/core-concepts.md) |
11 | | -- [Schema Definition](foundation/schemas.md) |
12 | | -- [Database Initialization](foundation/initializing-the-database.md) |
13 | | -- [Schema Alterations](foundation/altering-the-schema.md) |
14 | | -- [Migrations](foundation/migrations.md) |
15 | | -- [CRUD Operations](foundation/crud-operations/README.md) |
16 | | - - [Creating Records](foundation/crud-operations/creating-records.md) |
17 | | - - [Reading Records](foundation/crud-operations/reading-records.md) |
18 | | - - [Updating Records](foundation/crud-operations/updating-records.md) |
19 | | - - [Deleting Records](foundation/crud-operations/deleting-records.md) |
20 | | -- [Design Patterns](foundation/patterns/README.md) |
21 | | - - [Active Record Pattern](foundation/patterns/active-record.md) |
22 | | - - [Entity Framework Pattern](foundation/patterns/entity-framework.md) |
23 | | - - [Repository Pattern](foundation/patterns/repository.md) |
24 | | - |
25 | | -## Getting Started |
26 | | - |
27 | | -- [Getting Started Guide](getting-started/getting-started.md) |
28 | | -- [Guides Overview](getting-started/guides.md) |
29 | | -- [Configuration](getting-started/configuration.md) |
30 | | -- [Architecture Overview](getting-started/architecture-overview.md) |
31 | | -- [Best Practices](getting-started/best-practices.md) |
32 | | -- [Feature Comparison](getting-started/feature-comparison.md) |
33 | | - |
34 | | -## Active Record with CQL |
35 | | - |
36 | | -- [Active Record Overview](active-record-with-cql/active-record-with-cql.md) |
37 | | -- [Defining Models](active-record-with-cql/defining-models.md) |
38 | | -- [CRUD Operations](active-record-with-cql/crud-operations.md) |
39 | | -- [Querying & Scopes](active-record-with-cql/queryable.md) |
40 | | -- [Complex Queries](active-record-with-cql/complex-queries.md) |
41 | | -- [Validations](active-record-with-cql/validations.md) |
42 | | -- [Relationships](active-record-with-cql/relations/README.md) |
43 | | - - [Belongs To](active-record-with-cql/relations/belongsto.md) |
44 | | - - [Has One](active-record-with-cql/relations/hasone.md) |
45 | | - - [Has Many](active-record-with-cql/relations/hasmany.md) |
46 | | - - [Many To Many](active-record-with-cql/relations/manytomany.md) |
47 | | -- [Callbacks](active-record-with-cql/callbacks.md) |
48 | | -- [Transactions](active-record-with-cql/transactions.md) |
49 | | -- [Persistence Details](active-record-with-cql/persistence-details.md) |
50 | | -- [Optimistic Locking](active-record-with-cql/optimistic-locking.md) |
51 | | -- [Query Scopes](active-record-with-cql/scopes.md) |
52 | | -- [Soft Deletes](active-record-with-cql/soft-deletes.md) |
53 | | -- [Touch](active-record-with-cql/touch.md) |
54 | | -- [Integrated Migration Workflow](active-record-with-cql/integrated-migration-workflow.md) |
55 | | - |
56 | | -## Database Management |
57 | | - |
58 | | -- [Configure Migration Integration](database-management/configure-migration-integration.md) |
59 | | -- [Migrations](database-management/migrations.md) |
60 | | -- [Migration Best Practices](database-management/handling-migrations.md) |
61 | | -- [Migration Guide](database-management/migration-guide.md) |
62 | | -- [Schema Dump](database-management/schema-dump.md) |
63 | | - |
64 | | -## Caching & Performance |
65 | | - |
66 | | -- [Caching Guide](caching-and-performance/caching-guide.md) |
67 | | -- [Centralized Cache Configuration](caching-and-performance/centralized-cache-configuration.md) |
68 | | -- [Per-Request Query Caching](caching-and-performance/per-request-query-caching.md) |
69 | | -- [Redis Cache Configuration](caching-and-performance/redis-cache-configuration.md) |
70 | | - |
71 | | -## Advanced Topics |
72 | | - |
73 | | -- [Performance Optimization](advanced-topics/performance-optimization.md) |
74 | | -- [Testing Strategies](advanced-topics/testing-strategies.md) |
75 | | -- [Security Guide](advanced-topics/security-guide.md) |
76 | | - |
77 | | -## Examples & Tutorials |
78 | | - |
79 | | -- [Examples Overview](examples-and-tutorials/examples.md) |
80 | | -- [Detailed Examples](examples-and-tutorials/examples-1/README.md) |
81 | | - - [Blog Engine Example](examples-and-tutorials/examples-1/blog-engine.md) |
82 | | - - [Configuration Example](examples-and-tutorials/examples-1/configuration-example.md) |
83 | | - - [Generated Schema Example](examples-and-tutorials/examples-1/generated-schema-example.md) |
84 | | - - [Logger Report Example](examples-and-tutorials/examples-1/logger-report-example.md) |
85 | | - - [Migration Configuration Example](examples-and-tutorials/examples-1/migration-configuration-example.md) |
86 | | - - [Migrator Config Example](examples-and-tutorials/examples-1/migrator-config-example.md) |
87 | | - - [Performance Monitoring Example](examples-and-tutorials/examples-1/performance-monitoring-example.md) |
88 | | - - [PostgreSQL Migration Workflow](examples-and-tutorials/examples-1/postgresql-migration-workflow.md) |
89 | | - - [Schema Migration Workflow](examples-and-tutorials/examples-1/schema-migration-workflow.md) |
90 | | - |
91 | | -## Help & Resources |
92 | | - |
93 | | -- [Community](help-and-resources/community.md) |
94 | | -- [Troubleshooting](help-and-resources/troubleshooting.md) |
95 | | -- [Frequently Asked Questions](help-and-resources/faqs.md) |
| 5 | + |
| 6 | +## Tutorials |
| 7 | + |
| 8 | +- [Tutorials Overview](tutorials/README.md) |
| 9 | +- [Getting Started](tutorials/getting-started/your-first-cql-app.md) |
| 10 | + - [Your First CQL App](tutorials/getting-started/your-first-cql-app.md) |
| 11 | + - [Adding CQL to Existing Project](tutorials/getting-started/adding-cql-to-existing-project.md) |
| 12 | +- [Building a Blog](tutorials/building-a-blog/01-project-setup.md) |
| 13 | + - [Part 1: Project Setup](tutorials/building-a-blog/01-project-setup.md) |
| 14 | + - [Part 2: Database Schema](tutorials/building-a-blog/02-database-schema.md) |
| 15 | + - [Part 3: Models and Relationships](tutorials/building-a-blog/03-models-and-relationships.md) |
| 16 | + - [Part 4: CRUD Operations](tutorials/building-a-blog/04-crud-operations.md) |
| 17 | + - [Part 5: Adding Features](tutorials/building-a-blog/05-adding-features.md) |
| 18 | +- [Real-World Examples](tutorials/real-world-examples/migration-workflows.md) |
| 19 | + - [Migration Workflows](tutorials/real-world-examples/migration-workflows.md) |
| 20 | + - [Performance Monitoring](tutorials/real-world-examples/performance-monitoring.md) |
| 21 | + |
| 22 | +## How-to Guides |
| 23 | + |
| 24 | +- [How-to Overview](how-to/README.md) |
| 25 | + |
| 26 | +### Models |
| 27 | + |
| 28 | +- [Define a Model](how-to/models/define-model.md) |
| 29 | +- [Add Validations](how-to/models/add-validations.md) |
| 30 | +- [Use Callbacks](how-to/models/use-callbacks.md) |
| 31 | +- [Implement Soft Deletes](how-to/models/soft-delete.md) |
| 32 | +- [Add Optimistic Locking](how-to/models/optimistic-locking.md) |
| 33 | +- [Use Timestamps](how-to/models/timestamps.md) |
| 34 | + |
| 35 | +### Relationships |
| 36 | + |
| 37 | +- [Set Up Belongs To](how-to/relationships/belongs-to.md) |
| 38 | +- [Set Up Has One](how-to/relationships/has-one.md) |
| 39 | +- [Set Up Has Many](how-to/relationships/has-many.md) |
| 40 | +- [Set Up Many-to-Many](how-to/relationships/many-to-many.md) |
| 41 | + |
| 42 | +### Querying |
| 43 | + |
| 44 | +- [Find Records](how-to/querying/find-records.md) |
| 45 | +- [Filter with Where Clauses](how-to/querying/filter-records.md) |
| 46 | +- [Build Complex Queries](how-to/querying/complex-queries.md) |
| 47 | +- [Create Query Scopes](how-to/querying/scopes.md) |
| 48 | +- [Paginate Results](how-to/querying/pagination.md) |
| 49 | +- [Use Cursor Pagination](how-to/querying/cursor-pagination.md) |
| 50 | + |
| 51 | +### Data Operations |
| 52 | + |
| 53 | +- [Create Records](how-to/data-operations/create.md) |
| 54 | +- [Update Records](how-to/data-operations/update.md) |
| 55 | +- [Delete Records](how-to/data-operations/delete.md) |
| 56 | +- [Use Transactions](how-to/data-operations/transactions.md) |
| 57 | + |
| 58 | +### Migrations |
| 59 | + |
| 60 | +- [Create a Migration](how-to/migrations/create-migration.md) |
| 61 | +- [Run Migrations](how-to/migrations/run-migrations.md) |
| 62 | +- [Rollback Migrations](how-to/migrations/rollback.md) |
| 63 | +- [Add Columns](how-to/migrations/add-columns.md) |
| 64 | +- [Create Indexes](how-to/migrations/indexes.md) |
| 65 | + |
| 66 | +### Configuration |
| 67 | + |
| 68 | +- [Configure Database Connection](how-to/configuration/database-connection.md) |
| 69 | +- [Set Up Connection Pooling](how-to/configuration/connection-pooling.md) |
| 70 | +- [Configure Multiple Environments](how-to/configuration/environments.md) |
| 71 | +- [Enable SSL Connections](how-to/configuration/ssl.md) |
| 72 | + |
| 73 | +### Caching |
| 74 | + |
| 75 | +- [Enable Query Caching](how-to/caching/query-cache.md) |
| 76 | +- [Configure Redis Cache](how-to/caching/redis.md) |
| 77 | +- [Use Per-Request Caching](how-to/caching/per-request.md) |
| 78 | + |
| 79 | +### Performance |
| 80 | + |
| 81 | +- [Optimize Queries](how-to/performance/optimize-queries.md) |
| 82 | +- [Avoid N+1 Queries](how-to/performance/n-plus-one.md) |
| 83 | +- [Monitor Performance](how-to/performance/monitoring.md) |
| 84 | + |
| 85 | +### Testing |
| 86 | + |
| 87 | +- [Test Models](how-to/testing/test-models.md) |
| 88 | +- [Set Up Test Databases](how-to/testing/test-database.md) |
| 89 | + |
| 90 | +### Troubleshooting |
| 91 | + |
| 92 | +- [Fix Connection Errors](how-to/troubleshooting/connection-errors.md) |
| 93 | +- [Fix Migration Errors](how-to/troubleshooting/migration-errors.md) |
| 94 | +- [Fix Validation Errors](how-to/troubleshooting/validation-errors.md) |
| 95 | + |
| 96 | +## Reference |
| 97 | + |
| 98 | +- [Reference Overview](reference/README.md) |
| 99 | +- [Quick Reference](reference/quick-reference.md) |
| 100 | + |
| 101 | +### API Reference |
| 102 | + |
| 103 | +- [Migration DSL](reference/api/migration-dsl.md) |
| 104 | +- [Validation Options](reference/api/validation-options.md) |
| 105 | +- [Callback Hooks](reference/api/callback-hooks.md) |
| 106 | + |
| 107 | +### Resources |
| 108 | + |
| 109 | +- [Glossary](reference/glossary.md) |
| 110 | +- [Error Codes](reference/error-codes.md) |
| 111 | + |
| 112 | +## Explanation |
| 113 | + |
| 114 | +- [Explanation Overview](explanation/README.md) |
| 115 | +- [Concepts](explanation/concepts/what-is-orm.md) |
| 116 | + - [What is an ORM?](explanation/concepts/what-is-orm.md) |
| 117 | +- [Design Patterns](explanation/design-patterns/active-record.md) |
| 118 | + - [Active Record Pattern](explanation/design-patterns/active-record.md) |
| 119 | + - [Repository Pattern](explanation/design-patterns/repository.md) |
| 120 | + |
| 121 | +## Resources |
| 122 | + |
| 123 | +- [Resources Overview](resources/README.md) |
| 124 | +- [FAQ](resources/faq.md) |
| 125 | +- [Community](resources/community.md) |
| 126 | +- [Contributing](resources/contributing.md) |
0 commit comments