Files
TinyORM/docs/README.mdx
2022-11-17 13:26:23 +01:00

42 lines
2.0 KiB
Plaintext

---
sidebar_position: 0
sidebar_label: 🔥 Prologue
slug: /
hide_table_of_contents: true
description: TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the QtCore and QtSql libraries. The code is written in the modern c++20 way and is well tested with the unit and functional tests.
keywords: [c++ orm, prologue, tinyorm]
---
# Prologue
TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the `QtCore` and `QtSql` libraries.
The code is written in the modern c++20 way and is well tested with the unit and functional tests. Almost all the query builder methods are unit tested. The TinyORM's query builder code and the code which is responsible for obtaining relationships, is tested by functional tests against all supported databases. The code coverage is good enough to guarantee API and behavior compatibility.
:::tip
For a quick look at what's inside, check out the [Features Summary](features-summary.mdx).
:::
:::info
If you don't want to use full [`ORM`](tinyorm/getting-started.mdx), then you can use only the [`Query Builder`](database/query-builder.mdx), which is outstanding. 🔥 This way you can avoid writing raw SQL queries and your code will run on all [supported databases](database/getting-started.mdx#introduction).
:::
##### Documentation Sitemap
- [Dependencies](dependencies.mdx)
- [Supported Compilers](supported-compilers.mdx)
- [Database](database/getting-started.mdx)
- [Getting Started](database/getting-started.mdx)
- [Query Builder](database/query-builder.mdx)
- [Migrations](database/migrations.mdx)
- [Seeding](database/seeding.mdx)
- [TinyORM](tinyorm/getting-started.mdx)
- [Getting Started](tinyorm/getting-started.mdx)
- [Relationships](tinyorm/relationships.mdx)
- [Casts](tinyorm/casts.mdx)
- [Building](building/tinyorm.mdx)
- [TinyORM](building/tinyorm.mdx)
- [Hello world](building/hello-world.mdx)
- [Migrations](building/migrations.mdx)
- [Features Summary](features-summary.mdx)