Repository navigation
docs: describe the PostgreSQL contract and supported types - #19
Merged
Merged
Conversation
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
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.
Summary
sqlcj targets PostgreSQL and JDBC, but nothing in the repository stated that
contract or which SQL types and
CREATE TABLEconstructs a schema snapshot mayactually use. This adds a single user-facing document that states the database
contract of configuration version
"1"and publishes the supported type and DDLsurface, describing only behavior the existing tests demonstrate.
Changes
"1"as PostgreSQL schema and query input withblocking JDBC execution, with no engine option and no dialect option.
with a
javax.sql.DataSource, no JDBC driver is shipped, and behavior isverified against PostgreSQL 16 while H2 remains a test-only convenience.
mappings, including case-insensitive matching with type arguments ignored.
CREATE TABLEconstructs, andrecord that constraints never change generated Java.
binding and reading, and
NOT NULLas the only source of column nullability.failure behavior, and the tests that back each published table.
Scope and non-goals
documentation-verification machinery such as Markdown-parsing tests.
contracts are only described where the schema and type contract requires it.