docs: catch up with the connect/driver rename - #97
Merged
Conversation
ARCHITECTURE.md still described the pre-rename runtime: Database holding
a Driver, and a single Database that was either pool-backed or
transaction-bound. Split into Driver / Database / Connection, and
document connect(), defaultConnection, dialect-from-driver, and the
explicit-isolation rules that transaction({ isolation }) added.
Also there: sql.ident was listed as a supported helper, but sql.ts
states there is deliberately no such helper (schema-referencing Idents
must carry a Database for the provenance check). And the codegen
section only covered Postgres, so note both trees and where the SQLite
facts come from.
README: the Backends snippet connected a pg driver and then a sqlite
one to the same Database, which now throws on the dialect check — make
it a pick-one list and say that several connections must agree.
Comments: _PlayActiveArea referred to runtime.ts's top-level
`await typegres({ type: "pglite" })`, now `await PgliteDriver.create()`;
examples/sqlite cited a `sqlite()` default that doesn't exist. The
share-utils fixtures are compression inputs, never executed, but they
read as sample code, so move them to the current init form.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ARCHITECTURE.md still described the pre-rename runtime: Database holding a Driver, and a single Database that was either pool-backed or transaction-bound. Split into Driver / Database / Connection, and document connect(), defaultConnection, dialect-from-driver, and the explicit-isolation rules that transaction({ isolation }) added.
Also there: sql.ident was listed as a supported helper, but sql.ts states there is deliberately no such helper (schema-referencing Idents must carry a Database for the provenance check). And the codegen section only covered Postgres, so note both trees and where the SQLite facts come from.
README: the Backends snippet connected a pg driver and then a sqlite one to the same Database, which now throws on the dialect check — make it a pick-one list and say that several connections must agree.
Comments: _PlayActiveArea referred to runtime.ts's top-level
await typegres({ type: "pglite" }), nowawait PgliteDriver.create(); examples/sqlite cited asqlite()default that doesn't exist. The share-utils fixtures are compression inputs, never executed, but they read as sample code, so move them to the current init form.