Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
| [License]
| [CrateDB]
| [Community Forum]
| [Bluesky]

## About

Expand All @@ -26,33 +25,37 @@ The [dlt-cratedb] package is temporary for shipping the code until

## Documentation

Please refer to the [handbook].
Please refer to the [overview] and the [usage guide].

## What's inside

- The `cratedb` adapter is heavily based on the `postgres` adapter.
- The `CrateDbSqlClient` deviates from the original `Psycopg2SqlClient` by
accounting for [CRATEDB-15161] per `SystemColumnWorkaround`.
- A few more other patches.
accounting for [CRATEDB-15161] per `SystemColumnWorkaround`. This will be
resolved with [DLT-CRATEDB-30] when CrateDB 6.2 will be released around
January/February 2026.
- A few more other patches to account for specifics of CrateDB.

## Backlog

We are tracking corresponding [issues] and a few more [backlog] items
to be resolved as we go.
The project tracks corresponding [issues] and a few more [backlog] items
to be resolved in its incubation phase.


[backlog]: https://github.com/crate/dlt-cratedb/blob/main/docs/backlog.md
[CRATEDB-15161]: https://github.com/crate/crate/issues/15161
[dlt]: https://github.com/dlt-hub/dlt
[DLT-2733]: https://github.com/dlt-hub/dlt/pull/2733
[dlt-cratedb]: https://pypi.org/project/dlt-cratedb
[DLT-CRATEDB-30]: https://github.com/crate/dlt-cratedb/pull/30
[issues]: https://github.com/crate/dlt-cratedb/issues
[handbook]: https://github.com/crate/dlt-cratedb/blob/main/docs/cratedb.md
[overview]: https://cratedb.com/docs/guide/integrate/dlt/
[usage guide]: https://cratedb.com/docs/guide/integrate/dlt/usage.html

[CrateDB]: https://cratedb.com/database
[Bluesky]: https://bsky.app/search?q=cratedb
[Community Forum]: https://community.cratedb.com/
[Documentation]: https://github.com/crate/dlt-cratedb
[Documentation]: https://cratedb.com/docs/guide/integrate/dlt/
[Issues]: https://github.com/crate/dlt-cratedb/issues
[License]: https://github.com/crate/dlt-cratedb/blob/main/LICENSE.txt
[managed on GitHub]: https://github.com/crate/dlt-cratedb
Expand All @@ -71,6 +74,6 @@ to be resolved as we go.
[project-ci]: https://github.com/crate/dlt-cratedb/actions/workflows/tests.yml
[project-coverage]: https://app.codecov.io/gh/crate/dlt-cratedb
[project-downloads]: https://pepy.tech/project/dlt-cratedb/
[project-license]: https://github.com/crate/dlt-cratedb/blob/main/LICENSE
[project-license]: https://github.com/crate/dlt-cratedb/blob/main/LICENSE.txt
[project-pypi]: https://pypi.org/project/dlt-cratedb
[project-release-notes]: https://github.com/crate/dlt-cratedb/releases
127 changes: 0 additions & 127 deletions docs/cratedb.md

This file was deleted.